GuidesAPI Reference
Log In
API Reference

Get Payment Instructions

Returns Payment Instructions within the given date range. Requires exactly one date range pair: either "from"/"to" (preferred, ISO 8601 datetime) or "startDate"/"endDate" (deprecated, date-only YYYY-MM-DD). Do not mix fields from different pairs.

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

Account ID to filter by. Returns Payment Instructions where the Source or Destination Account ID matches this value. Can be a Partner Account ID, Client Account ID, or Payment Account ID.

date-time

The datetime to include Payment Instructions created at or later (>=) than this datetime. Must be in ISO 8601 format. If timezone is not specified, the system assumes UTC start of day, e.g. "2026-02-01" is treated as "2026-02-01T00:00:00.000Z". Required if 'to' is provided. Mutually exclusive with 'startDate'/'endDate'.

date-time

The datetime to include Payment Instructions created earlier (<) than this datetime. Must be in ISO 8601 format. If timezone is not specified, the system assumes UTC start of day, e.g. "2026-02-28" is treated as "2026-02-28T00:00:00.000Z". Required if 'from' is provided. Mutually exclusive with 'startDate'/'endDate'.

date
deprecated

Deprecated: Use "from" instead. Start of the date range. Must be in YYYY-MM-DD format (ISO 8601 date format with hyphens). Only date-only strings are accepted; time components are not allowed. Mutually exclusive with 'from'/'to'.

date
deprecated

Deprecated: Use "to" instead. End of the date range. Must be in YYYY-MM-DD format (ISO 8601 date format with hyphens). Only date-only strings are accepted; time components are not allowed. Mutually exclusive with 'from'/'to'.

Responses

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