Criando uma transação

post

https://api.pagar.me/1/transactions

Para fazer uma cobrança você deve usar a rota /transactions para criar a sua transação, que pode ser feita por Cartão de crédito ou por Boleto bancário.

No caso de Cartão de crédito é possível utilizar um card_id, card_hash ou todos os dados do cartão diretamente. A segunda opção é a mais indicada, por fatores de segurança

Body Params

amount

int32

required

Defaults to 1000

Valor a ser cobrado. Deve ser passado em centavos. Ex: R$ 10.00 = 1000. Deve ser no mínimo 1 real (100)

card_hash

string

required

Informações do cartão do cliente criptografadas em sua aplicação. OBS: apenas para transações de Cartão de crédito você deve passar o card_hash ou card_id. Caso inclua os dados do cartão diretamente pelo código, esse campo torna-se dispensável.

card_id

string

required

Ao realizar uma transação, retornamos o card_id do cartão, para que nas próximas transações ele possa ser utilizado como forma de identificar os dados de pagamento. Exemplo de utilização: One-click buy. OBS: apenas para transações de Cartão de crédito você deve passar o card_hash ou card_id. Caso inclua os dados do cartão diretamente pelo código, esse campo torna-se dispensável.

card_holder_name

string

required

Defaults to !NAME!

Nome do portador do cartão. OBS: apenas para transações de Cartão de crédito você deve passar o card_holder_name

card_expiration_date

string

required

Defaults to !CARD_EXPIRATION_DATE!

Data de validade do cartão no formato MMAA. OBS: apenas para transações de Cartão de crédito você deve passar o card_expiration_date

card_number

string

required

Defaults to !CARD_NUMBER!

Número do cartão. OBS: apenas para transações de Cartão de crédito você deve passar o card_number

card_cvv

string

required

Defaults to !CARD_CVV!

Código verificador do cartão. OBS: O card_cvv deve ser passado somente para transações de Cartão de crédito. Esse parâmetro também pode ser passado em conjunto com o card_id, para validarmos seu CVV na criação da transação.

payment_method

string

required

Defaults to credit_card

Método de pagamento da transação. Aceita dois tipos: credit_card e boleto.

postback_url

string

Endpoint do seu sistema que receberá informações a cada atualização da transação. Caso você defina este parâmetro, o processamento da transação se torna assíncrono. Máximo de 255 caracteres.

async

boolean

Utilize false caso queira manter o processamento síncrono de uma transação. Ou seja, a resposta da transação é recebida na hora.

installments

string

Defaults to 1

Número de parcelas da transação, sendo mínimo: 1 e Máximo: 12. OBS: Se o pagamento for boleto, o padrão é 1

capture

string

Defaults to true

Após a autorização de uma transação, você pode escolher se irá capturar ou adiar a captura do valor. Caso opte por postergar a captura, atribua o valor false.

boleto_expiration_date

string

Prazo limite para pagamento do boleto. Deve ser passado no formato yyyy-MM-dd.Default: data atual + 7 dias

soft_descriptor

string

Descrição que aparecerá na fatura depois do nome de sua empresa. Máximo de 13 caracteres, sendo alfanuméricos e espaços.

boleto_instructions

string

Campo instruções do boleto. Máximo de 255 caracteres

customer

object

Obrigatório com o antifraude habilitado. Define os dados do comprador, como nome, email e telefone

metadata

json

Você pode passar dados adicionais na criação da transação para facilitar uma futura análise de dados tanto em nossa dashboard, quanto por seus sistemas. Ex: metadata[ idProduto ]=13933139. Deve ser preenchido com no máximo de 1000 caracteres.

split_rules

array of objects

Regras de divisão da transação

split_rules

boleto_fine

object

boleto_interest

object

boleto_rules

array of strings

Combinação de valores que define as regras do boleto emitido. Valores possíveis: 'strict_expiration_date' (restringe o pagamento para até a data de vencimento e apenas o valor exato do documento), 'no_strict' (permite pagamento após o vencimento e valores diferentes do impresso).

boleto_rules

reference_key

string

Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente.

session

string

Valor único que identifica a sessão do usuário acessando o site. Máximo de 100 caracteres

local_time

string

Defaults to Date

Data e hora do dispositivo que está efetuando a transação. Deve ser enviado no seguinte formato: yyyy-MM-dd'T'HH:mm:ss'Z. Por exemplo: 2017-10-31T14:53:00.000Z. OBS.: este campo é necessário para transações de mundo físico (com método de captura EMV e Magstripe)

Headers

X-PagarMe-User-Agent

string

Este campo serve para definir o responsável por criar a transação. Ex: Pagar.me Checkout/2.0.0

X-PagarMe-Version

string

Através desse header você pode informa a versão da sua api. Ex: 2017-08-28

Response

200200