Pagamento de contas
stable
Dados do evento
PAYBILL
Este evento traz informações a respeito do pagamento de uma conta.
Campos retornados
Nome | Tipo | Descrição |
---|---|---|
aggregateId | string | Valor correspondente ao authenticationCode , retornado na requisição de confirmação do pagamento. O formato do valor será: PAYBILL_authenticationCode. Exemplo: "PAYBILL_6fa1aec9-cd2f-47de-a806-9a1fc0749dc2". |
type | string | Tipo de evento, que pode ser INFO, TRANSACTION, ACTION OU BACKOFFICE. |
category | string | Neste contexto, esse campo informará o valor “AccountPayment”. |
decription | string | Campo que pode retornar trazendo a descrição do pagamento. |
documentNumber | string | Número do documento do proprietário da conta da qual partiu o pagamento. |
bankBranch | string | Agência bancária do pagador. |
bankAccount | string | Número da conta do pagador. |
amount | number | Valor da transação. |
index | string | Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7. |
name | string | Nome do evento. |
timestamp | string | Data e a hora em que o evento ocorreu, no formato ISO 8601 - UTC. |
data | object | Objeto que contém informações sobre o pagameno da conta. |
data.CorrelationId | string | Identificador interno do pagamento. |
data.Digitable | string | Linha digitável para pagamento. |
data.Amount | number | Valor da transação. |
data.OriginalAmount | number | Valor original, sem desconto ou juros e/ou multas. |
data.Assignor | string | Nome do cedente. |
data.RecipientDocument | string | Número do documento do recebedor do pagamento. |
data.RecipientName | string | Nome do recebedor do pagamento. |
data.Charges | object | Encargos aplicados à transação. |
data.Charges.InterestAmountCalculated | number | Juros aplicados à transação. |
data.Charges.FineAmountCalculated | number | Multa aplicada à transação. |
data.Charges.DiscountAmount | number | Desconto aplicado à transação. |
data.SettleDate | string | Data de liquidação do pagamento, no formato ISO 8601 - UTC. Caso a data de vencimento coincida com feriados ou finais de semana, esse campo informará a data do próximo dia útil. |
data.PaymentDate | string | Data em que foi realizado o pagamento, no formato ISO 8601 - UTC. |
data.Type | string | Tipo de título a ser pago. |
data.DueDate | string | Data de vencimento do título, no formato ISO 8601 - UTC. |
data.TransactionId | number | Código identificador da transação. |
data.ConfirmationTransactionId | number | Código de confirmação da transação. |
data.Description | string | Descrição da conta a ser paga. |
RequestedAt | string | Data em que foi feita a requisição no endpoint de pagamento de contas, no formato ISO 8601 - UTC. |
ReasonRefused | string | Razão pela qual o pagamento foi recusado após a sua confirmação. |
data.AuthenticationCode | string | Código identificador da transação. |
data.PaymentStatus | string | Situação do pagamento, a qual neste caso será "Created". |
data.PaymentType | string | Tipo de pagamento, o qual neste caso sempre será "Bill". |
data.CompanyKey | string | Chave que identifica o parceiro dentro do Bankly. |
data.DocumentNumber | string | Número do documento do proprietário da conta da qual partiu o pagamento. |
data.BankAccount | string | Número da conta do pagador. |
data.BankBranch | string | Agência bancária do pagador. |
data.BankIspb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
data.BankCode | string | Código do banco. |
data.BankName | string | Nome do banco. |
data.ConfirmedAt | string | Data em que o pagamento foi confirmado, no formato ISO 8601 - UTC. |
data.Id | string | Mesmo valor retornado no campo aggregateId . |
data.CreatedAt | string | Data em que o pagamento foi realizado, no formato ISO 8601 - UTC. |
data.UpdatedAt | string | Data da última atualização do status do pagamento, no formato ISO 8601 - UTC. |
data.Version | number | Versionamento interno do Bankly. |
data.HasUncommittedEvents | boolean | Indica confirmação de recebimento de evento interno. Sempre virá preenchido como "true". |
status | string | O status ACTIVE indicará que o cash-out está em processamento ou foi realizado com sucesso. Caso contrário, o status estará como CANCELED. |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"aggregateId": "PAYBILL_75ea8559-5898-4b42-99bb-0c329da8333a",
"type": "TRANSACTION",
"category": "AccountPayment",
"description": "EXEMPLO_DESCRIÇÃO",
"documentNumber": "47742663023",
"bankBranch": "0001",
"bankAccount": "15164",
"amount": -164.97,
"index": "feed-paybill-2021-2",
"name": "PAYBILL",
"timestamp": "2021-02-19T19:02:00.2336183Z",
"data": {
"CorrelationId": "d7b9b663-7615-4e1b-8d90-ea7ee5980cc8",
"Digitable": "846500000019649702920012104106870355022102102252",
"Amount": 164.97,
"OriginalAmount": 164.97,
"Assignor": "Nísia Floresta",
"RecipientDocument": "91702892000128",
"RecipientName": "EXEMPLO_FAVORECIDO",
"Charges": {
"InterestAmountCalculated": 0.0,
"FineAmountCalculated": 0.0,
"DiscountAmount": 0.0
},
"SettleDate": "2021-02-19T00:00:00Z",
"PaymentDate": "2021-02-19T19:02:00.2336257Z",
"Type": "Concessionaire",
"DueDate": "2021-02-19T00:00:00Z",
"TransactionId": 6128001,
"ConfirmationTransactionId": 6128005,
"Description": "Conta de luz",
"RequestedAt": "2023-08-24T19:15:42.1380486Z",
"ReasonRefused": null,
"AuthenticationCode": "75ea8559-5898-4b42-99bb-0c329da8333a",
"PaymentStatus": "Created",
"PaymentType": "Bill",
"CompanyKey": "BANKLY",
"DocumentNumber": "00000000000",
"BankAccount": "000000",
"BankBranch": "0001",
"BankIspb": "13140088",
"BankCode": "332",
"BankName": "Acesso Soluções de Pagamento S.A.",
"ConfirmedAt": null,
"Id": "75ea8559-5898-4b42-99bb-0c329da8333a",
"CreatedAt": "2021-02-19T19:02:00.2336183Z",
"UpdatedAt": "2021-02-19T19:02:02.3166505Z",
"Version": 2,
"HasUncommittedEvents": true
},
"status": "ACTIVE"
}
Updated 6 months ago