API Reference

Get Scheduled Payments

get
https://earthnode-dev.vopay.com/api/v2/scheduled-payment

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

integer

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

integer

Maximum number of results to return

integer

Pagination offset

string

Filter by repeat frequency

string

Filter by payment type

string

Filter by currency code

string

Filter by payment rail

string

Filter by payment token

string

Filter by general ledger code

string

Filter by client account ID

date

Filter by start date (inclusive)

date

Filter by end date (inclusive)

Response

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?