Create Automatic PIX payment request

post

https://api.pluggy.ai/payments/requests/automatic-pix

Creates a payment request where the payment is made using automatic PIX. Once consent is granted by the user, payments can be scheduled according to the rules defined in the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

If the description is not provided, each institution will create its own description for the user to understand what they are authorizing. They could add "pluggy" in a generic description. It's essential to provide a clear description of the request and the first payment to ensure the user understands what it's about.

Body Params

Automatic PIX data

fixedAmount

number

Fixed charge amount; if filled in, it represents consent for payments of fixed amounts, not subject to change during the validity of the consent. If it's sent, minimumVariableAmount and maximumVariableAmount cannot be provided.

minimumVariableAmount

number

Minimum amount allowed per charge; if filled in, it represents consent for payments of variable amounts. If it's sent, fixedAmount cannot be provided.

maximumVariableAmount

number

Maximum amount allowed per charge; if filled in, it represents consent for payments of variable amounts. If it's sent, fixedAmount cannot be provided.

description

string

Description for the automatic pix authorization

startDate

date

required

Represents the expected date for the first occurrence of a payment associated with the recurrence. Date format must be YYYY-MM-DD (for example: 2025-06-16)

expiresAt

date

Expiration date for the automatic pix authorization. The date must be in UTC and the format must follow the following pattern: YYYY-MM-DDTHH:MM:SSZ (for example: 2025-06-16T03:00:00Z).

isRetryAccepted

boolean

Indicates whether the receiving customer is allowed to make payment attempts, according to the rules established in the Pix arrangement.

firstPayment

object

Definitions for the first payment. It is considered as the user's enrollment payment for the service.

interval

string

enum

required

Permitted frequency for recurring PIX payments under a consent.

Allowed:

automaticRetriesConfiguration

object

“Configuration for automatic retries. If provided, the scheduled payments associated with this consent will only be retried on the days specified in the array after the original payment date. This does not apply to the first payment, only for scheduled payments.

schedulerConfiguration

object

Configuration for automatic scheduling of payments. When enabled, the system will schedule payments according to the consent interval and start date.

callbackUrls

object

Redirect urls after the payment was completed or ended in error status

recipientId

string

required

Primary identifier of the payment recipient

clientPaymentId

string

Client payment identifier

customerId

string

Primary identifier of the customer

Response

200Create a Automatic PIX payment request.