Sign in
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"
}

Changes

Changed in 3 of the 4 revisions of this API.176

  • a6363e3dbb7b5See the full diff
    • ●

      added the new ACCOUNT_CLOSING_TRANSFER enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ACCOUNT_CLOSING_TRANSFER_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INCOMING_WIRE_RETURN enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INTERNATIONAL_INCOMING_WIRE enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INTERNATIONAL_INCOMING_WIRE_RETURN enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b0d812e6cdd0106See the full diff
    • ●

      added the new ARBITRATION_FINAL_CREDIT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ARBITRATION_FINAL_CREDIT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CHARGEBACK_FINAL_CREDIT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CHARGEBACK_FINAL_CREDIT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PROVISIONAL_CREDIT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PROVISIONAL_CREDIT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new WRITEOFF_FRAUD_FINAL_CREDIT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the CARD_CHARGEBACK_CASE1 enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CARD_CHARGEBACK_CASE1_REVERSAL enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CARD_CHARGEBACK_CASE2 enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CARD_CHARGEBACK_CASE2_REVERSAL enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CARD_CHARGEBACK_CASE3 enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CARD_CHARGEBACK_CASE3_REVERSAL enum value from the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1df97930c9182See the full diff
    • ●

      added the new ONE_TIME_PAYMENT enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ONE_TIME_PAYMENT_REVERSAL enum value to the allOf[subschema #1]/payments/items/payment_instruction/oneOf[internal_transfer_instruction]/request/type response property for the response status 200

      response-property-enum-value-added