Pix e DICT
stable
Os eventos relacionados a Pix disparam mensagens que comunicam ao destinatário sobre:
- Transferências via Pix, ou seja, movimentações relacionadas a cash-in (recebimento de valores provenientes de pagamentos, transferências ou devoluções) e a cash-out (pagamentos e transferências via Pix, assim como o seu cancelamento);
- Atualizações dos pedidos de reivindicação de posse ou portabilidade de chaves Pix recebidos pelos clientes do parceiro Bankly (reconhecimento, confirmação, conclusão e cancelamento);
- Atualizações dos pedidos de reivindicação de posse ou portabilidade de chaves Pix feitos pelos clientes do parceiro Bankly para outras instituições;
- Emissão de QR Codes, estáticos ou dinâmicos, para pagamento via Pix.
Pré-requisitos
- Configurar previamente o recebedor de eventos do webhook.
- Conhecer a estrutura básica dos eventos que acompanha o objeto
data
.
Informações sobre os eventos
Contexto e nome do evento
Os campos context
e name
poderão variar de acordo com a tabela a seguir:
context | Evento | Descrição |
---|---|---|
Pix | PIX_CASH_IN_WAS_RECEIVED | O valor foi recebido no core bancário Bankly. |
Pix | PIX_CASH_IN_WAS_CLEARED | O valor foi liberado na conta destino. |
Pix | PIX_REFUND_WAS_RECEIVED | O valor devolvido foi recebido no core bancário Bankly. |
Pix | PIX_REFUND_WAS_CLEARED | O valor devolvido foi liberado na conta destino. |
Pix | PIX_CASHOUT_WAS_COMPLETED | Pagamento via Pix finalizado. |
Pix | PIX_CASHOUT_WAS_CANCELED | A transação não foi concluída, possivelmente por falta de saldo, e não houve saída de valor da conta. |
Pix | PIX_CASHOUT_WAS_UNDONE | A transação falhou devido a uma regra de negócio e o pagamento via Pix foi desfeito (não houve saída de valor da conta). |
Pix | PIX_QRCODE_WAS_CREATED | Um QR Code para pagamento via Pix foi emitido. |
Dict | PIX_CLAIM_WAS_ACKNOWLEDGED | O pedido de reivindicação foi reconhecido. |
Dict | PIX_CLAIM_WAS_CONFIRMED | O pedido de reivindicação foi confirmado. |
Dict | PIX_CLAIM_WAS_COMPLETED | O processo de reivindicação foi concluído. |
Dict | PIX_CLAIM_WAS_CANCELED | O processo de reivindicação foi cancelado. |
Dict | PIX_CLAIM_WAS_REGISTERED | Um cliente do parceiro Bankly registrou um pedido de reivindicação de posse/portabilidade para outra instituição. |
Fluxo dos eventos
Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:





