List Real-Time Payments Transfers

Changed on
get/real_time_payments_transfers

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/real_time_payments_transfers
  • 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 Real-Time Payments Transfers to those belonging to the specified Account.

external_account_idstring

Filter Real-Time Payments Transfers to those made to the specified External Account.

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.

status.instring[]

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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

Real-Time Payments Transfer 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": "987654321",
      "acknowledgement": {
        "acknowledged_at": "2020-01-31T14:10:02Z"
      },
      "amount": 100,
      "approval": null,
      "cancellation": null,
      "created_at": "2020-01-31T14:00:00Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "creditor_name": "Ian Crease",
      "currency": "USD",
      "debtor_name": "National Phonograph Company",
      "external_account_id": null,
      "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
      "idempotency_key": null,
      "inbound_real_time_payments_request_for_payment_id": null,
      "pending_transaction_id": null,
      "rejection": null,
      "routing_number": "101050001",
      "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "status": "complete",
      "submission": {
        "submitted_at": "2020-01-31T14:10:00Z",
        "transaction_identification": "20220501234567891T1BSLZO01745013025"
      },
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "real_time_payments_transfer",
      "ultimate_creditor_name": null,
      "ultimate_debtor_name": null,
      "unstructured_remittance_information": "Invoice 29582"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 036d178e1a7aRevision changes
    • info

      added the required property // to the response with the status

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added