模拟接收可携性申请 Webhook

Request

ENDPOINT

/mock/pix_keys/key_claim_simulation/receive

MÉTODO

POST

Request Body

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

Body Params

字段	类型	描述	字符数
`pix_key`	enum	用于模拟接收可携性申请的密钥。	-
`pix_key_type`	enum	可携性 Pix 密钥类型。	枚举值

枚举值 pix_key_type

枚举值	说明
random_key	随机密钥
email	电子邮件
phone_number	手机号
cpf	cpf
cnpj	cnpj

Pix 密钥类型

载荷中发送的 Pix 密钥必须在沙盒环境中处于激活状态，并且属于您创建的账户。

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 代码	QI 代码 `code`	标题 `title`	描述（英文） `Description`	描述（葡萄牙语） `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

Request​

Body Params​

枚举值 pix_key_type​

Response​

Request

Body Params

枚举值 pix_key_type

Response