Claiming confirmation

Request

POST 'https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims/:claimId/confirm'

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

Nome	Descrição
x-delbank-api-key	Obrigatório. API key
IdempotencyKey	Obrigatório. Request's idempotency key. Provide a GUID, being a new one for each request.

Body

{
    "reason": "USER_REQUESTED"
}

Name	Type	Description
reason	`enum`	Required. Cancelation reason. Domain: `USER_REQUESTED`

Response

The status code 200 will indicate success in the transaction.

Being well-succeeded, the return will have the following fields:

{
    "id": "8af69ad8-8d1b-41be-bf0b-8e641deb57bf",
    "status": "CONFIRMED",
    "updatedAt": "2023-11-08T03:54:24.235Z"
}

Body

Name	Type	Description
id	`string`	Claiming Id
status	`enum`	New claiming status. Domain: `CONFIRMED`
updatedAt	`datetime`	Update date. UTC Format: `yyyy-MM-ddTHH:mm:ss.fffZ`