模拟可携性状态变更
Request
ENDPOINT
/mock/pix_keys/key_claim_simulation/CLAIM_REQUEST_KEY
/receive_response/CLAIM_ACTIONMÉTODO
PATCHPath params
| 字段 | 类型 | 描述 |
|---|---|---|
claim_request_key | uuidv4 | 可携性申请的唯一标识键。 |
claim_action | string | 枚举值 |
枚举值 claim_action
| 枚举值 | 说明 | 描述 |
|---|---|---|
| failed | 失败 | 可携性申请失败 |
| confirmed | 已确认 | 可携性申请已确认,需要捐赠银行的批准才能完成,或需要拒绝才能取消 |
| cancelled | 已取消 | 可携性申请已取消,因此要对该密钥提出申请,必须重新提交可携性申请 |
| concluded | 已完成 | 可携性申请已完成 |
Request Body
{}
Response
STATUS
204Response Body
{}
STATUS
4XXResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
| HTTP 代码 | QI 代码code | 标题title | 描述(英文)Description | 描述(葡萄牙语)translation |
|---|---|---|---|---|
| 404 | PIX000034 | Claim Request not found | Claim Request not found. claim_request_key: claim_request_key external_key: external_key. | Claim Request não encontrada. claim_request_key: claim_request_key external_key: external_key. |
| 400 | PIX000035 | Claim request action not allowed for donator | Claim request action not allowed for donator. Only claimant can perform this action | Ação sobre claim request não permitida para doador. Somente o reinvidicador pode executar esta ação |