MOmodern-treasury

List Returns

Get a list of returns

get/returns

Request

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

Query parameters

after_cursorstring
per_pageinteger
internal_account_idstring

Specify internal_account_id if you wish to see returns to/from a specific account.

counterparty_idstring

Specify counterparty_id if you wish to see returns that occurred with a specific counterparty

returnable_idstring

The ID of a valid returnable. Must be accompanied by returnable_type

returnable_typestring

One of payment_order or incoming_payment_detail. Must be accompanied by returnable_id.

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.

typestring

Changes

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