Skip to navigation

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

accountIdstringRequired
Account identifier.
recurrenceIdstringRequired

Recurrence UUID (recurrenceId) or its Pix scheme identifier (RR…/RN…).

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
dueDatedateRequired
valuedoubleOptional

Required for variable-amount recurrences; ignored when the recurrence has a fixed value.

messagestringOptional
adjustToBusinessDaybooleanOptional

Moves dueDate to the next business day when it falls on a non-business day.

Response

Scheduling created
schedulingIdstringOptional
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional
endToEndIdstringOptional
dueDatedateOptional
valuedoubleOptional
statusenumOptional
purposeenumOptional
Allowed values:
messagestringOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
historylist of objectsOptional
settlementobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
502
Bad Gateway Error