Criando uma transação

post

https://api.amblerpay.com.br/transaction

Para fazer uma cobrança você deve usar a rota /transaction para criar a sua transação, que pode ser feita por Cartão de Crédito, Boleto e Pix.

No caso de Cartão de crédito é possível utilizar um card_token ou todos os dados do cartão diretamente. Por fatores de segurança, a segunda forma é recomendada. Saiba mais sobre cartões salvos aqui.

Body Params

amount

int32

required

Valor total da transação. Você deve passar em centavos, exemplo: R$ 10,00 = 1000

notification_url

string

required

O endpoint da sua aplicação que receberá as notificações de eventos para essa transação. Exemplo, https://seusite.com.br/pagamentos/notificacoes

payment_method

string

required

O método de pagamento da transação. Os valores aceitos são: credit_card, pix, e boleto

installments

int32

required

Defaults to 1

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

async

boolean

Defaults to false

Utilize false caso queira manter o processamento síncrono de uma transação. Ou seja, a resposta da transação é recebida na hora. Caso você opte por true gerencie a resposta da transação no endpoint que você informou em notification_url.

capture

boolean

Defaults to true

Após a autorização de uma transação, você pode escolher se irá capturar agora(padrão) ou fazer posteriormente. Caso opte por fazer a captura depois, atribua o valor false.

card_token

string

required

Informações do cartão salvo do cliente em sua aplicação. OBS: apenas para transações de Cartão de crédito você deve passar o token. Caso informe os dados do cartão diretamente pelo código, esse campo torna-se opcional.

card_holder_name

string

required

Nome do portador do cartão

card_expiration_date

int32

required

Data de validade do cartão no formato MMAA.

card_number

string

required

Número do cartão formatado. Ou seja, sem espaços, traços ou caracteres não numéricos.

card_cvv

int32

required

Código verificador do cartão. Esse parâmetro também pode ser passado em conjunto com o token, para validarmos o CVV do cartão na criação da transação.

boleto_pix

boolean

Defaults to true

Se o método de pagamento for boleto a Ambler Pay por padrão irá gerar o boleto juntamente com um pix. Você pode desabilitar essa opção informando false nesse parâmetro.

boleto_expiration_date

date

Data de vencimento

boleto_instructions

array of strings

Instruções utilizadas na parte central do boleto. É possível até 5 instruções

boleto_instructions

split_rules

array of objects

Regras de divisão da transação

split_rules

customer_id

string

ID de identificação de cliente já existente

customer

object

required

Dados do cliente vinculado a esta transação. Esse campo se torna dispensável caso você informe o customer_id. Evite criar múltiplos registros para o mesmo cliente no sistema, por isso recomendamos você informar os dados do cliente diretamente apenas uma vez, até obter o customer_id. Saiba mais sobre o registro de clientes.

billing

object

Define os dados de cobrança, como nome e endereço. Não é obrigatório caso o customer já tenha um endereço cadastrado.

items

array of objects

required

items*

metadata

json

boleto_discount

array of objects

Objeto para aplicar descontos no boleto para uma ou mais datas limite.

boleto_discount

boleto_ late_fee

object

Objeto para utilização de cobrança da multa por atraso de pagamento do boleto

boleto_ interest

object

Objeto para utilização de cobrança de juros

Response

200200