PIpismo
Automatic Pix

Accept/reject recurrence authorization

Pix Automatic payee recurrence payment authorization acceptance or rejection

post/inst-pull-pay/v1/pix/automatic/payer/authorization

Request

  • Base URL
    https://sandbox-cdn.pismolabs.io
  • URL
    https://sandbox-cdn.pismolabs.io/inst-pull-pay/v1/pix/automatic/payer/authorization
  • Auth
    none declared. Required headers: Authorization, Idempotency-Key

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

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

Idempotency-Keystring 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.

Request body

recurrence_idstring required

BACEN recurrence ID

status'ACCEPTED' | 'REJECTED' required

Authorization status

reason'AP13' | 'AP14'

Rejected authorizations reason code. Mandatory when status is REJECTED.

  • 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
max_payment_amountnumber

Payer-defined maximum payment amount for dynamic amount recurrences.

journey_type'AUT1' | 'AUT2' | 'AUT3' | 'AUT4' required

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

payment_date_timestring datetime

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

transaction_identificationstring

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

city_codestring

An <a href='https://www.ibge.gov.br/explica/codigos-dos-municipios.php' target="_blank">IBGE</a> municipal code is a 7-digit numerical ID that the Brazilian Institute of Geography and Statistics (IBGE) assigns to uniquely ID each municipality and federal district in Brazil.

Example request

{
  "recurrence_id": "RN000000012025050500012345678",
  "status": "REJECTED",
  "reason": "AP14",
  "max_payment_amount": 86753.09,
  "journey_type": "AUT1",
  "payment_date_time": "2020-08-13T13:49:03.000Z",
  "transaction_identification": "ttx2020010300000000000000000000001",
  "city_code": "3550308"
}

Response

OK

idstring

Authorization ID the same as BACEN (Brazil Central Bank) IdSoliReq (request identification code)

expiration_datestring datetime

Authorization expiration date. RFC 3339 value. Format = YYYY-MM-DDThh:mm:ss.SSSZ

creted_atstring datetime

Created at datetime. RFC 3339 format

updated_atstring

Scheduled item last updated time, RFC 3339 format

reason_code'AC01' | 'AC04' | 'AC06' | 'AP01' | 'AP02' | 'AP03' | 'AP04' | 'AP05' | 'AP06' | 'AP07' | 'AP08' | 'AP09' | 'AP10' | 'AP11' | 'AP12' | 'AP13' | 'AP14' | 'AP15' | 'CH16' | 'MD01' | 'MD20'

Authorization reason code.

Note: "pain.009" is a message sent to the payer when the payee starts a #1 journey (AUT1) Automatic Pix recurrence

  • AC01 - Account not found or not belonging to the paying user
  • AC04 - Paying user's transactional account is closed
  • AC06 - Paying user's transactional account is blocked
  • AP01 - Discrepancy in the field for updating periodic payments recurrence data and the periodic payments recurrence status - lack of synchronization
  • AP02 - Paying user's CPF/CNPJ not found or different from the one in the original pain.009. Or, in the case of cancellation, the paying user's CPF/CNPJ does not match the one contained in the perioduc payments recurrence data.
  • AP03 - Paying user's branch not found
  • AP04 - Invalid recurrence ID or does not match the original
  • AP05 - Inconsistent recurrence status for periodic payments
  • AP06 - Receiving user's CPF/CNPJ is different from the one in the pain.009 or the payload. Or, in the case of cancellation, the receiving user's CPF/CNPJ does not match the one contained in the periodic payments recurrence data.
  • AP07 - Paying user's recurrence confirmation performed after the confirmation request's expiration or cancellation (pain.009)
  • AP08 - First immediate payment associated with the recurrence was not identified. (Valid only for Authorization Journey 3 (AUT3))
  • AP09 - Recurrence confirmation request for periodic payments was not identified to enable its cancellation
  • AP10 - Cancellation requestor's CPF/CNPJ does not match the the paying/receiving user's or the paying/receiving PSP's identification contained in the periodic payments recurrence data.
  • AP11 - Paying PSP's ISPB diverges from the information contained in the recurrence for periodic payments
  • AP12 - Receiving PSP's ISPB diverges from the information contained in the recurrence for periodic payments
  • AP13 = Paying user rejects periodic payments recurrence confirmation request due to receiving user non-recognition
  • AP14 - Paying user rejects periodic payments recurrence confirmation request due to receiving user's lack of interest in using Pix Automatic
  • AP15 - Paying user's participant rejects recurrence confirmation request for periodic payments as they chose not to offer Pix Automatic usage for corporate clients
  • CH16 - Incorrect or incompatible message content with business rules
  • MD01 - Cancellation request's recurrence object does not exist. Should not be used for cancellation requests of pain.009 with status = PDNG. That is, a recurrence with status = PDNG should be considered as an existing recurrence.
  • MD20 - Cancellation request's recurrence object has already expired.
status'CREATED' | 'RECEIVED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED' | 'CANCELLED'

Authorization status

Example response

{
  "id": "IS0435879820240605bcdb1fhn43a",
  "expiration_date": "2020-08-13T13:49:03.000Z",
  "creted_at": "2025-11-14T17:54:40Z",
  "updated_at": "2024-11-14T17:54:40Z",
  "reason_code": "AC01",
  "status": "ACCEPTED",
  "payer": {
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "name": "Walter Melon",
    "bank": "237",
    "branch": "011",
    "account_number": "98765432",
    "account_type": "TRAN",
    "city_code": "3550308"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.