Confira os eventos acionados por pedido de pagamento (pagamento de boletos) e os dados enviados.
Pedido de pagamento criado
Acionado sempre que um Pedido de Pagamento é criado.
| Parâmetro | Descrição | Exemplo |
|---|---|---|
| event | Nome do evento | payment_request.created |
| payment_request_id | ID da solicitação de pagamento | 5FC7C9E5715F4FA5A432ABCD1E2F4A3B |
| barcode | Código de barras da solicitação de pagamento | 40192024331600000000600001345420598970000000999 |
| status | Status da solicitação de pagamento | pending |
| amount_cents | Valor da solicitação em centavos | 400 |
| account_id | ID da Conta | AA4B5CC6376804D1FA792CBCA12345678 |
| reference | Referência interna | 123456 |
| external_reference | Informação de referência externa | meu-id-externo |
| document_amount_cents | Valor do documento em centavos | 400 |
| description | Descrição da solicitação de pagamento | "Uma descrição legal" |
| cpf_cnpj_holder | CPF/CNPJ do titular | 12345678901 |
| holder_name | Nome do titular | João da Silva |
Mudança de estado do pedido de pagamento
Acionado sempre que há alteração no status de Pedido de Pagamento.
| Parâmetro | Descrição | Exemplo |
|---|---|---|
| event | Nome do evento | payment_request.status_changed |
| data[payment_request_id] | ID do Pedido de Pagamento | A123B4C5D6E7F8G9H1I2J3K4L5M6N7O |
| data[barcode] | Número da Linha Digitável | 12345678912345678912345678912345678912345678912345 |
| data[status] | Status do Pedido de Pagamento | rejected, done |
| data[amount_cents] | Quantia paga | 156250 |
| data[account_id] | ID da Conta que executou o pedido | A123B4C5D6789E2F5G6H7I8J9K8L9M8N8O8 |
| data[reference] | Referência interna | 123456 |
| data[external_reference] | Informação de referência externa | meu-id-externo |
| data[document_amount_cents] | Valor do Boleto | 156250 |
| data[cpf_cnpj_holder] | CPF ou CNPJ do recebedor | 28029399000152 |
| data[holder_name] | Nome do Recebedor | Nome Sobrenome |
| data[rejected_at] | Data da rejeição do pagamento | 2024-10-07T19:46:12.397Z |
| data[error_message] | Erro Pagamento | Mensagem descritiva do erro ocorrido durante a tentativa de pagamento |
| data[done_at] | Data do Pagamento | 2024-10-07T19:46:12.397Z |