Simular webhook de recebimento de um pedido de portabilidade

Request

ENDPOINT 

/mock/pix_keys/key_claim_simulation/receive

MÉTODO 

POST

Request Body

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

Body Params

Campo	Tipo	Descrição	Caracteres
pix_key	enum	chave para simular o recebimento de pedido de portabilidade.	-
pix_key_type	enum	tipo da chave pix da portabilidade.	Enumeradores

Enumeradores pix_key_type

Enumerador	Tradução
random_key	aleatória
email	e-mail
phone_number	número de telefone
cpf	cpf
cnpj	cnpj

Tipos de Chave Pix

A chave pix enviada no payload deve estar ativa no ambiente de sandbox e em uma conta que você tenha criado.

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": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) 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