latestOpenAPI 3.1.02026-08-152492433.9 MB

036d178e1a7a

List Real-Time Payments Requests for Payment

get/real_time_payments_requests_for_payment

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 Real-Time Payments Requests for Payment to those destined to the specified Account.

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.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

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_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "amount": 100,
      "created_at": "2020-01-31T23:59:59Z",
      "creditor_name": "National Phonograph Company",
      "currency": "USD",
      "debtor": {
        "address": {
          "address_line2": "Unit 2",
          "building_number": "33",
          "city": "New York",
          "country": "US",
          "postal_code": "10045",
          "state": "NY",
          "street_name": "Liberty Street"
        },
        "name": "Ian Crease"
      },
      "debtor_account_number": "987654321",
      "debtor_routing_number": "101050001",
      "expires_at": "2020-02-14T23:59:59+00:00",
      "fulfillment_inbound_real_time_payments_transfer_id": null,
      "id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7",
      "idempotency_key": null,
      "refusal": null,
      "rejection": null,
      "requested_execution_at": "2020-02-07T23:59:59+00:00",
      "status": "pending_response",
      "submission": null,
      "type": "real_time_payments_request_for_payment",
      "unstructured_remittance_information": "Invoice 29582"
    }
  ],
  "next_cursor": "v57w5d"
}