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;
  • Quando a data especificada em conclusionLimitDate é atingida, seja por aprovação automática (DEFAULT_OPERATION) ou pela confirmação da doação pelo doador (USER_REQUEST), indicando que o reclamante pode iniciar a validação por TOTP para finalizar a reivindicação. Na primeira ativação, o status é alterado para WAITING_VALIDATION, indicando que está aguardando validação. As ativações ocorrem diariamente até que a reivindicação seja concluída ou cancelada, garantindo transparência quanto ao progresso.

📘

Nota

Após sete dias da abertura, quando a confirmação ocorrer automaticamente, o reivindicador ainda terá que esperar mais sete dias para concluir a reivindicação.

Pré-requisitos

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:

contextEventoDescrição
PixPIX_CASH_IN_WAS_RECEIVEDO valor foi recebido no core bancário Bankly.
PixPIX_CASH_IN_WAS_CLEAREDO valor foi liberado na conta destino.
PixPIX_REFUND_WAS_RECEIVEDO valor devolvido foi recebido no core bancário Bankly.
PixPIX_REFUND_WAS_CLEAREDO valor devolvido foi liberado na conta destino.
PixPIX_CASHOUT_WAS_COMPLETEDPagamento via Pix finalizado.
PixPIX_CASHOUT_WAS_CANCELEDA reserva de valor para a transação (hold) não foi concluída com sucesso, resultando no cancelamento da transação.
PixPIX_CASHOUT_WAS_UNDONEEmbora a reserva de valor para a transação (hold) tenha sido realizada com sucesso (o status do saldo foi modificado de 'available' para 'in-process'), a etapa de verificação antifraude resultou em reprovação, levando à reversão do status do saldo de 'in_process' para 'available' novamente.
PixPIX_QRCODE_WAS_CREATEDUm QR Code para pagamento via Pix foi emitido.
DictPIX_CLAIM_WAS_ACKNOWLEDGEDO pedido de reivindicação foi reconhecido.
DictPIX_CLAIM_WAS_CONFIRMEDO pedido de reivindicação foi confirmado.
DictPIX_CLAIM_WAS_COMPLETEDO processo de reivindicação foi concluído.
DictPIX_CLAIM_WAS_CANCELEDO processo de reivindicação foi cancelado.
DictPIX_CLAIM_WAS_REGISTEREDUm cliente do parceiro Bankly registrou um pedido de reivindicação de posse/portabilidade para outra instituição.
DictPIX_CONCLUSION_DATE_WAS_COMPLETEDO reivindicador está apto a realizar a validação de posse (TOTP) e concluir a reivindicação.

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:

📘

Nota

Se a reserva de valor para a transação (hold) for realizada com sucesso (o saldo foi atualizado para o status in-process), e a etapa de verificação antifraude for aprovada, mas ocorrer uma falha durante o processo, a transação será cancelada e o saldo retornará ao status "available" novamente. Neste cenário, o parceiro receberá dois eventos: PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE.

