Accept/reject recurrence authorization

Pix Automatic payee recurrence payment authorization acceptance or rejection

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

BACEN recurrence ID

string
enum
required

Authorization status

Allowed:
string
enum

Rejected authorizations reason code

  • AP13 - Paying user rejects recurrence confirmation for periodic payments due to receiving user not recognized
  • AP14 - Paying user rejects recurrence confirmation for periodic payments due to receiving user not interested in using Automatic Pix
Allowed:
number

Payer-defined maximum payment amount for dynamic amount recurrences.

string
enum

Recurrence payment type: AUT1 - Bank notification. If the merchant has the payer's banking information, a push notification can be sent directly to the payer's bank app, prompting them to authorize the recurring payment.

AUT2 - Authorization via QR code. Payer scans a merchant provided QR code to authorize recurring payments. This method does not initiate an immediate payment, allowing the first payment to be scheduled for a later date.

AUT3 - Authorization via QR code with first payment. Similar to the second method, but the QR code includes information for both the authorization and the initial payment, enabling the payer to authorize the recurring payment and make the first payment in a single step.

AUT4 - Post-payment sign-up path. After completing a one-time payment via QR code, the payer is offered the option to authorize recurring payments for future transactions

Allowed:
string

Date time from a successful payment. Mandatory for the AUT3 journey. RFC 3339 value. Format: YYYY-MM-DDThh:mm:ss.SSSZ.

string
length ≤ 35

Transaction ID from a successful payment. Mandatory for the AUT3 journey.

Headers
string
required

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

string
required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json