Sign in
Automatic PIX

Get an automatic PIX scheduled payment

Recovers an automatic PIX scheduled payment by id

get/payments/requests/{requestId}/automatic-pix/schedules/{paymentId}

Path parameters

requestIdstring uuid required

Payment request primary identifier

paymentIdstring uuid required

Automatic PIX scheduled payment primary identifier

Response

Recovers an automatic PIX scheduled payment by id

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

scheduledStatusReachedboolean required

Indicates whether the payment reached the scheduled status in the last attempt. Useful to determine if a retry can be executed.

Changes

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