Schedule a charge on an authorized recurrence
Sends the charge to the payer’s bank, which confirms it
(pix.automatic.scheduling.confirmed) and settles it on dueDate
(pix.automatic.settlement.*). The recurrence must be authorized.
Financial operation: requires an M2M credential with pix.automatic.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
accountId
Account identifier.
recurrenceId
Recurrence UUID (recurrenceId) or its Pix scheme identifier (RR…/RN…).
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Idempotency-Key
Optional client-generated idempotency token (recommended for safe retries).
Request
This endpoint expects an object.
dueDate
value
Required for variable-amount recurrences; ignored when the recurrence has a fixed value.
message
adjustToBusinessDay
Moves dueDate to the next business day when it falls on a non-business day.
Response
Scheduling created
schedulingId
recurrenceId
recurrenceIdentifier
endToEndId
dueDate
value
status
purpose
Allowed values:
message
createdAt
updatedAt
history
settlement
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
502
Bad Gateway Error