Cancel Authorization
Cancelling an authorization
Use this endpoint to cancel an Automatic Pix authorization
Request
POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:cancellationIdentifier/cancellations'
Headers
| Name | Description |
|---|---|
| Authorization | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| cancellationIdentifier | string | Required. Cancelation identifier |
Body Attributes
| Name | Type | Description |
|---|---|---|
| cancellationReason | enum | The reason for the cancellation. See the table below for valid options. |
Cancellation Reasons
Below is a list of cancellation reason options and their meaning. They must be sent as a string in the cancellationReason field.
| Reason | Description |
|---|---|
ACCOUNT_CLOSED | Payer or beneficiary account was closed |
COMPANY_CLOSED | Receiving company was closed |
PAYER_DECEASED | Payer passed away |
REQUEST_ERROR_BY_RECEIVER | Error in the request by the beneficiary or participant |
FRAUD_SUSPECTED | Suspicion of fraud |
DUPLICATE_CONFIRMATION | Confirmation was duplicated (e.g., QR Code) |
REQUESTED_BY_PAYEE | Requested by the beneficiary |
REQUESTED_BY_PAYER | Requested by the payer |
NO_RESPONSE_TO_PAIN009 | No response to pain.009 within the regulatory deadline |
Body
{
"cancellationReason": "REQUESTED_BY_PAYEE"
}
Response
The status code 200 indicates success in the query.
Cancellation Reasons
Below is a list of cancellation reason options and their meaning that can be returned in the CancellationReason field.
| Reason | Description |
|---|---|
ACCOUNT_CLOSED | Payer or beneficiary account was closed |
COMPANY_CLOSED | Receiving company was closed |
PAYER_DECEASED | Payer passed away |
REQUEST_ERROR_BY_RECEIVER | Error in the request by the beneficiary or participant |
FRAUD_SUSPECTED | Suspicion of fraud |
DUPLICATE_CONFIRMATION | Confirmation was duplicated (e.g., QR Code) |
REQUESTED_BY_PAYEE | Requested by the beneficiary |
REQUESTED_BY_PAYER | Requested by the payer |
NO_RESPONSE_TO_PAIN009 | No response to pain.009 within the regulatory deadline |
Cancellation Status
Below is a list of status options that can be returned in the CancellationStatus field.
| Status | Description |
|---|---|
ACCEPTED | Cancellation accepted |
REJECTED | Cancellation rejected |
Being succeeded, the return will have the following fields in Json format:
{
"recurrenceId": "RR3822485720251212i0jYqQr7g5n",
"requestedAt": "2026-01-16T17:52:54.112"
}
Fetch cancelled authorization
This endpoint will fetch a cancelled authorization
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId/cancellations/:cancellationId'
Headers
| Name | Description |
|---|---|
| Authorization | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| recurrenceId | string | Required. Authorization identifier |
| cancellationId | string | Required. Cancelation identifier |
Response
The status code 200 indicates success in the query.
Being succeeded, the return will have the following fields in Json format:
{
"RecurrenceId": "RR0435879820240605njua7shf40o",
"CancellationId": "IC0435879820240605bcdb1fhn43a",
"StatusDateTime": "2024-09-17T10:15:00.000Z",
"RequesterPersonType": "NATURAL",
"RequesterDocument": "77379362038",
"CancellationReason": "FRAUD_SUSPECTED",
"CancellationAt": "2024-09-17T10:10:06.101Z",
"CancellationStatus": "ACCEPTED",
"ErrorCode": null,
"ErrorDescription": null
}