APIs
Sub-processorsAbout PismoContact us

Create recurrence

post
https://sandbox-cdn.pismolabs.io/inst-pull-pay/v1/pix/automatic

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

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

Recurrence request

string
required
length ≤ 35

Payee-created external ID for their reference.

string
required
length ≤ 35

Recurrence payment description

string
enum
required

Recurrence payment type

Allowed:
boolean
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.

string
required

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

debtor
object
required
payer
object
required
boolean
Defaults to false

Does recurrence have a dynamic amount?

If true, min_payment_amount is REQUIRED.

If false, amount is REQUIRED. Default is false.

number

Amount to be transferred.

number

Payee-defined minimum payment amount for dynamic amount recurrences.

string

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

string

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

taxes
object

Only available in EXT environment for direct parciapants. Tax information related to the transaction.

Headers
integer
required

Pismo account ID.

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.

string

Organization ID

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?