Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Automatic Pix

Accept/reject recurrence authorization

Pix Automatic payee recurrence payment authorization acceptance or rejection

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

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

For more information, refer to Pix automatic use cases (journeys).

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.

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"
}

Response

OK

mtistring

Message type ID. For example: 0100 = auth. request, 0110`` = auth. response, 0120` = auth. advice. For more information, see MTI.

authorization_codestring

Authorization code.

response_codestring

Network two-digit response code. For example: 00 = approve, 51 = insufficient funds, 57 = card not active, 96 = system failure, etc. For more information, see Validation codes for authorization events. If approve = false, you can use this value to respond to the network.

authorization_date_timestring

Authorization date and time in Coordinated Universal Time (UTC), i.e., 2020-01-01T10:10:00.000-03:00.

custom_code'FL2' | 'FL8' | 'FLB' | 'FLE' | 'DCM' | 'VMN' | '998' | 'LUD' | 'LUE' | 'LUT' | 'LGE' | '810' | 'PFT' | 'IAT' | 'BND' | 'ANF' | 'CTE' | 'CED' | 'ZBD' | 'FRB' | 'UBT' | 'FL6' | 'BNF' | 'BNP' | 'BNR' | 'VED' | 'BNU' | 'VEV' | 'UBN' | 'CSU' | 'NPL' | 'OP1' | 'TNF' | 'Z26' | 'Z24' | 'Z29' | 'Z23' | 'Z22'

Internal custom code generated in authorization flow for declined requests, indicating the reason the request was declined.

For more information, see authorization validations.

match_addressboolean

Is cardholder address street and number the same as that contained on the platform?

match_postal_codeboolean

Is cardholder postal code the same as the one contained on the platform?

postal_five_digitsboolean

Is this a valid postal code with five digits?

no_address_databoolean

Is address registered on platform?

authorization_idinteger

Authorization ID

account_idinteger

Account ID

installment_valuestring

Installment value. If there are no installments, this is the same as contract_amount.

interest_ratenumber

Monthly interest rate

number_of_installmentsnumber

Number of installments

contract_amountstring

Transaction value

Example response

{
  "mti": "0100",
  "authorization_code": "F0JR9H",
  "response_code": "00",
  "authorization_date_time": "2020-01-01T10:10:00.000-03:00",
  "custom_code": "FLB",
  "match_address": true,
  "match_postal_code": true,
  "postal_five_digits": true,
  "no_address_data": true,
  "authorization_id": 4923745,
  "account_id": 24141240,
  "installment_value": "100.00",
  "interest_rate": 2,
  "number_of_installments": 2,
  "contract_amount": "100.00",
  "crediario_responses": [
    {
      "installmentValue": "51.86",
      "monthlyInterestRate": "2.00",
      "totalAmount": "103.72",
      "numberOfInstallments": "2",
      "feeAmount": "0.00",
      "taxesAmount": "0.86",
      "taxesPercentageOfTotalAmount": "0.83",
      "feePercentageOfTotalAmount": "0.00",
      "planType": "",
      "annualInterestRate": "",
      "monthlyTotalEffectiveCost": "",
      "annualTotalEffectiveCost": "",
      "installmentDate": "",
      "insurance": "",
      "insurancePercentageOfTotalAmount": "",
      "other": "",
      "otherPercentageOfTotalAmount": "",
      "totalAmountToMerchant": "",
      "merchantAmountPercentage": "",
      "reservedForFutureUse": ""
    }
  ]
}