Skip to main content

Authorize recurring payment

This page will guide you through the authorization requests used by journey 1

Authorization request for recurring payment

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization'

Headers

NameDescription                            
AuthorizationRequired. API key
idempotencyKeyRequired. Guid

Body

{
"frequencyType": "MONTHLY",
"recurrenceStartDate": "2025-06-29",
"recurrenceEndDate": "2025-07-01",
"amount": 150.75,
"payer": {
"ispb": "38224857",
"type": "NATURAL",
"document": "07161543584",
"agencyNumber": "0001",
"accountNumber": "31747"
},
"beneficiary": {
"ispb": "38224857",
"document": "07161543584",
"name": "Matheus Santos Tavares"
},
"recurrenceCreatedAt": "2025-06-15T12:00:00.000Z",
"requestCreatedAt": "2025-06-15T12:05:00.000Z",
"requestExpiresAt": "2025-06-15T12:05:00.000Z",
"contractNumber": "CONTRATO123",
"contractDescription": "Assinatura Premium"
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"jdpiRequestId": "01000000-6b39-f007-983f-08ddc0911588",
"recurrenceId": "RR3822485720250711nDNIOOcVSOr",
"jdpiRequestDateTime": "2025-07-11T15:39:12.054Z"
}

Answering authorization request

Request

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization/:identifier'

Headers

NameDescription                            
AuthorizationRequired. API key
idempotencyKeyRequired. Guid

Path Parameters:

NameTypeDescription
identifierstringRequired. Authorization identifier

Body

{
"AuthorizationResult": true
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
"createdAt":"2024-06-13T10:10:05.025Z",
"id":"RR0435879820240605njua7shf40o"
}