Identificador (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:

EventoIdentificador (entityId)Descrição
PIX_CASH_IN_WAS_RECEIVEDauthenticationCodeIdentificador único da transação
PIX_CASH_IN_WAS_CLEAREDauthenticationCodeIdentificador único da transação
PIX_REFUND_WAS_RECEIVEDauthenticationCodeIdentificador único da transação
PIX_REFUND_WAS_CLEAREDauthenticationCodeIdentificador único da transação
PIX_CASHOUT_WAS_COMPLETEDauthenticationCodeIdentificador único da transação
PIX_CASHOUT_WAS_CANCELEDauthenticationCodeIdentificador único da transação
PIX_CASHOUT_WAS_UNDONEauthenticationCodeIdentificador único da transação
PIX_QRCODE_WAS_CREATEDaddressingKey.valueValor da chave de endereçamento.
PIX_CLAIM_WAS_ACKNOWLEDGEDclaimIdIdentificação única de pedido de portabilidade ou posse.
PIX_CLAIM_WAS_CONFIRMEDclaimIdIdentificação única de pedido de portabilidade ou posse.
PIX_CLAIM_WAS_COMPLETEDclaimIdIdentificação única de pedido de portabilidade ou posse.
PIX_CLAIM_WAS_CANCELEDclaimIdIdentificação única de pedido de portabilidade ou posse.
PIX_CLAIM_WAS_REGISTEREDclaimIdIdentificação única de pedido de portabilidade ou posse.
PIX_CONCLUSION_DATE_WAS_COMPLETEDclaimIdIdentificaçã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

O 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:

NomeTipoDescrição
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento. Objeto não retornado em caso de Pix manual.
addressingKey.valuestringValor da chave.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE, EMAIL e EVP.
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
recipientobjectObjeto que contém informações sobre o recebedor da transação.
recipient.documentobjectObjeto que contém informações sobre o documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento do recebedor da transação (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor, o qual pode ser “Business” ou “Customer”.
recipient.namestringNome do recebedor da transação. Campo não retornado em caso de Pix por chave e por QR Code.
recipient.accountobjectObjeto que contém informações sobre a conta do recebedor da transação.
recipient.account.branchstringNúmero da agência.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
recipient.account.bankobjectObjeto que contém informações sobre o banco do recebedor da transação.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco recebedor da transação.
recipient.account.bank.codestringCódigo do banco. Campo não retornado em caso de Pix por chave e por QR Code.
recipient.account.bank.namestringNome do banco. Campo não retornado em caso de Pix por chave e por QR Code.
channelobjectObjeto que contém informações sobre o canal de pagamento.
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.senderobjectObjeto que contém informações sobre o pagador da transação.
channel.sender.documentobjectObjeto que contém informações sobre o documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento do pagador da transação (CPF ou CNPJ).
channel.sender.typestringTipo de cliente pagador, o qual pode ser “Business” ou “Customer”.
channel.sender.namestringNome de registro do pagador da transação, conforme consta no cadastro da conta.
Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
channel.sender.accountobjectObjeto que contém informações sobre a conta do pagador da transação.
channel.sender.account.branchstringNúmero da agência.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.sender.account.bankobjectObjeto que contém informações sobre o banco pagador da transação.
channel.sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
channel.sender.account.bank.namestringNome do banco. Campo não retornado em caso de Pix por chave e por QR Code.
channel.end2EndIdstringIdentificador único da transação Pix.
channel.receiverReconciliationIdstringID de conciliação utilizado para conciliação dos pagamentos. Campo não retornado em caso de Pix por chave e manual.
channel.pixInitializationTypestringModo pelo qual a transação ocorreu: "Key" (chave de endereçamento), "StaticQrCode" ou "DynamicQrCode" (QR Code) e "Manual”.
channel.pixPaymentPrioritystringPrioridade de pagamento, que pode ser “Priority” e “NonPriority”.
channel.pixPaymentPriorityTypestringTipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”.
channel.pixPaymentPurposestringPropósito do pagamento, que pode ser "PurchaseOrTransfer" e "Payment".
createdAtstringData de criação da transação, no formato ISO 8601 - UTC.

📘

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"
			},
      "description": "pagamento",
			"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"
			},
      "description": "pagamento",
			"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"
			},
      "description": "pagamento",
			"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"
			},
      "description": "pagamento",
			"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

O 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:

NomeTipoDescrição
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
recipientobjectObjeto que contém informações sobre o recebedor da transação.
recipient.documentobjectObjeto que contém informações sobre o documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento do recebedor da transação (CPF ou CNPJ).
recipient.namestringNome do recebedor da transação. Campo não retornado em caso de Pix por chave e por QR Code.
recipient.statusstringSituação do cadastro do recebedor, que pode ser PENDING_APPROVAL, APPROVED, REPROVED e BLACKLISTED.
recipient.accountobjectObjeto que contém informações sobre a conta do recebedor da transação.
recipient.account.branchstringNúmero da agência.
recipient.account.numberstringNúmero da conta.
recipient.account.statusstringStatus da conta do recebedor, que pode ser ACTIVE ou CLOSED.
recipient.account.bankobjectObjeto que contém os dados do banco do recebedor da transação.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco recebedor da transação.
channelobjectObjeto que contém informações sobre o canal de pagamento.
channel.end2EndIdstringIdentificador único da transação Pix.
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.senderobjectObjeto que contém informações sobre o pagador da transação.
channel.sender.documentobjectObjeto que contém informações sobre o documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento do pagador da transação (CPF ou CNPJ).
channel.sender.namestringNome de registro do pagador da transação, conforme consta no cadastro da conta.
Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
channel.sender.statusstringSituação do cadastro do pagador, que pode ser PENDING_APPROVAL, APPROVED, REPROVED e BLACKLISTED.
channel.sender.accountobjectObjeto que contém informações sobre a conta do pagador da transação.
channel.sender.account.branchstringNúmero da agência.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.sender.account.bankobjectObjeto que contém informações sobre o banco pagador da transação.
channel.sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
channel.sender.account.bank.codestringCódigo do banco.
channel.sender.account.bank.namestringNome do banco. Campo não retornado em caso de Pix por chave e por QR Code.
receiverReconciliationIdstringID de conciliação utilizado para conciliação dos pagamentos.
pixInitializationTypestringModo pelo qual a transação ocorreu: "Key" (chave de endereçamento), "StaticQrCode" ou "DynamicQrCode" (QR Code) e "Manual”.
pixPaymentPrioritystringPrioridade de pagamento, que pode ser “Priority” e “NonPriority”.
pixPaymentPriorityTypestringTipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”.
pixPaymentPurposestringPropósito do pagamento, que pode ser "PurchaseOrTransfer" e "Payment".

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"
         },
        "description": "pagamento",
         "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": "Key",
         "pixPaymentPriority": "Priority",
         "pixPaymentPriorityType": "ScheduledPayment",
         "pixPaymentPurpose": "PurchaseOrTransfer"
      }
 }

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

O 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:

NomeTipoDescrição
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo opcional que permite adicionar uma descrição para a devolução.
recipientobjectObjeto que contém informações sobre o recebedor da transação.
recipient.documentobjectObjeto que contém informações sobre o documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento do recebedor da transação (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor, o qual pode ser “Business” ou “Customer”.
recipient.accountobjectObjeto que contém informações sobre a conta do recebedor da transação.
recipient.account.branchstringNúmero da agência.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
recipient.account.bankobjectObjeto que contém informações sobre o banco do recebedor da transação.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco recebedor da transação.
channelobjectObjeto que contém informações sobre o canal de pagamento.
channel.end2EndIdOriginalstringEndToEndId da transação de Pix cash-out inicial.
channel.refundReasonstringCampo opcional que permite descrever o motivo da devolução.
channel.errorCodestringCódigo da devolução.
channel.errorReasonstringRazão da devolução (descrita anteriormente).
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.senderobjectObjeto que contém informações sobre o pagador da transação.
channel.sender.documentobjectObjeto que contém informações sobre o documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento do pagador da transação (CPF ou CNPJ).
channel.sender.typeTipo de cliente pagador, que pode ser “Customer” ou “Business”.
channel.sender.namestringNome de registro do pagador da transação, conforme consta no cadastro da conta.
Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
channel.sender.accountobjectObjeto que contém informações sobre a conta do pagador da transação.
channel.sender.account.branchstringNúmero da agência.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.sender.account.bankobjectObjeto que contém informações sobre o banco pagador da transação.
channel.sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
channel.end2EndIdstringIdentificador único da transação Pix.
createdAtstringData da devolução, no formato ISO 8601 - UTC.

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"
         },
        "description": "pagamento", 
         "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

O 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:

NomeTipoDescrição
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo opcional que permite adicionar uma descrição para a devolução.
recipientobjectObjeto que contém informações sobre o recebedor da transação.
recipient.documentobjectObjeto que contém informações sobre o documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento do recebedor da transação (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor, que pode ser “Customer” ou “Business”.
recipient.accountobjectObjeto que contém os dados da conta do recebedor.
recipient.account.branchstringNúmero da agência.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
recipient.account.bankobjectObjeto que contém os dados do banco do recebedor da transação.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channelobjectObjeto que contém informações sobre o canal de pagamento.
channel.end2EndIdOriginalstringEndToEndId da transação de Pix cash-out inicial.
channel.refundReasonstringCampo opcional que permite descrever o motivo da devolução.
channel.errorCodestringCódigo da devolução.
channel.errorReasonstringRazão da devolução (descrita anteriormente).
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.senderobjectObjeto que contém informações sobre o pagador da transação.
channel.sender.documentobjectObjeto que contém informações sobre o documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento do pagador da transação (CPF ou CNPJ).
channel.sender.typeTipo de cliente pagador, que pode ser “Customer” ou “Business”.
channel.sender.namestringNome de registro do pagador da transação, conforme consta no cadastro da conta.
Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
channel.sender.accountobjectObjeto que contém informações sobre a conta do pagador da transação.
channel.sender.account.branchstringNúmero da agência.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.sender.account.bankobjectObjeto que contém informações sobre o banco pagador da transação.
channel.sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
channel.end2EndIdstringIdentificador único da transação Pix.
createdAtstringData da devolução, no formato ISO 8601 - UTC.

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"
         },
         "description": "pagamento",
         "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

O 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:

NomeTipoDescrição
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
decriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
senderobjectObjeto que contém os dados do pagador da transação.
sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento do pagador (CPF ou CNPJ).
sender.typestringTipo de pagador, que pode ser “Customer” ou Business”.
sender.namestringNome do pagador da transação.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringNúmero da agência.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
sender.account.bankobjectObjeto que contém os dados do banco do pagador da transação.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
channelobjectObjeto que contém os dados do canal de pagamento.
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.destinationobjectObjeto que contém os dados do destinatário da transação.
channel.destination.documentobjectObjeto que contém os dados do documento do destinatário da transação.
channel.destination.document.valuestringNúmero do documento do destinatário.
channel.destination.document.typestringTipo de documento do destinatário (CPF ou CNPJ).
channel.destination.typeTipo de destinatário, que pode ser “Customer” ou Business”.
channel.destination.namestringNome do destinatário da transação.
channel.destination.accountobjectObjeto que contém os dados da conta do destinatário.
channel.destination.account.branchstringNúmero da agência.
channel.destination.account.numberstringNúmero da conta.
channel.destination.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.destination.account.bankobjectObjeto que contém os dados do banco do destinatário da transação.
channel.destination.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.destination.account.bank.codestringCódigo do banco.
channel.destination.account.bank.namestringNome do banco.
channel.endToEndIdstringIdentificador único da transação Pix.
channel.initializationTypestringModo pelo qual a transação ocorreu: "Key" (chave de endereçamento), "StaticQrCode" ou "DynamicQrCode" (QR Code) e "Manual”.
channel.paymentPurposestringPropósito do pagamento, que pode ser "PurchaseOrTransfer" e "Payment".
channel.paymentPrioritystringPrioridade de pagamento, que pode ser “Priority” e “NonPriority”.
channel.paymentPriorityTypestringTipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”.
channel.isPixOpenBankingbooleanIndica se faz parte de uma transação do ecossistema Open Banking.
channel.isInternalbooleanIndica se é uma transação interna.
paymentDatestringData do pagamento, no formato ISO 8601 - UTC.
isRefundbooleanIndica 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": "pagamento",
         "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 reserva de valor para a transação (hold) não ocorreu com sucesso. Portanto, não houve saída de valor da conta pagadora e a transação foi cancelada.

Descrição do objeto data do evento

O 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:

NomeTipoDescrição
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
senderobjectObjeto que contém os dados do pagador da transação.
sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.namestringNome do pagador da transação.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringNúmero da agência.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
sender.account.bankobjectObjeto que contém os dados do banco do pagador da transação.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
channelobjectObjeto que contém os dados do canal de pagamento.
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.destinationobjectObjeto que contém os dados do destinatário da transação.
channel.destination.documentobjectObjeto que contém os dados do documento do destinatário da transação.
channel.destination.document.valuestringNúmero do documento do destinatário.
channel.destination.document.typestringTipo de documento do destinatário (CPF ou CNPJ).
channel.destination.namestringNome do destinatário da transação.
channel.destination.accountobjectObjeto que contém os dados da conta do destinatário.
channel.destination.account.branchstringNúmero da agência.
channel.destination.account.numberstringNúmero da conta.
channel.destination.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.destination.account.bankobjectObjeto que contém os dados do banco do destinatário da transação.
channel.destination.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.destination.account.bank.codestringCódigo do banco.
channel.destination.account.bank.namestringNome do banco.
channel.initializationTypestringModo pelo qual a transação ocorreu: "Key" (chave de endereçamento), "StaticQrCode" ou "DynamicQrCode" (QR Code) e "Manual”.
channel.paymentPurposestringPropósito do pagamento, que pode ser "PurchaseOrTransfer" e "Payment".
channel.paymentPrioritystringPrioridade de pagamento, que pode ser “Priority” e “NonPriority”.
channel.paymentPriorityTypestringTipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”.
channel.isPixOpenBankingbooleanIndica se faz parte de uma transação do ecossistema Open Banking.
channel.isInternalbooleanIndica se é uma transação interna.
channel.refusalReasonstringRazão pela qual o pagamento foi cancelado. Confira a lista com os possíveis motivos de reprovação no final da página.
paymentDatestringData do pagamento, no formato ISO 8601 - UTC.
isRefundbooleanIndica 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 reserva de valor para a transação (hold) ocorreu com sucesso. Porém, houve reprovação no processo de antifraude transacional. Portanto, o valor será devolvido para a conta pagadora.

Descrição do objeto data do evento

O 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:

NomeTipoDescrição
authenticationCodestringIdentificador único da transação, no formato GUID v4.
amountobjectObjeto que contém informações sobre a transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação (máximo de 140 caracteres). Essas informações poderão ser visualizadas pelo destinatário da transferência.
senderobjectObjeto que contém os dados do pagador da transação.
sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.namestringNome do pagador da transação.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringNúmero da agência.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta-salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
sender.account.bankobjectObjeto que contém os dados do banco do pagador da transação.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
channelobjectObjeto que contém os dados do canal de pagamento.
channel.namestringNome do canal de pagamento que, no caso do Pix, é SPI.
channel.destinationobjectObjeto que contém os dados do destinatário da transação.
channel.destination.documentobjectObjeto que contém os dados do documento do destinatário da transação.
channel.destination.document.valuestringNúmero do documento do destinatário.
channel.destination.document.typestringTipo de documento do destinatário (CPF ou CNPJ).
channel.destination.namestringNome do destinatário.
channel.destination.accountobjectObjeto que contém os dados da conta do destinatário.
channel.destination.account.branchstringNúmero da agência.
channel.destination.account.numberstringNúmero da conta.
channel.destination.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
channel.destination.account.bankobjectObjeto que contém os dados do banco do destinatário da transação.
channel.destination.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.destination.account.bank.codestringCódigo do banco.
channel.destination.account.bank.namestringNome do banco.
channel.initializationTypestringModo pelo qual a transação ocorreu: "Key" (chave de endereçamento), "StaticQrCode" ou "DynamicQrCode" (QR Code) e "Manual”.
channel.paymentPurposestringPropósito do pagamento, que pode ser "PurchaseOrTransfer" e "Payment".
channel.paymentPrioritystringPrioridade de pagamento, que pode ser “Priority” e “NonPriority”.
channel.paymentPriorityTypestringTipo de prioridade de pagamento, que pode ser “Priority”, “AntifraudAnalysis” e “ScheduledPayment”.
channel.isPixOpenBankingbooleanIndica se faz parte de uma transação do ecossistema Open Banking.
channel.isInternalbooleanIndica se é uma transação interna.
channel.refusalReasonstringRazão pela qual o pagamento foi desfeito. Confira a lista com os possíveis motivos de reprovação no final da página.
paymentDatestringData do pagamento, no formato ISO 8601 - UTC.
isRefundbooleanIndica 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": 1724854631
      },
      "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

O 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:

NomeTipoDescrição
partnerKeystringChave que identifica o parceiro dentro do Bankly.
conciliationIdstringID de conciliação utilizado para conciliação dos pagamentos.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.valuestringValor da chave.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE, EMAIL e EVP.
amountnumberValor do QR Code gerado.
singlePaymentbooleanIndica se é um QR Code de pagamento único.
typestringTipo de QR Code, que pode ser STATIC ou DYNAMIC.
purposestringPropósito do pagamento, que pode ser PURCHASE_OR_TRANSFER, CHANGE_AMOUNT, WITHDRAWAL, PAYMENT e BILLING.
encodedValuestringCódigo copia e cola, em formato base64, que contém todas as informações sobre o pagamento.
changeAmountTypestringIndica se o valor do QR Code pode ou não ser alterado (ALLOWED ou NOT_ALLOWED).
formatstringFormato de geração do QR Code (BASE64_IMAGE ou ENCODED_PAYLOAD).
createdAtstringData de criação do QR Code, no formato ISO 8601 - UTC.
expiresAtstringData de expiração do QR Code, no formato ISO 8601 - UTC. Válido apenas para QR Codes dinâmicos.
paymentDateLimitstringData limite para pagamento do QR Code, no formato ISO 8601 - UTC. Válido apenas para QR Codes dinâmicos.
recipientobjectObjeto que contém os dados do recebedor da transação (emissor do QR Code).
recipient.typestringTipo de cliente recebedor (CUSTOMER ou BUSINESS).
recipient.documentNumberstringNúmero do documento do recebedor.
recipient.namestringNome 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

O 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:

NomeTipoDescrição
claimIdstringIdentificação única de pedido de portabilidade ou posse.
typestringTipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE e EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claime.branchstringNúmero da agência bancária.
claime.numberstringNúmero da conta.
claimer.bankobjectObjeto que contém informações sobre o banco do reivindicador.
claime.bank.namestringNome da instituição de pagamento.
claime.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador.
donor.branchstringNúmero da agência bancária.
donor.numberstringNúmero da conta.
donor.bankobjectObjeto que contém informações sobre o banco do doador.
donor.bank.namestringNome da instituição de pagamento.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse.
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de reivindicação de posse.

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": "1",
      "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

O 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:

NomeTipoDescrição
claimIdstringIdentificação única de pedido de portabilidade ou posse.
typestringTipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE e EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claimer.branchstringNúmero da agência bancária.
claimer.numberstringNúmero da conta.
claimer.bankobjectObjeto que contém informações sobre o banco do reivindicador.
claimer.bank.namestringNome da instituição de pagamento.
claimer.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador.
donor.branchstringNúmero da agência bancária.
donor.numberstringNúmero da conta.
donor.bankobjectObjeto que contém informações sobre o banco do doador.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse.
confirmReasonstringMotivo 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).
confirmedBystringPessoa que confirmou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para posse).
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de reivindicação de posse.
confirmedAtstringData 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": "1",
      "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

O 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:

NomeTipoDescrição
claimIdstringIdentificação única de pedido de portabilidade ou posse.
typestringTipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE e EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claimer.branchstringNúmero da agência bancária.
claimer.numberstringNúmero da conta.
claimer.bankobjectObjeto que contém os dados do banco do reivindicador.
claimer.bank.namestringNome da instituição de pagamento.
claimer.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador.
donor.branchstringNúmero da agência bancária.
donor.numberstringNúmero da conta.
donor.bankobjectObjeto que contém os dados do banco do doador.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse.
confirmReasonstringMotivo 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).
confirmedBystringPessoa que confirmou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para posse).
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de reivindicação de posse.
confirmedAtstringData de confirmação do pedido.
completedAtstringData 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": "1",
      "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

O 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:

NomeTipoDescrição
claimIdstringIdentificação única de pedido de portabilidade ou posse.
typestringTipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE e EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claime.branchstringNúmero da agência bancária.
claime.numberstringNúmero da conta.
claime.bankobjectObjeto que contém os dados do banco do reivindicador.
claime.bank.namestringNome da instituição de pagamento.
claime.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador. Importante: caso o cancelamento seja por fraude, os campos referentes a este objeto não virão preenchidos.
donor.branchstringNúmero da agência bancária.
donor.numberstringNúmero da conta.
donor.bankobjectObjeto que contém os dados do banco do doador.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse.
cancelReasonstringMotivo 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).
confirmReasonstringMotivo 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.
canceledBystringPessoa que cancelou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (Reivindicador), “DONOR” (Doador) ou “SYSTEM” (Sistema - somente para portabilidade).
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de reivindicação de posse.
canceledAtstringData 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": "1",
      "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

O 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:

NomeTipoDescrição
claimIdstringIdentificação única de pedido de portabilidade ou posse.
typestringTipo de pedido, que pode ser "PORTABILITY", para portabilidade, e "OWNERSHIP", para posse.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser: CPF, CNPJ, PHONE e EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claimer.branchstringNúmero da agência bancária.
claimer.numberstringNúmero da conta.
claimer.bankobjectObjeto 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.namestringNome da instituição de pagamento.
claimer.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador.
donor.branchstringNúmero da agência bancária.
donor.numberstringNúmero da conta.
donor.bankobjectObjeto que contém os dados do banco do doador.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse.
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: ISO 8601 - UTC. A data e a hora desse campo devem ser consideradas apenas em casos de reivindicação de posse.

🚧

Importante

As propriedades do objetodonornã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": "1",
      "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"
      }
 }

PIX_CONCLUSION_DATE_WAS_COMPLETED

Esse evento indica o momento a partir do qual o reivindicador está apto a realizar a validação de posse (TOTP) e concluir a reivindicação.

Descrição do objeto data do evento

O 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:

NomeTipoDescrição
claimIdstringIdentificação única do pedido de posse. Importante: utilize este valor em todas as operações relacionadas a esta reivindicação, como consulta ou cancelamento.
typestringTipo de reivindicação, o qual, neste caso, sempre será OWNERSHIP.
addressingKeyobjectObjeto que contém informações sobre a chave de endereçamento.
addressingKey.typestringTipo de chave, o qual pode ser PHONE ou EMAIL.
addressingKey.valuestringValor da chave.
claimerobjectObjeto que contém os dados da conta do reivindicador.
claimer.branchstringNúmero da agência bancária.
claimer.numberstringNúmero da conta.
claimer.bankobjectObjeto que contém informações sobre o banco do reivindicador.
claimer.bank.namestringNome da instituição de pagamento.
claimer.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
donorobjectObjeto que contém os dados da conta do doador.
donor.bankobjectObjeto que contém informações sobre o banco do doador.
donor.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
statusstringSituação atual do pedido. Consulte a tabela dos possíveis status do pedido de portabilidade ou posse no final da página.
confirmReasonstringMotivo 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).
confirmedBystringPessoa que confirmou o pedido de portabilidade ou posse, a qual pode ser “CLAIMER” (reivindicador), “DONOR” (doador) ou “SYSTEM” (sistema - somente para posse).
createdAtstringData de criação do pedido.
updatedAtstringData da última atualização do pedido.
resolutionLimitDatestringData limite para o doador de portabilidade realizar ações, como concluir ou cancelar o processo de portabilidade. Formato: ISO 8601 - UTC. Importante: A data e a hora deste campo devem ser consideradas apenas em casos de portabilidade de chaves.
conclusionLimitDatestringData limite para o doador de posse validar a posse da chave objeto da reivindicação. Formato: ISO 8601 - UTC. Importante: A data e a hora deste campo devem ser consideradas apenas em casos de reivindicação de posse.
confirmedAtstringData de confirmação do pedido.
Exemplo de payload
{
	"entityId": "7df083fb-4527-4dff-9f6a-c9e80fc2f79e",
	"companyKey": "ED_FLORESTA",
	"context": "Dict",
	"name": "PIX_CONCLUSION_DATE_WAS_COMPLETED",
	"timestamp": "2024-03-13T14:39:56.593686Z",
	"correlationId": "7df083fb-4527-4dff-9f6a-c9e80fc2f79e",
	"metadata": {
		"RequestedAt": "2024-04-25T14:43:13.408Z",
		"ResponseAt": "1970-01-01T00:00:00.000Z"
	},
	"data": {
		"claimId": "7df083fb-4527-4dff-9f6a-c9e80fc2f79e",
		"type": "OWNERSHIP",
		"licenseId": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
		"addressingKey": {
			"type": "EMAIL",
			"value": "[email protected]"
		},
		"claimer": {
			"branch": "2020",
			"number": "502000027888",
			"bank": {
				"ispb": "15616000"
			}
		},
		"donor": {
			"bank": {
				"name": "Acesso Solucoes de Pagamentos SA",
				"ispb": "13140088"
			}
		},
		"status": "WAITING_VALIDATION",
		"previousStatus": "CONFIRMED",
		"confirmReason": "DONOR_REQUEST",
		"confirmedBy": "DONOR",
		"createdAt": "2024-03-13T14:25:23.612+00:00",
		"updatedAt": "2024-03-13T14:39:56.593686Z",
		"resolutionLimitDate": "2024-03-20T14:21:00+00:00",
		"conclusionLimitDate": "2024-03-13T14:34:10.207",
		"confirmedAt": "2024-03-13T14:39:56.49342Z"
	},
	"version": "1",
	"licenseUuid": "70141cc1-03aa-484e-a3be-ee63c56fb9b7"
}

Código de devolução do pagamento

CódigoDescrição
BE08Devolução de pagamento instantâneo devido a erro do PSP.
FR01Devolução de pagamento motivada por fundada suspeita de fraude.
MD06Devolução de pagamento instantâneo solicitada pelo usuário recebedor pagamento original.
SL02Devolução motivada por um erro relacionado ao saque Pix.

Possíveis status do pedido de portabilidade ou posse

StatusDescrição
OPENSolicitação aberta pelo reivindicador, mas ainda não recebida pelo doador.
WAITING_RESOLUTIONA reivindicação já foi recebida pelo doador e está aguardando a resolução.
CONFIRMEDO 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.
WATING_VALIDATIONApós a confirmação, indica-se que o ConclusionLimitDate foi atingido. A partir deste momento, a reivindicação passa a ter o status de WAITING_VALIDATION, permitindo ao reivindicador realizar a validação de posse (TOTP) e concluir a reivindicação. Isso é aplicável apenas para reivindicações de posse (OWNERSHIP).
CANCELEDO 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.
COMPLETEDO pedido de portabilidade ou posse foi completado com sucesso e que chave foi transferida para o Bankly.

Motivos de reprovação

Reprovação por pagamento rejeitado pelo PSP do recebedor

CódigoDescrição
AB03Pagamento expirado por timeout.
AB09Transação interrompida devido a erro no participante do usuário recebedor.
AB11Tempo de processamento no participante pagador superior ao timeout de 34 segundos
AC03Número da agência e/ou conta transacional do usuário recebedor inexistente ou inválido.
AC06A conta transacional especificada encontra-se bloqueada.
AC07Número da conta transacional encerrada no PSP do Recebedor.
AC14Tipo incorreto para a conta transacional especificada. Exemplo: transferência para conta salário.
AG03O tipo de transação não é suportado/autorizado na conta transacional especificada. Ex.: transferência para conta salário.
AM02Ordem de pagamento/devolução em valor superou o limite permitido para o tipo de conta transacional creditada.
AM09Devolução de pagamento em valor superou o valor da ordem de pagamento instantâneo correspondente.
BE01CPF/CNPJ do usuário recebedor não é consistente com o titular da conta transacional especificada.
BE17QR Code rejeitado pelo participante do usuário recebedor.
CH11CPF/CNPJ do usuário recebedor incorreto.
CH16Não é possível enviar Pix para uma conta salário.
DS04Ordem rejeitada pelo PSP do Recebedor.
DS24Ordem 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.
DS27ISPB do participante recebedor inexistente.
DT02Data/hora de recebimento pelo participante maior que data/hora de envio pelo participante.
DT05A transação extrapolou o prazo máximo para devolução de pagamento instantâneo regulamentado pelo arranjo Pix.
ED05Erro no processamento do pagamento.
RR04Ordem 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.
SL02A transação original não está relacionada ao serviço de Saque Pix ou Pix Troco.

Reprovação no fluxo Bankly

CódigoDescrição
TRANSFER_AMOUNT_NOT_RESERVEDO valor para transferência via Pix não pôde ser reservado.
ORDER_NOT_FOUNDA ordem não foi encontrada no JDPI ou no SPI.
INTERNAL_TRANSFER_NOT_COMPLETEDTransferência interna Pix não concluída.
TRANSFER_WAS_REPROVED_BY_QRCODEA transferência via Pix foi reprovada por regras de QR Code.
TRANSFER_ORDER_NOT_PROCESSEDA ordem de transferência via Pix não pôde ser processada.
TRANSFER_WAS_REPROVEDTransferência via Pix reprovada.
Erro no processamento do SPIO ISPB contido no identificador da ordem de pagamento está diferente do ISPB do debitado ou pagador.
Erro no processamento do SPIA data/hora presente no identificador da ordem de pagamento é anterior a 24 horas.