Identificador (entityId
)
entityId
)O campo entityId
é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão, conforme a tabela a seguir:
Evento | Identificador (entityId ) | Descrição |
---|---|---|
PIX_CASH_IN_WAS_RECEIVED | AuthenticationCode | Código identificador da transação. |
PIX_CASH_IN_WAS_CLEARED | AuthenticationCode | Código identificador da transação. |
PIX_REFUND_WAS_RECEIVED | AuthenticationCode | Código identificador da transação. |
PIX_REFUND_WAS_CLEARED | AuthenticationCode | Código identificador da transação. |
PIX_CASHOUT_WAS_COMPLETED | AuthenticationCode | Código identificador da transação. |
PIX_CASHOUT_WAS_CANCELED | AuthenticationCode | Código identificador da transação. |
PIX_CASHOUT_WAS_UNDONE | AuthenticationCode | Código identificador da transação. |
PIX_QRCODE_WAS_CREATED | addressingKey.value | Valor da chave Pix. |
PIX_CLAIM_WAS_ACKNOWLEDGED | claimId | Identificação única de pedido de portabilidade ou posse. |
PIX_CLAIM_WAS_CONFIRMED | claimId | Identificação única de pedido de portabilidade ou posse. |
PIX_CLAIM_WAS_COMPLETED | claimId | Identificação única de pedido de portabilidade ou posse. |
PIX_CLAIM_WAS_CANCELED | claimId | Identificação única de pedido de portabilidade ou posse. |
PIX_CLAIM_WAS_REGISTERED | claimId | Identificação única de pedido de portabilidade ou posse. |
Dados dos eventos
PIX_CASH_IN_WAS_RECEIVED
Esse evento sinaliza que um valor foi recebido no core bancário Bankly.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
addressingKey | object | Objeto que contém os dados da chave de endereçamento. Objeto não retornado em caso de Pix manual. |
addressingKey.value | string | Valor da chave de endereçamento. |
addressingKey.type | string | Tipo de chave, que pode ser: CPF, CNPJ, telefone, e-mail e EVP. |
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação. |
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor, o qual pode ser “Business” ou “Customer”. |
recipient.name | string | Nome do recebedor da transação. Campo não retornado em caso de Pix por chave e por QR Code. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Número da agência. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
recipient.account.bank | object | Objeto que contém os dados do banco do recebedor da transação. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
recipient.account.bank.code | string | Código do banco. Campo não retornado em caso de Pix por chave e por QR Code. |
recipient.account.bank.name | string | Nome do banco. Campo não retornado em caso de Pix por chave e por QR Code. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador, o qual pode ser “Business” ou “Customer”. |
channel.sender.name | string | Nome do pagador da transação. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Número da agência. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
channel.sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.sender.account.bank.name | string | Nome do banco. Campo não retornado em caso de Pix por chave e por QR Code. |
channel.end2EndId | string | Identificador único da transação Pix. Campo não retornado em caso de Pix manual. |
channel.receiverReconciliationId | string | ID de conciliação utilizado para conciliação dos pagamentos. Campo não retornado em caso de Pix por chave e manual. |
channel.pixInitializationType | string | Modo pelo qual a transação ocorreu: "key" (chave de endereçamento), "staticQrCode" ou "dynamicQrCode" (QR Code) e "manual”. |
channel.pixPaymentPriority | string | Prioridade de pagamento, que pode ser “Priority” e “NonPriority”. |
channel.pixPaymentPriorityType | string | Tipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”. |
channel.pixPaymentPurpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
createdAt | string | Data de criação da transação, no formato YYYY-MM-DDTHH:mm:SS.MMMZ. |
Nota
Conforme descrito na tabela acima, campos retornados no objeto data poderão variar de acordo com o tipo de transação (manual, por chave e por QR Code).
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
[
{
"entityId": "d38a7437-00b1-4c86-b3c8-119ca7a9c70a",
"companyKey": "teste",
"idempotencyKey": "e7360f71-5884-420b-89fa-52d63a7097ed",
"context": "Pix",
"name": "PIX_CASH_IN_WAS_RECEIVED",
"timestamp": "2023-08-14T13:38:12.2581825Z",
"correlationId": "0a1245b7-00a7-40dc-9c7d-38f95b0d5c4d",
"data": {
"authenticationCode": "d38a7437-00b1-4c86-b3c8-119ca7a9c70d",
"amount": {
"value": 1.6,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"name": "Editora Floresta",
"account": {
"branch": "0001",
"number": "422316",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A. - Instituição De Pagamento"
}
}
},
"channel": {
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A. - Instituição De Pagamento"
}
}
},
"pixInitializationType": "Manual",
"pixPaymentPriority": "Priority",
"pixPaymentPriorityType": "Priority",
"pixPaymentPurpose": "PurchaseOrTransfer"
},
"createdAt": "2023-08-14T13:38:12.2287402Z"
}
}
]
[
{
"entityId": "6113b387-1472-47e9-99c5-389a8c751e58",
"companyKey": "teste",
"idempotencyKey": "aef571e2-5285-4059-a62d-e88c619322d5",
"context": "Pix",
"name": "PIX_CASH_IN_WAS_RECEIVED",
"timestamp": "2023-08-14T13:38:06.2011353Z",
"correlationId": "b7c83ab8-134f-46d7-b824-0505c7771c75",
"data": {
"addressingKey": {
"value": "a8952390-5352-425e-a0af-2c1c8d668025",
"type": "EVP"
},
"authenticationCode": "6113b387-1472-47e9-99c5-389a8c751e55",
"amount": {
"value": 1,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"account": {
"branch": "0001",
"number": "422316",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Payment",
"bank": {
"ispb": "16501555"
}
}
},
"end2EndId": "E165015552023081413371d",
"pixInitializationType": "Key",
"pixPaymentPriority": "Priority",
"pixPaymentPriorityType": "Priority",
"pixPaymentPurpose": "PurchaseOrTransfer"
},
"createdAt": "2023-08-14T13:38:06.110299Z"
}
}
]
[
{
"entityId": "e3c6f335-7c29-4bb2-9c6c-7b2555f549a6",
"companyKey": "teste",
"idempotencyKey": "0583108b-95e9-4e10-be44-f60e8004bdd6",
"context": "Pix",
"name": "PIX_CASH_IN_WAS_RECEIVED",
"timestamp": "2023-08-14T13:38:14.4201928Z",
"correlationId": "ad010686-0af0-4891-b83b-b6b4a9a04748",
"data": {
"addressingKey": {
"value": "4afe2e54-02fb-44e8-81cb-d8eb84958874",
"type": "EVP"
},
"authenticationCode": "e3c6f335-7c29-4bb2-9c6c-7b2555f549a6",
"amount": {
"value": 378.84,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"account": {
"branch": "0001",
"number": "422316",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "2363",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "00000000"
}
}
},
"end2EndId": "E0000000020230814133806588660",
"receiverReconciliationId": "75509104108",
"pixInitializationType": "StaticQrCode",
"pixPaymentPriority": "Priority",
"pixPaymentPriorityType": "Priority",
"pixPaymentPurpose": "PurchaseOrTransfer"
},
"createdAt": "2023-08-14T13:38:14.3292971Z"
}
}
]
[
{
"entityId": "a79c03e9-699b-47b0-8a45-e3820a156ce5",
"companyKey": "teste",
"idempotencyKey": "344c3de2-7786-40dc-a225-2e28d755aa05",
"context": "Pix",
"name": "PIX_CASH_IN_WAS_RECEIVED",
"timestamp": "2023-08-14T13:42:50.0463594Z",
"correlationId": "4bfb9cab-54f1-447c-9811-20754e795545",
"data": {
"addressingKey": {
"value": "09580aa6-669f-40dd-b8e0-a285017deaa5",
"type": "EVP"
},
"authenticationCode": "a79c03e9-699b-47b0-8a45-e3820a156ce5",
"amount": {
"value": 22,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Customer",
"account": {
"branch": "0001",
"number": "422316",
"type": "Payment",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Payment",
"bank": {
"ispb": "17192451"
}
}
},
"end2EndId": "E171924512023081EFXWS4BD",
"receiverReconciliationId": "baa1224d9ab8198d1f58206c",
"pixInitializationType": "DynamicQrCode",
"pixPaymentPriority": "Priority",
"pixPaymentPriorityType": "Priority",
"pixPaymentPurpose": "Payment"
},
"createdAt": "2023-08-14T13:42:49.1967744Z"
}
}
]
PIX_CASH_IN_WAS_CLEARED
Esse evento sinaliza que o valor recebido foi liberado na conta de destino.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Moeda utilizada na transação. |
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.name | string | Nome do recebedor da transação. |
recipient.status | string | Situação do cadastro do recebedor, que pode ser PENDING_APPROVAL, APPROVED, REPROVED e BLOCKLISTED. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Número da agência. |
recipient.account.number | string | Número da conta. |
recipient.account.status | string | Status da conta do recebedor, que pode ser ACTIVE ou CLOSED. |
recipient.account.bank | object | Objeto que contém os dados do banco do recebedor da transação. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.end2EndId | string | Identificador único da transação via Pix. |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.name | string | Nome do pagador da transação. |
channel.sender.status | string | Situação do cadastro do pagador, que pode ser PENDING_APPROVAL, APPROVED, REPROVED e BLOCKLISTED. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Número da agência. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
channel.sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.sender.account.bank.code | string | Código do banco. |
channel.sender.account.bank.name | string | Nome do banco. |
receiverReconciliationId | string | ID de conciliação utilizado para conciliação dos pagamentos. |
pixInitializationType | string | Modo pelo qual a transação ocorreu: "key" (chave de endereçamento), "staticQrCode" ou "dynamicQrCode" (QR Code) e "manual”. |
pixPaymentPriority | string | Prioridade de pagamento, que pode ser “Priority” e “NonPriority”. |
pixPaymentPriorityType | string | Tipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”. |
pixPaymentPurpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
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
[
{
"entityId": "a79753ae-6d68-4e81-b4a4-14147063b12b",
"idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
"companyKey": "ACESSO",
"context": "Pix",
"name": " PIX_CASH_IN_WAS_CLEARED",
"timestamp": "2021-10-05T00:00:00.000Z",
"correlationId": "61833e96-86ea-4248-9700-5fd08a00bcb2",
"version": "1",
"metadata": {
"key": "Complement event info"
},
"data": {
"amount": {
"value": 0,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"name": "Maria Quitéria de Jesus",
"status": "APPROVED",
"account": {
"branch": "00001",
"number": "540108",
"status": "ACTIVE",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"end2EndId": "c518e3b7-196d-473e-a26e-f17723cf5690",
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"name": "Nísia Floresta",
"status": "APPROVED",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"code": "123",
"name": "Acesso Soluções de pagamento S.A."
}
}
}
},
"receiverReconciliationId": "560ef98b-a9f2-4f09-9b40-242f73bc00c7",
"pixInitializationType": "string`",
"pixPaymentPriority": "string`",
"pixPaymentPriorityType": "`string`",
"pixPaymentPurpose": "`string`"
}
}
]
PIX_REFUND_WAS_RECEIVED
Esse evento sinaliza que o valor de uma devolução foi recebido no core bancário Bankly.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Sigla da moeda utilizada na transação. |
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor, que pode ser “Customer” ou “Business”. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Número da agência. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
recipient.account.bank | object | Objeto que contém os dados do banco do recebedor da transação. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.end2EndIdOriginal | string | EndToEndId da transação de Pix cash-out inicial. |
channel.refundReason | string | Descrição do motivo da devolução do valor. |
channel.errorCode | string | Código da devolução, que pode ser BE08 (devolução de pagamento instantâneo devido a erro do PSP), FR01 (devolução de pagamento motivada por fundada suspeita de fraude), MD06 (devolução de pagamento instantâneo solicitada pelo usuário recebedor pagamento original) e SL02 (devolução motivada por um erro relacionado ao saque Pix). |
channel.errorReason | string | Razão da devolução (descrita anteriormente). |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | Tipo de cliente pagador, que pode ser “Customer” ou “Business”. | |
channel.sender.name | string | Nome do pagador da transação. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Número da agência. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
channel.sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.end2EndId | string | Identificador único da transação Pix. |
createdAt | string | Data da devolução, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
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
[
{
"entityId": "ac833e56-aae4-4db7-a181-f6be343e3b49",
"companyKey": "ACESSO",
"idempotencyKey": "e7d58dbc-fd76-4330-bdd7-906e4a0bb9e1",
"context": "Pix",
"name": "PIX_REFUND_WAS_RECEIVED",
"timestamp": "2021-12-03T10:53:07.5872852Z",
"correlationId": "d386aee5-c0da-43ee-87dc-b3ee947172cf",
"metadata": null,
"data": {
"authenticationCode": "ac833e56-aae4-4db7-a181-f6be343e3b49",
"amount": {
"value": 0.25,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"end2EndIdOriginal": "E1314008820211203105231257961793",
"refundReason": "BANK_RETURN",
"errorCode": "MD06",
"errorReason": "",
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"end2EndId": "D18236120202112031052s0056352CWL"
},
"createdAt": "2021-12-03T10:53:06.6893633Z"
}
}
]
PIX_REFUND_WAS_CLEARED
Esse evento sinaliza que o valor da devolução foi liberado na conta de destino.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Sigla da moeda utilizada na transação. |
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor, que pode ser “Customer” ou “Business”. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Número da agência. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
recipient.account.bank | object | Objeto que contém os dados do banco do recebedor da transação. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.end2EndIdOriginal | string | EndToEndId da transação de Pix cash-out inicial. |
channel.refundReason | string | Descrição do motivo da devolução do valor. |
channel.errorCode | string | Código da devolução, que pode ser BE08 (devolução de pagamento instantâneo devido a erro do PSP), FR01 (devolução de pagamento motivada por fundada suspeita de fraude), MD06 (devolução de pagamento instantâneo solicitada pelo usuário recebedor pagamento original) e SL02 (devolução motivada por um erro relacionado ao saque Pix). |
channel.errorReason | string | Razão da devolução (descrita anteriormente). |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | Tipo de cliente pagador, que pode ser “Customer” ou “Business”. | |
channel.sender.name | string | Nome do pagador da transação. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Número da agência. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
channel.sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.end2EndId | string | Identificador único da transação Pix. |
createdAt | string | Data da devolução, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
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
[
{
"entityId": "ac833e56-aae4-4db7-a181-f6be343e3b49",
"companyKey": "ACESSO",
"idempotencyKey": "fc8cebd1-d1fa-4b4b-ac31-680e01cb206b",
"context": "Pix",
"name": "PIX_REFUND_WAS_CLEARED",
"timestamp": "2021-12-03T10:53:08.1980309Z",
"correlationId": "d386aee5-c0da-43ee-87dc-b3ee947172cf",
"metadata": null,
"data": {
"authenticationCode": "ac833e56-aae4-4db7-a181-f6be343e3b49",
"amount": {
"value": 0.25,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"channel": {
"end2EndIdOriginal": "E1314008820211203105231257961793",
"refundReason": "BANK_RETURN",
"errorCode": "MD06",
"errorReason": "",
"name": "SPI",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0000",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"end2EndId": "D18236120202112031052s0056352CWL"
},
"createdAt": "2021-12-03T10:53:06.6893633Z"
}
}
]
PIX_CASHOUT_WAS_COMPLETED
Esse evento sinaliza que um pagamento via Pix finalizado.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Sigla da moeda utilizada na transação. |
description | string | Descrição do pagamento. |
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de pagador, que pode ser “Customer” ou Business”. |
sender.name | string | Nome do pagador da transação. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Número da agência. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.destination | object | Objeto que contém os dados do destinatário da transação. |
channel.destination.document | object | Objeto que contém os dados do documento do destinatário da transação. |
channel.destination.document.value | string | Número do documento. |
channel.destination.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.destination.type | Tipo de destinatário, que pode ser “Customer” ou Business”. | |
channel.destination.name | string | Nome do destinatário da transação. |
channel.destination.account | object | Objeto que contém os dados da conta do destinatário. |
channel.destination.account.branch | string | Número da agência. |
channel.destination.account.number | string | Número da conta. |
channel.destination.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.destination.account.bank | object | Objeto que contém os dados do banco do destinatário da transação. |
channel.destination.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.destination.account.bank.code | string | Código do banco. |
channel.destination.account.bank.name | string | Nome do banco. |
channel.endToEndId | string | Identificador único da transação Pix. |
channel.initializationType | string | Modo pelo qual a transação ocorreu: "key" (chave de endereçamento), "staticQrCode" ou "dynamicQrCode" (QR Code) e "manual”. |
channel.paymentPurpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
channel.paymentPriority | string | Prioridade de pagamento, que pode ser “Priority” e “NonPriority”. |
channel.paymentPriorityType | string | Tipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”. |
channel.isPixOpenBanking | boolean | Indica se faz parte de uma transação do ecossistema Open Banking. |
channel.isInternal | boolean | Indica se é uma transação interna. |
paymentDate | string | Data do pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
isRefund | boolean | Indica se a transação é uma devolução. |
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
[
{
"entityId": "38d841f5-35a4-4297-b2db-f94e2664e74b",
"companyKey": "Acesso",
"idempotencyKey": "873b6c8d-af27-46ec-a4ab-02f836b6f1fc",
"context": "Pix",
"name": "PIX_CASHOUT_WAS_COMPLETED",
"timestamp": "2022-02-09T19:36:18.1299919Z",
"correlationId": "38d841f5-35a4-4297-b2db-f94e2674e74b",
"metadata": {
"RequestedAt": "2022-02-09T19:36:18.1299919Z"
},
"data": {
"authenticationCode": "38d841f5-35a4-4297-b2db-f94e2664e74b",
"amount": {
"value": 328.4,
"currency": "BRL"
},
"description": "c3ee8cc4-f88f-4b65-988f-87bd96142cb4",
"sender": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "422316",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"channel": {
"name": "SPI",
"destination": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Maria Quitéria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"endToEndId": "E1314008820220209193614764471951",
"initializationType": "Manual",
"paymentPurpose": "PurchaseOrTransfer",
"paymentPriority": "Priority",
"paymentPriorityType": "Priority",
"isPixOpenBanking": false,
"isInternal": false
},
"paymentDate": "2022-02-09T19:36:14.140084Z",
"isRefund": false
}
}
]
PIX_CASHOUT_WAS_CANCELED
Esse evento sinaliza que a transação via Pix não foi concluída, possivelmente por falta de saldo, e não houve saída de valor da conta.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Sigla da moeda utilizada na transação. |
description | string | Descrição do pagamento. |
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.name | string | Nome do pagador da transação. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Número da agência. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.destination | object | Objeto que contém os dados do destinatário da transação. |
channel.destination.document | object | Objeto que contém os dados do documento do destinatário da transação. |
channel.destination.document.value | string | Número do documento. |
channel.destination.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.destination.name | string | Nome do destinatário da transação. |
channel.destination.account | object | Objeto que contém os dados da conta do destinatário. |
channel.destination.account.branch | string | Número da agência. |
channel.destination.account.number | string | Número da conta. |
channel.destination.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.destination.account.bank | object | Objeto que contém os dados do banco do destinatário da transação. |
channel.destination.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.destination.account.bank.code | string | Código do banco. |
channel.destination.account.bank.name | string | Nome do banco. |
channel.initializationType | string | Modo pelo qual a transação ocorreu: "key" (chave de endereçamento), "staticQrCode" ou "dynamicQrCode" (QR Code) e "manual”. |
channel.paymentPurpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
channel.paymentPriority | string | Prioridade de pagamento, que pode ser “Priority” e “NonPriority”. |
channel.paymentPriorityType | string | Tipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”. |
channel.isPixOpenBanking | boolean | Indica se faz parte de uma transação do ecossistema Open Banking. |
channel.isInternal | boolean | Indica se é uma transação interna. |
channel.refusalReason | string | Razão pela qual o pagamento foi cancelado. Confira a lista com os possíveis motivos de reprovação no final da página. |
paymentDate | string | Data do pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
isRefund | boolean | Indica se a transação é uma devolução. |
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
[
{
"entityId": "90b9c655-74db-415a-9a51-69289442ec98",
"companyKey": "Acesso",
"idempotencyKey": "d0811671-00e3-4c3a-880d-029aab311b5a",
"context": "Pix",
"name": "PIX_CASHOUT_WAS_CANCELED",
"timestamp": "2022-02-09T19:38:27.3457184Z",
"correlationId": "90b9c655-74db-415a-9a51-69289442ec98",
"metadata": {
"RequestedAt": "2022-02-09T19:38:27.3457184Z"
},
"data": {
"authenticationCode": "90b9c655-74db-415a-9a51-692489442ec98",
"amount": {
"value": 305.35,
"currency": "BRL"
},
"description": "Despesas",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Payment",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"channel": {
"name": "SPI",
"destination": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"name": "Maria Quitéria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"initializationType": "Manual",
"paymentPurpose": "PurchaseOrTransfer",
"paymentPriority": "Priority",
"paymentPriorityType": "Priority",
"isPixOpenBanking": false,
"isInternal": false,
"refusalReason": "AC14-Pagamento rejeitado pelo PSP do recebedor"
},
"paymentDate": "2022-02-09T19:38:23.975911Z",
"isRefund": false
}
}
]
PIX_CASHOUT_WAS_UNDONE
Esse evento sinaliza que a transação falhou devido a uma regra de negócio e o pagamento via Pix foi desfeito (não houve saída de valor da conta).
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
authenticationCode | string | Identificador único da transação, no formato GUID v4. |
amount | object | Objeto que contém o valor da transação e a moeda utilizada. |
amount.value | number | Valor da transação realizada. |
amount.currency | string | Sigla da moeda utilizada na transação. |
description | string | Descrição do pagamento. |
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.name | string | Nome do pagador da transação. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Número da agência. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
sender.account.bank | object | Objeto que contém os dados do banco do pagador da transação. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
channel | object | Objeto que contém os dados do canal de pagamento. |
channel.name | string | Nome do canal de pagamento que, no caso do Pix, é SPI. |
channel.destination | object | Objeto que contém os dados do destinatário da transação. |
channel.destination.document | object | Objeto que contém os dados do documento do destinatário da transação. |
channel.destination.document.value | string | Número do documento. |
channel.destination.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.destination.name | string | Nome do destinatário da transação. |
channel.destination.account | object | Objeto que contém os dados da conta do destinatário. |
channel.destination.account.branch | string | Número da agência. |
channel.destination.account.number | string | Número da conta. |
channel.destination.account.type | string | Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento). |
channel.destination.account.bank | object | Objeto que contém os dados do banco do destinatário da transação. |
channel.destination.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.destination.account.bank.code | string | Código do banco. |
channel.destination.account.bank.name | string | Nome do banco. |
channel.initializationType | string | Modo pelo qual a transação ocorreu: "key" (chave de endereçamento), "staticQrCode" ou "dynamicQrCode" (QR Code) e "manual”. |
channel.paymentPurpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
channel.paymentPriority | string | Prioridade de pagamento, que pode ser “Priority” e “NonPriority”. |
channel.paymentPriorityType | string | Tipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”. |
channel.isPixOpenBanking | boolean | Indica se faz parte de uma transação do ecossistema Open Banking. |
channel.isInternal | boolean | Indica se é uma transação interna. |
channel.refusalReason | string | Razão pela qual o pagamento foi desfeito. Confira a lista com os possíveis motivos de reprovação no final da página. |
paymentDate | string | Data do pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
isRefund | boolean | Indica se a transação é uma devolução. |
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
[
{
"entityId": "f50a4aef-68eb-4146-8dc2-24d75f1a012f",
"companyKey": "Acesso",
"idempotencyKey": "29bfdded-f24b-4c46-970f-994b40b679b3",
"context": "Pix",
"name": "PIX_CASHOUT_WAS_UNDONE",
"timestamp": "2022-02-09T19:40:08.3554947Z",
"correlationId": "f50a4aef-68eb-4146-8dc2-24d75f1a012f",
"metadata": {
"requestedAt": "2022-02-09T19:40:08.3554947Z"
},
"data": {
"authenticationCode": "f50a4aef-68eb-4146-8dc2-24d75f1a012f",
"amount": {
"value": 305.35,
"currency": "BRL"
},
"description": "Despesas ",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"name": "Maria Quitéria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Payment",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"channel": {
"name": "SPI",
"destination": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"initializationType": "Manual",
"paymentPurpose": "PurchaseOrTransfer",
"paymentPriority": "Priority",
"paymentPriorityType": "Priority",
"isPixOpenBanking": false,
"isInternal": false,
"refusalReason": "AC14-Pagamento rejeitado pelo PSP do recebedor"
},
"paymentDate": "2022-02-09T19:40:05.3680743Z",
"isRefund": false
}
}
]
PIX_QRCODE_WAS_CREATED
Esse evento sinaliza que um QR Code para pagamento via Pix foi emitido.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
partnerKey | string | Chave que identifica o parceiro dentro do Bankly. |
conciliationId | string | ID de conciliação utilizado para conciliação dos pagamentos. |
addressingKey | object | Objeto que contém os dados da chave de endereçamento. |
addressingKey.value | string | Valor da chave de endereçamento. |
addressingKey.type | string | Tipo de chave, que pode ser: CPF, CNPJ, telefone, e-mail e EVP. |
amount | number | Valor do QR Code gerado. |
singlePayment | boolean | Indica se é um QR Code de pagamento único. |
type | string | Tipo de QR Code, que pode ser STATIC ou DYNAMIC. |
purpose | string | Propósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING. |
encodedValue | string | Código copia e cola, em formato base64, que contém todas as informações sobre o pagamento. |
changeAmountType | string | Indica se o valor do QR Code pode ou não ser alterado (ALLOWED ou NOT_ALLOWED). |
format | string | Formato de geração do QR Code (BASE64_IMAGE ou ENCODED_PAYLOAD). |
createdAt | string | Data de criação do QR Code, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
expiresAt | string | Data de expiração do QR Code, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. Válido apenas para QR Codes dinâmicos. |
paymentDateLimit | string | Data limite para pagamento do QR Code, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. Válido apenas para QR Codes dinâmicos. |
recipient | object | Objeto que contém os dados do recebedor da transação (emissor do QR Code). |
recipient.type | string | Tipo de cliente recebedor (CUSTOMER ou BUSINESS). |
recipient.documentNumber | string | Número do documento do recebedor. |
recipient.name | string | Nome do recebedor. |
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 payloads
[
{
"entityId": "f50a4aef-68eb-4146-8dc2-24d75f1a012f",
"companyKey": "Acesso",
"idempotencyKey": "29bfdded-f24b-4c46-970f-994b40b679b3",
"metadata": null,
"context": "Pix",
"name": "PIX_QRCODE_WAS_CREATED",
"timestamp": "2022-02-09T19:40:08.3554947Z",
"correlationId": "f50a4aef-68eb-4146-8dc2-24d75f1a012f",
"version": "1",
"data": {
"partnerKey": "FLORESTA_ED",
"conciliationId": "bklyconciliation00",
"addressingKey": {
"value": "47742663023",
"type": "CPF"
},
"amount": 17.38,
"singlePayment": true,
"type": "STATIC",
"purpose": "PURCHASE_OR_TRANSFER",
"encodedValue": "MDAwMjAxMjY4MzAwMTRici5nb3YuYmNiLnBpeDAxMTEzNzc5ODgyMTgzMDAyNZtZW5zYWdlbSBkZSBjYW1wOCB2YWxvciAxbmZvcm1hw6fDtWVzIEBkaWNpb25haXM1MjA0MDAwMDUzMDM5ODY1NDA1MTcuMzg1ODAyQlI1OTIyR3VpbGhlcm1lIFNjaG9seiBSYW1vczYwMDlTYW8gUGF1bG82MTA4MDQyMDUwMDA2MjIyMDUxOGJrbHljb25jaWxpYXRpb24yNzYzMDRDRTE0",
"changeAmountType": "NOT_ALLOWED",
"format": "BASE64_IMAGE",
"createdAt": "2022-12-09T13:45:00.0307374Z",
"recipient": {
"type": "CUSTOMER",
"documentNumber": "47742663023",
"name": "Nísia Floresta"
}
}
}
]
[
{
"entityId": "5a3e222b-f306-4654-aa27-4b14e3c6a8aa",
"companyKey": "Acesso",
"idempotencyKey": "404fc313-3ef5-4708-844f-24fb36d071f9",
"metadata": null,
"context": "Pix",
"name": "PIX_QRCODE_WAS_CREATED",
"timestamp": "2023-01-31T13:46:16.6052919Z",
"correlationId": "e460471e-c8b3-4b4c-a274-0b2d5765acd1",
"version": "1",
"data": {
"partnerKey": "FLORESTA_ED",
"conciliationId": "1YHwX85KkNePcZE3cn2miGpxMAZc6WcN",
"addressingKey": {
"type": "EVP",
"value": "5a3e222b-f306-4654-aa27-4b14e3c6a8aa"
},
"amount": 2,
"singlePayment": false,
"type": "DYNAMIC",
"purpose": "PAYMENT",
"encodedValue": "MDAwMjAxMjY5MjAwMTRici5nb3YuYmNiLnBpeDI1NzBxci1oLnNhbmRib3guYmFua2x5LmNvbS5ici9waXgvcXIvY2EwMzkxYzctOTQ0MS00YjgzLWJiMjctNDg5NDUwNTFmMmMzNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyMk5vbWUgQ2xpZW50ZSBSZWNlYmVkb3I2MDA5U2FvIFBhdWxvNjEwODA1NDAyMTAwNjIwNzA1MDMqKio2MzA0MDRCQQ==",
"format": "ENCODED_PAYLOAD",
"changeAmountType": "NOT_ALLOWED",
"createdAt": "2023-01-31T13:46:16.5127193+00:00",
"expiresAt": "2023-05-07T00:00:00",
"paymentDateLimit": "2023-05-07T00:00:00",
"recipient": {
"type": "CUSTOMER",
"documentNumber": "47742663023",
"name": "Nísia Floresta"
}
}
}
]
PIX_CLAIM_WAS_ACKNOWLEDGED
Este evento sinaliza que o pedido de reivindicação recebido pelo cliente parceiro Bankly foi reconhecido.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
claimId | string | Identificação única de pedido de portabilidade ou posse. |
type | string | Tipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse. |
addressingKey | object | Objeto que contém os dados da chave Pix. |
addressingKey.type | string | Tipo de chave de endereçamento (CPF, CNPJ, e-mail ou telefone). |
addressingKey.value | string | Valor da chave. |
claimer | object | Objeto que contém os dados da conta do reivindicador. |
claime.branch | string | Número da agência bancária. |
claime.number | string | Número da conta. |
claimer.bank | object | Objeto que contém informações sobre o banco do reivindicador. |
claime.bank.name | string | Nome da instituição de pagamento. |
claime.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
donor | object | Objeto que contém os dados da conta do doador. |
donor.branch | string | Número da agência bancária. |
donor.number | string | Número da conta. |
donor.bank | object | Objeto que contém informações sobre o banco do doador. |
donor.bank.name | string | Nome da instituição de pagamento. |
donor.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
status | string | Situação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse. |
createdAt | string | Data de criação do pedido. |
updatedAt | string | Data da última atualização do pedido. |
resolutionLimitDate | string | Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
conclusionLimitDate | string | Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
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
[
{
"entityId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"companyKey": "ACESSO",
"idempotencyKey": "f5ff2ba3-76c0-4aa0-8015-a93b62a6c126",
"context": "Dict",
"name": "PIX_CLAIM_WAS_ACKNOWLEDGED",
"timestamp": "2022-07-28T14:52:55.0768999Z",
"correlationId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"version": null,
"metadata": {
"RequestedAt": "2022-07-28T11:11:27.1582013Z"
},
"data": {
"claimId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"type": "PORTABILITY",
"addressingKey": {
"type": "EMAIL",
"value": "[email protected]"
},
"claimer": {
"branch": "0001",
"number": "540108",
"bank": {
"name": "Acesso Solucoes de Pagamentos SA",
"ispb": "13140088"
}
},
"donor": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "18236120"
}
},
"status": "WAITING_RESOLUTION",
"createdAt": "2022-07-28T11:11:27.1582013Z",
"updatedAt": "2022-07-28T14:52:55.0768999Z",
"resolutionLimitDate": "2022-08-04T11:11:27.1582013Z",
"conclusionLimitDate": "2022-08-11T11:11:27.1582013Z"
}
}
]
PIX_CLAIM_WAS_CONFIRMED
Este evento sinaliza que o pedido de reivindicação recebido pelo cliente parceiro Bankly foi confirmado.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
claimId | string | Identificação única de pedido de portabilidade ou posse. |
type | string | Tipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse. |
addressingKey | object | Objeto que contém os dados da chave Pix. |
addressingKey.type | string | Tipo de chave de endereçamento (CPF, CNPJ, e-mail ou telefone). |
addressingKey.value | string | Valor da chave. |
claimer | object | Objeto que contém os dados da conta do reivindicador. |
claimer.branch | string | Número da agência bancária. |
claimer.number | string | Número da conta. |
claimer.bank | object | Objeto que contém informações sobre o banco do reivindicador. |
claimer.bank.name | string | Nome da instituição de pagamento. |
claimer.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
donor | object | Objeto que contém os dados da conta do doador. |
donor.branch | string | Número da agência bancária. |
donor.number | string | Número da conta. |
donor.bank | object | Objeto que contém informações sobre o banco do doador. |
donor.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
status | string | Situação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse. |
confirmReason | string | Motivo da confirmação do pedido de portabilidade ou posse, o qual pode ser “DONOR_REQUEST” (solicitação do doador), “DEFAULT_OPERATION” (operação padrão) ou "ACCOUNT_CLOSED" (encerramento de conta). |
confirmedBy | string | Pessoa que confirmou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para posse). |
createdAt | string | Data de criação do pedido. |
updatedAt | string | Data da última atualização do pedido. |
resolutionLimitDate | string | Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
conclusionLimitDate | string | Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
confirmedAt | string | Data de confirmação do pedido. |
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
[
{
"entityId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"companyKey": "ACESSO",
"idempotencyKey": "f5ff2ba3-76c0-4aa0-8015-a93b62a6c126",
"context": "Dict",
"name": "PIX_CLAIM_WAS_CONFIRMED",
"timestamp": "2022-07-28T14:53:00.3634821Z",
"correlationId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"version": null,
"metadata": {
"RequestedAt": "2022-07-28T14:53:00.3634821Z",
"ResponseAt": "2022-07-29T10:50:00.3634821Z",
"NotificationEndedAt": "2022-07-29T14:53:00.3634821Z",
"NotificationStartedAt": "2022-07-29T04:23:00.3634821Z"
},
"data": {
"claimId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"type": "PORTABILITY",
"addressingKey": {
"type": "EMAIL",
"value": "[email protected]"
},
"claimer": {
"branch": "0001",
"number": "540108",
"bank": {
"name": "Acesso Solucoes de Pagamentos SA",
"ispb": "13140088"
}
},
"donor": {
"branch": "0001",
"number": "15164",
"bank": {
"name": "Acesso Soluções de Pagamento SA",
"ispb": "18236120"
}
},
"status": "CONFIRMED",
"confirmReason": "DONOR_REQUEST",
"confirmedBy": "DONOR",
"createdAt": "2022-07-28T08:11:27.158-03:00",
"updatedAt": "2022-07-28T14:53:00.3634821Z",
"resolutionLimitDate": "2022-08-04T14:53:00.3634821Z",
"conclusionLimitDate": "2022-08-04T14:53:00.3634821Z",
"confirmedAt": "2022-07-28T14:53:00.3634363Z"
}
}
]
PIX_CLAIM_WAS_COMPLETED
Este evento sinaliza que o pedido de reivindicação recebido pelo cliente parceiro Bankly foi completado.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
claimId | string | Identificação única de pedido de portabilidade ou posse. |
type | string | Tipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse. |
addressingKey | object | Objeto que contém os dados da chave Pix. |
addressingKey.type | string | Tipo de chave de endereçamento (CPF, CNPJ, e-mail ou telefone). |
addressingKey.value | string | Valor da chave. |
claimer | object | Objeto que contém os dados da conta do reivindicador. |
claimer.branch | string | Número da agência bancária. |
claimer.number | string | Número da conta. |
claimer.bank | object | Objeto que contém os dados do banco do reivindicador. |
claimer.bank.name | string | Nome da instituição de pagamento. |
claimer.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
donor | object | Objeto que contém os dados da conta do doador. |
donor.branch | string | Número da agência bancária. |
donor.number | string | Número da conta. |
donor.bank | object | Objeto que contém os dados do banco do doador. |
donor.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
status | string | Situação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse. |
confirmReason | string | Motivo da confirmação do pedido de portabilidade ou posse, o qual pode ser “DONOR_REQUEST” (solicitação do doador), “DEFAULT_OPERATION” (operação padrão) ou "ACCOUNT_CLOSED" (encerramento de conta). |
confirmedBy | string | Pessoa que confirmou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para posse). |
createdAt | string | Data de criação do pedido. |
updatedAt | string | Data da última atualização do pedido. |
resolutionLimitDate | string | Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
conclusionLimitDate | string | Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
confirmedAt | string | Data de confirmação do pedido. |
completedAt | string | Data de conclusão do pedido. |
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
[
{
"entityId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"companyKey": "ACESSO",
"idempotencyKey": "f5ff2ba3-76c0-4aa0-8015-a93b62a6c126",
"context": "Dict",
"name": "PIX_CLAIM_WAS_COMPLETED",
"timestamp": "2022-07-28T14:53:00.9445329Z",
"correlationId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"version": null,
"metadata": {
"RequestedAt": "2022-07-28T14:53:00.9445329Z",
"ResponseAt": "2022-07-29T14:53:00.9445329Z"
},
"data": {
"claimId": "61f71c92-b5d4-4331-ad60-dd4d7919ef20",
"type": "PORTABILITY",
"addressingKey": {
"type": "EMAIL",
"value": "[email protected]"
},
"claimer": {
"branch": "0001",
"number": "540108",
"bank": {
"name": "Acesso Solucoes de Pagamentos SA",
"ispb": "13140088"
}
},
"donor": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "18236120"
}
},
"status": "COMPLETED",
"confirmReason": "DONOR_REQUEST",
"confirmedBy": "DONOR",
"createdAt": "2022-07-28T14:53:00.9445309Z",
"updatedAt": "2022-08-01T10:00:00.9445329Z",
"resolutionLimitDate": "2022-08-02T14:53:00.9445309Z",
"conclusionLimitDate": "2022-08-01T10:00:00.9445329Z",
"confirmedAt": "2022-07-28T14:53:00.9445309Z",
"completedAt": "2022-07-28T14:53:00.9445309Z"
}
}
]
PIX_CLAIM_WAS_CANCELED
Este evento sinaliza que o pedido de reivindicação recebido pelo cliente parceiro Bankly foi cancelado.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
claimId | string | Identificação única de pedido de portabilidade ou posse. |
type | string | Tipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse. |
addressingKey | object | Objeto que contém os dados da chave Pix. |
addressingKey.type | string | Tipo de chave de endereçamento (CPF, CNPJ, e-mail ou telefone). |
addressingKey.value | string | Valor da chave. |
claimer | object | Objeto que contém os dados da conta do reivindicador. |
claime.branch | string | Número da agência bancária. |
claime.number | string | Número da conta. |
claime.bank | object | Objeto que contém os dados do banco do reivindicador. |
claime.bank.name | string | Nome da instituição de pagamento. |
claime.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
donor | object | Objeto que contém os dados da conta do doador. |
donor.branch | string | Número da agência bancária. |
donor.number | string | Número da conta. |
donor.bank | object | Objeto que contém os dados do banco do doador. |
donor.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
status | string | Situação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse. |
cancelReason | string | Motivo do cancelamento do pedido de portabilidade ou posse, o qual pode ser “CLAIMER_REQUEST” (Solicitação do reivindicador), “DONOR_REQUEST” (Solicitação do doador), “ACCOUNT_CLOSURE” (Encerramento de conta), “FRAUD” (Fraude), “DEFAULT_OPERATION” (Operação padrão). |
confirmReason | string | Motivo da confirmação do pedido de portabilidade ou posse. No evento de cancelamento de solicitação de posse (OWNERSHIP), os valores retornados podem ser: “DONOR_REQUEST” (solicitação do doador) ou “DEFAULT_OPERATION” (operação padrão). Para eventos de cancelamento de solicitação de portabilidade (PORTABILITY), os valores retornados podem ser: “DONOR_REQUEST” (solicitação do doador) ou NULL. |
canceledBy | string | Pessoa que cancelou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para portabilidade). |
createdAt | string | Data de criação do pedido. |
updatedAt | string | Data da última atualização do pedido. |
resolutionLimitDate | string | Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
conclusionLimitDate | string | Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
canceledAt | string | Data de cancelamento do pedido. |
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
[
{
"entityId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"companyKey": "ACESSO",
"idempotencyKey": "f5ff2ba3-76c0-4aa0-8015-a93b62a6c126",
"context": "Dict",
"name": "PIX_CLAIM_WAS_CANCELED",
"timestamp": "2022-07-28T14:56:07.901896Z",
"correlationId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"version": null,
"metadata": {
"RequestedAt": "2022-07-28T14:56:07.901896Z",
"ResponseAt": "2022-07-29T10:56:07.901896Z"
},
"data": {
"claimId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"type": "PORTABILITY",
"addressingKey": {
"type": "EMAIL",
"value": "[email protected]"
},
"claimer": {
"branch": "0001",
"number": "540108",
"bank": {
"name": "Acesso Solucoes de Pagamentos SA",
"ispb": "13140088"
}
},
"donor": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "18236120"
}
},
"status": "CANCELED",
"cancelReason": "DONOR_REQUEST",
"confirmReason": "DONOR_REQUEST",
"canceledBy": "DONOR",
"createdAt": "2022-07-28T14:56:07.901896Z",
"updatedAt": "2022-07-29T14:56:07.901896Z",
"resolutionLimitDate": "2022-08-02T14:53:00.9445309Z",
"conclusionLimitDate": "2022-08-01T10:53:00.9445309Z",
"canceledAt": "2022-08-02T14:53:00.9445309Z"
}
}
]
PIX_CLAIM_WAS_REGISTERED
Este evento sinaliza que um cliente do parceiro Bankly registrou um pedido de reivindicação de posse/portabilidade para outra instituição.
Descrição do objeto data
do evento
data
do eventoO objeto data
traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
---|---|---|
claimId | string | Identificação única de pedido de portabilidade ou posse. |
type | string | Tipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse. |
addressingKey | object | Objeto que contém os dados da chave Pix. |
addressingKey.type | string | Tipo de chave de endereçamento (CPF, CNPJ, e-mail ou telefone). |
addressingKey.value | string | Valor da chave. |
claimer | object | Objeto que contém os dados da conta do reivindicador. |
claimer.branch | string | Número da agência bancária. |
claimer.number | string | Número da conta. |
claimer.bank | object | Objeto que contém os dados do banco do reivindicador. Como nesse evento o reivindicador é cliente do parceiro Bankly, os dados bancários serão sempre os dados do Bankly. |
claimer.bank.name | string | Nome da instituição de pagamento. |
claimer.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
donor | object | Objeto que contém os dados da conta do doador. |
donor.branch | string | Número da agência bancária. |
donor.number | string | Número da conta. |
donor.bank | object | Objeto que contém os dados do banco do doador. |
donor.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
status | string | Situação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse. |
createdAt | string | Data de criação do pedido. |
updatedAt | string | Data da última atualização do pedido. |
resolutionLimitDate | string | Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
conclusionLimitDate | string | Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. |
Importante
As propriedades do objeto
donor
não retornam em sandbox, somente em produção.
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
[
{
"entityId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"companyKey": "ACESSO",
"idempotencyKey": "f5ff2ba3-76c0-4aa0-8015-a93b62a6c126",
"context": "Dict",
"name": "PIX_CLAIM_WAS_REGISTERED",
"timestamp": "2022-07-28T14:56:07.901896Z",
"correlationId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"version": null,
"metadata": {
"RequestedAt": "2022-07-28T14:56:07.901896Z",
"ResponseAt": "2022-07-28T14:56:07.901896Z"
},
"data": {
"claimId": "c9edda76-63fd-451e-a9e3-b3bf98f24b89",
"type": "PORTABILITY",
"addressingKey": {
"type": "CPF",
"value": "47742663023"
},
"claimer": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088"
}
},
"donor": {
"branch": "0001",
"number": "540108",
"bank": {
"name": "Acesso Solucoes de Pagamentos SA",
"ispb": "18236120"
}
},
"status": "OPEN",
"createdAt": "2022-11-30T17:22:10.3590807Z",
"resolutionLimitDate": "2022-12-07T17:22:10.3590807Z",
"conclusionLimitDate": "2022-12-14T17:22:10.3590807Z"
}
}
]
Possíveis status do pedido de portabilidade ou posse
Status | Descrição |
---|---|
WAITING_RESOLUTION | A reivindicação já foi recebida pelo doador e está aguardando a resolução. |
CONFIRMED | O doador confirmou o pedido de reivindicação e vai ceder a chave para a outra instituição. Isso implica a remoção da chave do DICT e da base interna do PSP doador. Está aguardando o reivindicador encerrar o processo. |
CANCELED | O doador ou reivindicador cancelou a reivindicação, mantendo o vínculo inalterado (conforme estava antes da reivindicação), tanto no DICT quanto na base interna do PSP. |
COMPLETED | O pedido de portabilidade ou posse foi completado com sucesso e que chave foi transferida para o Bankly. |
Motivos de reprovação
Código | Descrição |
---|---|
AB09 | Transação interrompida devido a erro no participante do usuário recebedor. |
AC03 | Número da agência e/ou conta transacional do usuário recebedor inexistente ou inválido. |
AC06 | A conta transacional especificada encontra-se bloqueada. |
AC07 | Número da conta transacional encerrada no PSP do Recebedor. |
AC14 | Tipo incorreto para a conta transacional especificada. |
AG03 | O tipo de transação não é suportado/autorizado na conta transacional especificada. Ex: transferência para conta salário. |
AM02 | Ordem de pagamento/devolução em valor superou o limite permitido para o tipo de conta transacional creditada. |
AM09 | Devolução de pagamento em valor superou o valor da ordem de pagamento instantâneo correspondente. |
BE01 | CPF/CNPJ do usuário recebedor não é consistente com o titular da conta transacional especificada. |
CH11 | CPF/CNPJ do usuário recebedor incorreto. |
DS04 | Ordem rejeitada pelo PSP do Recebedor. |
DS24 | Ordem rejeitada por extrapolação do tempo decorrido entre o envio da pain.013 e o recebimento da pacs.008 correspondente pelo participante do usuário recebedor. |
DT05 | A transação extrapolou o prazo máximo para devolução de pagamento instantâneo regulamentado pelo arranjo Pix. |
RR04 | Ordem de pagamento em que o usuário pagador é sancionado por resolução do Conselho de Segurança das Nações Unidas (CSNU). Nos casos em que o usuário recebedor for o sancionado, a ordem de pagamento não deve ser rejeitada. |
ED05 | Erro no processamento do pagamento. |
SL02 | A transação original não está relacionada ao serviço de Saque Pix ou Pix Troco. |
Updated about 5 hours ago