Authorize Recurring Pix

This page will guide you through the authorization requests.

Answering authorization request journey 1

Used by journey 1

Request

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId'

Headers

Name	Description
Authorization	Required. API key
idempotencyKey	Required. Guid

Path Parameters:

Name	Type	Description
recurrenceId	string	Required. Authorization recurrenceId

Body

Name	Type	Description
AuthorizationResult	boolean	Required. Indicates whether the authorization was approved (true) or rejected (false)
PayerMaxAmount	number	Optional. Maximum amount authorized by the payer
RejectionReason	string	Optional. Reason for rejection (required if AuthorizationResult is false)

{
  "AuthorizationResult": true
}

Response

The status code 200 indicates success in the query.

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

{
 "recurrenceId": "RR3822485720251212i0jYqQr7g5n",
 "requestedAt": "2026-01-16T17:52:54.112"
}

Answering authorization request journey 2 and 4

Used by journey 2 and 4

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId'

Headers

Name	Description
Authorization	Required. API key
idempotencyKey	Required. Guid

Path Parameters:

Name	Type	Description
recurrenceId	string	Required. Authorization recurrenceId

Body

Name	Type	Description
journey	number	Required. Journey identifier (e.g., 2 or 4)
frequencyType	enum	Required. Frequency type. Domains: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY
recurrenceStartDate	string	Optional. Start date of the recurrence
recurrenceEndDate	string	Optional. End date of the recurrence
amount	number	Optional. Transaction amount
minPayerMaxAmount	number	Optional. Minimum allowed for payer's max amount
payerMaxAmount	number	Optional. Maximum amount authorized by the payer
beneficiary	object	Optional. Object containing all the info about the beneficiary
beneficiary.ispb	string	Required. ISPB code of the beneficiary
beneficiary.document	string	Required. Document of the beneficiary (CPF/CNPJ)
beneficiary.name	string	Required. Fullname of the beneficiary
beneficiary.agencyNumber	string	Optional. Beneficiary agency number
beneficiary.accountType	enum	Optional. Beneficiary account type. Domains: CURRENT, WAGE, SAVINGS, PAYMENT
beneficiary.accountNumber	string	Optional. Beneficiary account number
payer	object	Optional. Object containing all the info about the payer
payer.ispb	string	Required. ISPB code of the payer
payer.type	enum	Required. Type of the payer's document. Domains: NATURAL - Natural Person LEGAL - Legal Person
payer.document	string	Required. Document of the payer (CPF/CNPJ)
payer.name	string	Optional. Fullname of the payer
payer.agencyNumber	string	Optional. Payer agency number
payer.accountType	enum	Optional. Payer account type. Domains: CURRENT, WAGE, SAVINGS, PAYMENT
payer.accountNumber	string	Optional. Payer account number
payer.municipalityIbgeCode	number	Optional. Payer's municipality IBGE code
debtor	object	Optional. Object containing all the info about the debtor
debtor.type	enum	Required. Type of the debtor's document. Domains: NATURAL - Natural Person LEGAL - Legal Person
debtor.document	string	Required. Document of the debtor (CPF/CNPJ)
debtor.name	string	Required. Fullname of the debtor
contractNumber	string	Required. Contract number
contractDescription	string	Optional. Description of the contract
settlementConfirmedAt	string	Optional. Settlement confirmation date/time

{
  "journey": 2,
  "frequencyType": "MONTHLY",
  "recurrenceStartDate": "2025-06-29",
  "recurrenceEndDate": "2026-06-29",
  "amount": 150.75,
  "minPayerMaxAmount": 150.75,
  "payerMaxAmount": 500.00,
  "beneficiary": {
    "ispb": "38224857",
    "document": "12345678901",
    "name": "Fulano Ciclano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "31747"
  },
  "payer": {
    "ispb": "38224857",
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "12345",
    "municipalityIbgeCode": 3550308
  },
  "debtor": {
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano"
  },
  "contractNumber": "CONTRATO123",
  "contractDescription": "Assinatura Premium",
  "settlementConfirmedAt": "2025-06-15T12:05:00.000Z"
}

Response

The status code 200 indicates success in the query.

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

{
 "recurrenceId": "RR3822485720251212i0jYqQr7g5n",
 "requestedAt": "2026-01-16T17:52:54.112"
}