List Payment Orders

Get a list of all payment orders

get/payment_orders

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/payment_orders
  • Auth
    HTTP basic

Query parameters

after_cursorstring
per_pageinteger
typestring
effective_date_startstring date

An inclusive lower bound for searching effective_date

effective_date_endstring date

An inclusive upper bound for searching effective_date

counterparty_idstring
originating_account_idstring
metadatastring

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.

statusstring
directionstring
transaction_idstring

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

reference_numberstring

Query for records with the provided reference number

prioritystring

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_startstring date

An inclusive lower bound for searching created_at

created_at_endstring date

An inclusive upper bound for searching created_at

process_after_startstring date

An inclusive lower bound for searching process_after

process_after_endstring date

An inclusive upper bound for searching process_after

gtinteger
gteinteger
ltinteger
lteinteger
eqinteger
not_eqinteger

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

batch_idstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.