Only for indirect pix participants
Requisition
POST 'https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims/:claimId/cancel'
curl --request POST \
--url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims/6ab2d260-16db-4d7f-aac9-a91ba038f82d/cancel \
--header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '
{
"participationFlowType": "CLAIMANT",
"reason": "USER_REQUESTED"
}
'
Headers
Name | Description |
---|---|
x-delbank-api-key | Required. Required |
IdempotencyKey | Required. Request's idempotency key. Provide a GUID, being a new one for each request. |
Body
{
"participationFlowType": "CLAIMANT",
"reason": "USER_REQUESTED"
}
Name | Type | Description |
---|---|---|
participationFlowType | string | Required. Type of participation in the claiming process. Domains:DONOR CLAIMANT |
reason | enum | Required. Canceling reason. Domains:USER_REQUESTED ACCOUNT_CLOSURE FRAUD |
Response
The status 200
will indicate success in the transaction
Being successful, the return body will present the following fields in JSON format:
{
"id": "9bbe0b87-0242-4256-bd1f-44a827c0747a",
"status": "CANCELED",
"updatedAt": "2023-10-25T12:53:37.836Z",
"resolutionDeadline": "2023-11-01T03:58:00.000Z",
"cancellation": {
"reason": "USER_REQUESTED",
"source": "CLAIMANT"
}
}
Body
Name | Type | Description |
---|---|---|
id | string | Claiming Id |
status | enum | New claiming status. Domain:CANCELED |
resolutionDeadline | datetime | Resolution due date. UTC Format: yyyy-MM-ddTHH:mm:ss.fffZ |
updatedAt | datetime | Update time. vUTC Format: yyyy-MM-ddTHH:mm:ss.fffZ |
cancellation | object | Object containing information about the cancelation origin |
cancellation.reason | string | Cancelation Reason. Domain:USER_REQUESTED ACCOUNT_CLOSURE FRAUD |
cancellation.source | enum | Cancelation origin. Domains:CLAIMANT DONOR |
Possible mistakes
- Non-existent claiming id
{
"title": "Please refer to the errors property for additional details.",
"code": "CLAIM_NOT_FOUND",
"errors": [
"Reinvidicação não encontrada."
]
}
- Claiming not in GUID format
{
"title": "Please refer to the errors property for additional details.",
"code": "VALIDATION_ERROR",
"errors": [
"'ClaimId' Guid com formato inválido"
]
}
- Current claiming status blocking the cancellation
{
"title": "Please refer to the errors property for additional details.",
"code": "CLAIM_CANCELLATION_IS_NOT_ALLOWED",
"errors": [
"A situação da sua reivindicação não permite o seu cancelamento."
]
}