Manual do Dev
InstitucionalBlogService DeskStatus Page

Pagamento de contas

stable

Suggest Edits

Dados do evento

PAYBILL

Este evento traz informações a respeito do pagamento de uma conta.

Campos retornados

NomeTipoDescrição
aggregateIdstringValor 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".
typestringTipo de evento, que pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
categorystringNeste contexto, esse campo informará o valor “AccountPayment”.
decriptionstringCampo que pode retornar trazendo a descrição do pagamento.
documentNumberstringNúmero do documento do proprietário da conta da qual partiu o pagamento.
bankBranchstringAgência bancária do pagador.
bankAccountstringNúmero da conta do pagador.
amountnumberValor da transação.
indexstringÍndice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
namestringNome do evento.
timestampstringData e a hora em que o evento ocorreu, no formato ISO 8601 - UTC.
dataobjectObjeto que contém informações sobre o pagamento da conta.
data.CorrelationIdstringIdentificador interno do pagamento.
data.DigitablestringLinha digitável para pagamento.
data.AmountnumberValor da transação.
data.OriginalAmountnumberValor original, sem desconto ou juros e/ou multas.
data.AssignorstringNome do cedente.
data.RecipientDocumentstringNúmero do documento do recebedor do pagamento.
data.RecipientNamestringNome do recebedor do pagamento.
data.ChargesobjectEncargos aplicados à transação.
data.Charges.InterestAmountCalculatednumberJuros aplicados à transação.
data.Charges.FineAmountCalculatednumberMulta aplicada à transação.
data.Charges.DiscountAmountnumberDesconto aplicado à transação.
data.SettleDatestringData 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.PaymentDatestringData em que foi realizado o pagamento, no formato ISO 8601 - UTC.
data.TypestringTipo de título a ser pago.
data.DueDatestringData de vencimento do título, no formato ISO 8601 - UTC.
data.TransactionIdnumberCódigo identificador da transação.
data.ConfirmationTransactionIdnumberCódigo de confirmação da transação.
data.DescriptionstringDescrição da conta a ser paga.
RequestedAtstringData em que foi feita a requisição no endpoint de pagamento de contas, no formato ISO 8601 - UTC.
ReasonRefusedstringRazão pela qual o pagamento foi recusado após a sua confirmação.
data.AuthenticationCodestringCódigo identificador da transação.
data.PaymentStatusstringSituação do pagamento, a qual neste caso será "Created".
data.PaymentTypestringTipo de pagamento, o qual neste caso sempre será "Bill".
data.CompanyKeystringChave que identifica o parceiro dentro do Bankly.
data.DocumentNumberstringNúmero do documento do proprietário da conta da qual partiu o pagamento.
data.BankAccountstringNúmero da conta do pagador.
data.BankBranchstringAgência bancária do pagador.
data.BankIspbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
data.BankCodestringCódigo do banco.
data.BankNamestringNome do banco.
data.ConfirmedAtstringData em que o pagamento foi confirmado, no formato ISO 8601 - UTC.
data.IdstringMesmo valor retornado no campo aggregateId.
data.CreatedAtstringData em que o pagamento foi realizado, no formato ISO 8601 - UTC.
data.UpdatedAtstringData da última atualização do status do pagamento, no formato ISO 8601 - UTC.
data.VersionnumberVersionamento interno do Bankly.
data.HasUncommittedEventsbooleanIndica confirmação de recebimento de evento interno. Sempre virá preenchido como true.
statusstringO 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 7 days ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados