Simulating the Receipt Webhook for a Portability Request

Request

ENDPOINT 

/mock/pix_keys/key_claim_simulation/receive

MÉTODO 

POST

Request Body

{
  "pix_key": "12345678000190",
  "pix_key_type": "cnpj"
}

Body Params

Field	Type	Description	Characters
pix_key	enum	key to simulate the receipt of a portability request.	-
pix_key_type	enum	type of the pix key for portability.	Enumerators

Enumerators pix_key_type

Enumerator	Translation
random_key	random
email	email
phone_number	phone number
cpf	cpf
cnpj	cnpj

Pix Key Types

The pix key sent in the payload must be active in the sandbox environment and in an account you have created.

Response

STATUS

201

Response Body

{}

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description Description	Translation translation
400	PIX000072	Pix Key Claim Non Finished	Pix key 12345678000190, already has a claim request non finished.	Chave pix 12345678000190, já possui um pedido de portabilidade não finalizado.
400	PIX000026	Account not found	Account not found for account_key: 6aaadfbc-76ba-45d2-bb21-138bcb2baa62	Conta não encontrada para account_key: 6aaadfbc-76ba-45d2-bb21-138bcb2baa62