Automatic Pix

Create recurrence

Initiate a payment request to create a Pix Automatic recurrence payment authorization.

The Central Bank of Brazil (BACEN) created Pix Automatic - a feature that allows for scheduled and automatic recurring transfers.

BACEN rules state that a recurrence must support retry attempts to allow execution of additional charges in case the original payment is not completed.

Retries flow

If the payment order is not paid by 22:00 on the due date, and the recurrence allows retries, Pismo automatically generates a new payment order for that unpaid cycle.
The new payment order is created with type = RETRY_OVERDUE, and its due date is set to D+2, in compliance with Central Bank requirements. Retries can occur up to 3 times, within a maximum period of 7 days after the original due date.
After these 3 retry attempts, the payment order cycle can no longer be processed via the automatic Pix flow. The payee must manage further collection outside of this flow.

For more information, refer to Pix Automatic

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

Request

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

Headers

x-accountinteger required

Pismo account ID.

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.

x-tenantstring

Organization ID

Request body

contract_idstring required

Payee-created external ID for their reference.

descriptionstring required

Recurrence payment description

frequency_type'WEEK' | 'MONTH' | 'QUARTER' | 'SEMESTER' | 'YEAR' required

Recurrence payment type

allow_attempts_after_expirationboolean required

Will charge continue after due date?

If true the recurence will receive a recurrence_id starting with RR. Otherwise, it will start with RN.

first_payment_datestring datetime required

First charge/payment date, must be more than 2 days ahead the recurrence creation date. Format = yyyy-mm-dd

dynamic_amountboolean

Does recurrence have a dynamic amount?

If true, min_payment_amount is REQUIRED.

If false, amount is REQUIRED. Default is false.

amountnumber

Amount to be transferred.

min_payment_amountnumber

Payee-defined minimum payment amount for dynamic amount recurrences.

last_payment_datestring datetime

Last charge/payment date. Format = yyyy-mm-dd

expiration_datestring datetime

Authorization expiration date, must be at least 2 days before the first_payment_date.

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

If not passed, the expiration_date is automatically generated, up to 2 days before the first_payment_date, or a maximum of 30 days from the current date, whichever is due first

Example request

{
  "contract_id": "5509-uroo-78944-9987",
  "description": "Gym membership",
  "frequency_type": "MONTH",
  "first_payment_date": "2025-04-25",
  "debtor": {
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "name": "Walter Melon"
  },
  "payer": {
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "name": "Walter Melon",
    "bank": "237",
    "branch": "011",
    "account_number": "98765432",
    "account_type": "TRAN",
    "city_code": "3550308"
  },
  "amount": 1050.44,
  "min_payment_amount": 10.09,
  "last_payment_date": "2026-06-10",
  "expiration_date": "2020-08-13T13:49:03.000Z",
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "amount": 1050.44
      }
    ]
  }
}

Response

recurrence_idstring

BACEN recurrence ID

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

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

contract_idstring

Payee-created external ID for their reference.

descriptionstring

Recurrence payment description

amountnumber

Amount to be transferred.

min_payment_amountnumber

Payee-defined minimum payment amount for dynamic amount recurrences.

max_payment_amountnumber

Payer-defined maximum payment amount for dynamic amount recurrences.

dynamic_amountboolean

Does recurrence have a dynamic amount?

If true, min_payment_amount is REQUIRED.

If false, amount is REQUIRED. Default is false.

frequency_type'WEEK' | 'MONTH' | 'QUARTER' | 'SEMESTER' | 'YEAR'

Recurrence payment type

allow_attempts_after_expirationboolean

Will charge continue after due date?

If true the recurence will receive a recurrence_id starting with RR. Otherwise, it will start with RN.

is_working_daysboolean

If the recurrence will only execute on working days

expiration_datestring datetime

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

first_payment_datestring datetime

First charge/payment date. Format = yyyy-mm-dd

last_payment_datestring datetime

Last charge/payment date. Format = yyyy-mm-dd

Recurrence status

Cancellation reason code:

ACCL - Paying receiving user's account cancelled
CPCL - Receiving company closure
DCSD - Paying user death
ERSL - Receiving user, or their participant, request cancelled due to confirmation request error
FRUD - Fraud
PCFD - Receiving user participant request because the same recurrence was confirmed another way, for example, via QR code
SLCR - Receiving user request
SLDB - Paying user request
OTHS - Requested by either the payer's participant or the receiver's participant for other reasons not specified in the previous categories
NRES - Receiving PSP request due to lack of response to pain.009 within the regulatory period

transaction_identificationstring

Recurrence transaction ID.

created_atstring datetime

Created at datetime. RFC 3339 format

updated_atstring

Scheduled item last updated time, RFC 3339 format

Example response

{
  "recurrence_id": "RN000000012025050500012345678",
  "journey_type": "AUT1",
  "contract_id": "5509-uroo-78944-9987",
  "description": "Gym membership",
  "amount": 1050.44,
  "min_payment_amount": 10.09,
  "max_payment_amount": 86753.09,
  "frequency_type": "MONTH",
  "expiration_date": "2020-08-13T13:49:03.000Z",
  "first_payment_date": "2025-04-25",
  "last_payment_date": "2026-06-10",
  "payee": {
    "name": "Walter Melon",
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "bank": "237",
    "branch": "011",
    "account_number": "98765432",
    "account_type": "TRAN"
  },
  "payer": {
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "name": "Walter Melon",
    "bank": "237",
    "branch": "011",
    "account_number": "98765432",
    "account_type": "TRAN",
    "city_code": "3550308"
  },
  "debtor": {
    "document_number": "123412341234",
    "document_type": "NATURAL_PERSON",
    "name": "Walter Melon"
  },
  "status": "CREATED",
  "reason_code": "ACCL",
  "transaction_identification": "1a84daf6-a61b-4aba-919a-a9943db7102e",
  "authorizations": [
    {
      "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"
      }
    }
  ],
  "created_at": "2025-11-14T17:54:40Z",
  "updated_at": "2024-11-14T17:54:40Z",
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "tax_category": "INF",
        "amount": 1050.44
      }
    ]
  }
}

Changes

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