List Payment Orders

get

https://app.moderntreasury.com/api/payment_orders

Get a list of all payment orders

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

after_cursor

string

per_page

int32

Defaults to 25

type

string

effective_date_start

date

An inclusive lower bound for searching effective_date

effective_date_end

date

An inclusive upper bound for searching effective_date

counterparty_id

string

originating_account_id

string

metadata

string

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

status

string

direction

string

transaction_id

string

The ID of a transaction that the payment order has been reconciled to

reference_number

string

Query for records with the provided reference number

priority

string

Either normal or high. For ACH and EFT payments, high represents a same-day ACH or EFT transfer, respectively. For check payments, high can mean an overnight check rather than standard mail.

created_at_start

date

An inclusive lower bound for searching created_at

created_at_end

date

An inclusive upper bound for searching created_at

process_after_start

date

An inclusive lower bound for searching process_after

process_after_end

date

An inclusive upper bound for searching process_after

external_id

string

An external ID to filter Payment Orders on

amount

object

Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by balance amount.

batch_id

string

The id of the batch that was used by the system to generate the actual sending artifact.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here!