v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

PaymentSchedules

List payments

Get paginated list of payments

get/payment_schedules/payments

Query parameters

idstring[]

IDs. Multiple IDs can be provided as a comma-separated list.

account_idstring[]

Originating account IDs. Multiple IDs can be provided as a comma-separated list.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

customer_idstring[]

The IDs of customers who created the payment schedules. Multiple IDs can be provided as a comma-separated list.

schedule_idstring[]

Payment schedule IDs. Multiple IDs can be provided as a comma-separated list.

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List of payment schedules

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "payments": [
    {
      "payment_instruction": {
        "request": {
          "amount": 607,
          "company_entry_description": "PAYROLL",
          "company_name": "Asdf Finance",
          "currency": "USD",
          "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "dc_sign": "debit",
          "effective_date": "2022-03-18",
          "hold": {
            "duration": 2
          },
          "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "reference_info": "Tempore atque et cum."
        }
      }
    }
  ],
  "next_page_token": "a8937a0d"
}