Get scheduled transfer

Get a scheduled Pix payment.

For ONCE and RECURRING schedulers, set showPreview=true to include executions_preview (a preview of upcoming executions that will be created in the future). For PRESET schedulers, executions_preview is never returned because all executions are created upfront — retrieve them through the List Pix scheduler executions endpoint instead.

Note: This endpoint takes an account token - an access token encoded with a Pismo accound ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 36

Schedule ID

Query Params
boolean

Should a preview of upcoming executions be presented? Default is false (no execution previews returned). Has no effect for PRESET schedulers, whose executions are all created upfront and available through the List Pix scheduler executions endpoint.

Headers
string
required

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

string

The Correlation ID UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Responses

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