MOmodern-treasury

[DEPRECATED] List Ledger Account Payouts

Changed on
get/ledger_account_payouts

Request

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

Query parameters

id[]string[]

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.

payout_ledger_account_idstring

Filter ledger account payouts by the payout ledger account 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.

after_cursorstring
per_pageinteger

Response

200

idstring
objectstring
live_modeboolean
descriptionstring
payout_ledger_account_idstring
funding_ledger_account_idstring
effective_at_upper_boundstring
statusstring
amountinteger
currencystring
ledger_transaction_idstring
created_atstring
updated_atstring

Example response

[
  {
    "id": "dbdbbfe5-da56-4aaf-be36-3fbc415622dd",
    "object": "ledger_account_payout",
    "live_mode": true,
    "description": "Alice's January payout",
    "payout_ledger_account_id": "d44ad0d0-b3ea-4698-867d-09fe961e52a6",
    "funding_ledger_account_id": "3824af4d-4151-48f6-8e8b-bf859cbddbcd",
    "effective_at_upper_bound": "2023-01-01T00:00:00.000Z",
    "status": "pending",
    "amount": 1000,
    "currency": "USD",
    "ledger_transaction_id": "b47ce462-806b-4d5d-9476-9add11a42529",
    "metadata": {
      "foo": "bar"
    },
    "created_at": "2023-01-11T20:35:36Z",
    "updated_at": "2023-01-11T20:36:02Z"
  }
]

Changes