Pagamento de contas (Payment)
Confira os eventos relativos a pagamento de contas.
beta
Os eventos de pagamentos de contas disparam mensagens que comunicam ao destinatário a criação, o recebimento, a confirmação e o cancelamento do pagamento, assim como se houve falha na transação.
Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.
Contexto e nome do evento
Nos eventos de pagamentos de contas, o campo context sempre informará “Payment”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:
| Nome do evento (name) | Descrição |
|---|---|
| BILL_PAYMENT_WAS_RECEIVED | O pagamento foi recebido. |
| BILL_PAYMENT_WAS_CREATED | O pagamento foi criado. |
| BILL_PAYMENT_WAS_CONFIRMED | O pagamento foi confirmado. |
| BILL_PAYMENT_HAS_FAILED | Houve falha no pagamento. |
| BILL_PAYMENT_WAS_CANCELLED | O pagamento foi cancelado. |
EntityId
O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.
No contexto de pagamento de contas, o entityId é o AuthenticationCode (código identificador da transação).
Exemplos de eventos
{
"entityId": "affedb25-9002-4a35-a02b-c298adc3895f",
"companyKey": "COMPANY_KEY",
"name": "BILL_PAYMENT_WAS_RECEIVED",
"timestamp": "2022-04-25T12:27:25.7038327+00:00",
"correlationId": "ae7eaab1-a367-4687-989b-5578b90f0a72",
"metadata": null,
"data": {
"authenticationCode": "affedb25-9002-4a35-a02b-c298adc3895f",
"paymentStatus": "Received",
"paymentType": "Bill",
"account": {
"branch": "0001",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
},
"number": "123456"
},
"createdAt": "2022-04-25T12:27:23.8078938Z",
"digitable": "856300000036128800692021204300202205422400081630",
"amount": {
"value": 312.88,
"currency": "BRL"
},
"originalAmount": {
"value": 312.88,
"currency": "BRL"
},
"assignor": "BOLETO TESTE",
"recipient": {
"document": {
"type": "Undefined"
}
},
"charges": {
"interestAmountCalculated": {
"value": 0.0,
"currency": "BRL"
},
"fineAmountCalculated": {
"value": 0.0,
"currency": "BRL"
},
"discountAmount": {
"value": 0.0,
"currency": "BRL"
}
},
"settleDate": "2022-04-25T00:00:00Z",
"paymentDate": "2022-04-25T12:27:23.8078995Z",
"type": "Concessionaire",
"dueDate": "2022-04-25T00:00:00Z",
"transactionId": 1000978470,
"description":"DESCRIPTION"
}
}
{
"entityId": "31951261-79b2-40e4-849c-a326ca0baf3c",
"companyKey": "COMPANY_KEY",
"name": "BILL_PAYMENT_WAS_CREATED",
"timestamp": "2022-04-25T12:28:03.4363558+00:00",
"correlationId": "661204fb-6d0e-4600-83fa-a85b42c2c49c",
"metadata": null,
"data": {
"document": {
"value": "12345678900000",
"type": "CNPJ"
},
"authenticationCode": "31951261-79b2-40e4-849c-a326ca0baf3c",
"confirmationTransactionId": 1000981186,
"paymentStatus": "Created",
"updatedAt": "2022-04-25T12:28:03.4360996Z"
}
}
{
"entityId": "ffac45d7-0644-4f9f-887f-97d2f179a51a",
"companyKey": "COMPANY_KEY",
"name": "BILL_PAYMENT_WAS_CONFIRMED",
"timestamp": "2022-04-25T12:26:05.3835097+00:00",
"correlationId": "d096bdae-4fdb-457a-9854-dbe6e3ae7a20",
"metadata": null,
"data": {
"authenticationCode": "ffac45d7-0644-4f9f-887f-97d2f179a51a",
"paymentStatus": "Confirmed",
"confirmedAt": "2022-04-25T12:26:05.3834893Z",
"updatedAt": "2022-04-25T12:26:05.3834893Z"
}
}
{
"entityId": "553d341e-786e-47b8-9854-b53175d2585d",
"companyKey": "COMPANY_KEY",
"name": "BILL_PAYMENT_HAS_FAILED",
"timestamp": "2022-04-19T21:13:25.5742107+00:00",
"correlationId": "59466911-0ca3-4651-a6c3-23e9029bb508",
"data": {
"authenticationCode": "553d341e-786e-47b8-9854-b53175d2585d",
"paymentStatus": "PaymentFailed",
"error": {
"code": "000",
"message": "ESPERANDO_CONFIRMACAO_CLIENTE"
},
"updatedAt": "2022-04-19T21:13:25.5191272Z"
},
"context": "Payment"
}
{
"entityId": "553d341e-786e-47b8-9854-b53175d2585d",
"companyKey": "COMPANY_KEY",
"name": "BILL_PAYMENT_WAS_CANCELLED",
"timestamp": "2022-04-19T21:13:25.5744646+00:00",
"correlationId": "59466911-0ca3-4651-a6c3-23e9029bb508",
"data": {
"authenticationCode": "553d341e-786e-47b8-9854-b53175d2585d",
"paymentStatus": "Canceled",
"reason": "ESPERANDO_CONFIRMACAO_CLIENTE",
"updatedAt": "2022-04-19T21:13:25.553292Z"
},
"context": "Payment"
}
Importante
Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.
Objeto data nos eventos de pagamento de contas
O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de pagamento de contas, esse objeto poderá conter os seguintes campos:
authenticationCode: código identificador do pagamento;paymentStatus: status do pagamento, o qual pode ser: “Created”, “Received”, “Confirmed”, “Canceled” ou “PaymentFailed”;updatedAt: data da última atualização do status do pagamento;document: objeto contendo o número e o tipo do documento (CPF ou CNPJ) do titular da conta;confirmationTransactionId: código de confirmação da transação;amount: objeto contendo o valor da transação e a moeda utilizada;recipient: tipo de documento do recebedor, o qual pode ser: “undefined”, “CPF” ou “CNPJ”;createdAt: data e hora no qual a requisição foi recebida;paymentType: tipo de pagamento;account: os dados da conta do pagador;branch: número da agência,bank: objeto contendo o ISPB, o código e o nome do banco ao qual a conta pertence;number: número da conta;
digitable: linha digitável para pagamento;originalAmount: valor original, sem desconto ou juros e/ou multas;assignor: nome do cedente;charges:interestAmountCalculated: valor dos juros;fineAmountCalculated: valor da multa;discountAmount: valor do desconto;
settleDate: retorna a data em que o pagamento será liquidado. Caso a data de vencimento coincida com feriados ou finais de semana, esse campo informará a data do próximo dia útil;paymentDate: data em que foi realizado o pagamento;type: tipo de título a ser pago;dueDate: data de vencimento do título;transactionId: código identificador da transação;error: objeto contendo o código e a mensagem de erro devido à falha no pagamento;reason: motivo pelo qual ocorreu o cancelamento;confirmedAt: data em que o pagamento foi confirmado;description: descrição da conta a ser paga.
Updated 11 months ago