Um pagamento representa uma tentativa do ponto de vista do seu cliente final. Esta ação se inicia quando o cliente clica no botão "Comprar" do seu checkout, por exemplo, e se encerra quando ele recebe um feedback informando se o pagamento foi aprovado ou não. O ciclo de vida do pagamento normalmente dura poucos segundos.

O pagamento pode conter uma ou mais transações: cada transação representa uma tentativa de comunicação com um gateway externo ou instituição financeira (adquirente, subadquirente ou banco).

Dependendo das configurações no seu gateway, a tentativa de pagamento pode desencadear automaticamente, em poucos segundos, várias tentativas de transação em múltiplas adquirentes. Nesse caso, todas as tentativas de transação devem ser enviadas dentro do mesmo pagamento.

Se o pagamento for rejeitado e o cliente clicar novamente em "Comprar" no seu checkout, esta ação deverá gerar uma nova tentativa de pagamento nesta API, com suas respectivas transações.

Painel de administração

O painel de administração permite consultar pagamentos e transações separadamente. Embora parte dos campos esteja replicado nas duas entidades, recomendamos consultar pagamentos quando quiser obter dados sobre funcionamento da sua infraestrutura financeira do ponto de vista do cliente. Quando quiser ter uma visão operacional detalhada da sua integração com instituições financeiras (bancos, bandeiras, e adquirentes), consulte as transações.

API

Pagamentos são criados através do método POST /payments.

Transações devem ser enviadas no parâmetro transactions do método POST /payments ou na atualização do pagamento via PATCH /payments/{id}, dependendo do seu caso de uso.

Consulte a documentação da API para obter a lista e a descrição dos status permitidos para pagamentos e transações.

🚧
Não envie transações realizadas em tentativas de pagamento diferentes, mesmo que façam parte da mesma compra e tenham sido realizadas minutos ou dias atrás.