Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Automatic PIX

Schedule Automatic PIX payment

Schedules an Automatic PIX payment

post/payments/requests/{id}/automatic-pix/schedule

Path parameters

idstring uuid required

Payment request primary identifier

Request body

amountnumber required

Transaction value

descriptionstring

Transaction description

datestring date required

The payment date, which must fall between D+2 and D+10. Date format must be YYYY-MM-DD (for example: 2025-06-16)

clientPaymentIdstring

External identifier for the payment

recipientIdstring uuid

Payment recipient identifier. It should be sent if you want to use a different recipient from the one consented in the payment request (it must have the same tax number as the consented recipient).

Response

Schedule a Automatic PIX payment.

idstring required

Payment primary identifier

status'SCHEDULED' | 'CREATED' | 'COMPLETED' | 'CANCELED' | 'ERROR' required

Status of an individual recurring PIX payment.

  • SCHEDULED: the payment has been scheduled at the institution.
  • CREATED: the payment is created and pending execution.
  • COMPLETED: the payment was confirmed.
  • CANCELED: the payment was canceled.
  • ERROR: the payment failed (see errorDetail).
amountnumber required

Payment amount

descriptionstring

Payment description

datestring date required

Payment scheduled date

endToEndIdstring

Payment end to end identifier

clientPaymentIdstring

External identifier for the payment

recipientIdstring uuid required

Payment recipient identifier

isFirstPaymentboolean

Indicates if this is the first payment