List Inbound Real-Time Payments Requests for Payment

Changed on
get/inbound_real_time_payments_requests_for_payment

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/inbound_real_time_payments_requests_for_payment
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Inbound Real-Time Payments Requests for Payment to those belonging to the specified Account.

account_number_idstring

Filter Inbound Real-Time Payments Requests for Payment to ones belonging to the specified Account Number.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Inbound Real-Time Payments Request for Payment List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "amount": 100,
      "created_at": "2020-01-31T23:59:59Z",
      "creditor": {
        "account_name": "National Phonograph Company",
        "address": {
          "address_line2": "Unit 2",
          "building_number": "33",
          "city": "New York",
          "country": "US",
          "postal_code": "10045",
          "state": "NY",
          "street_name": "Liberty Street"
        },
        "name": "National Phonograph Company"
      },
      "creditor_account_number": "987654321",
      "creditor_routing_number": "101050001",
      "currency": "USD",
      "debtor_name": "Ian Crease",
      "end_to_end_identification": "Invoice 29582",
      "expires_at": "2020-02-07T23:59:59Z",
      "fulfillment_real_time_payments_transfer_id": null,
      "id": "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky",
      "invoicer_identification": null,
      "payment_information_identification": "20220501234567891T1BSLZO01745013025",
      "requested_execution_at": "2020-01-31T23:59:59Z",
      "type": "inbound_real_time_payments_request_for_payment",
      "unstructured_remittance_information": "Invoice 29582"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes