Create Automatic PIX payment request

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

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.

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.

string

Description for the automatic pix authorization

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)

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).

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.

string
enum
required

Defines the permitted frequency for carrying out transactions.

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

string
required

Primary identifier of the payment recipient

string

Client payment identifier

string

Primary identifier of the customer

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json