v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Scheduled Payments

Get Scheduled Payments

Retrieve details of a single scheduled payment or all scheduled payments for the account.

get/scheduled-payment

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ScheduledPaymentsIDinteger

The ID of a specific scheduled payment to retrieve. If omitted, returns all scheduled payments.

Limitinteger

Maximum number of results to return

Offsetinteger

Pagination offset

Repeatsstring

Filter by repeat frequency

PaymentTypestring

Filter by payment type

Currencystring

Filter by currency code

PaymentRailstring

Filter by payment rail

Tokenstring

Filter by payment token

GLCodestring

Filter by general ledger code

ClientAccountIDstring

Filter by client account ID

StartDatestring date

Filter by start date (inclusive)

EndDatestring date

Filter by end date (inclusive)

Response

Scheduled payments retrieved successfully

ScheduledPaymentobject

Object containing scheduled payment records