---
title: "List Real-Time Payments Transfers"
method: GET
path: "/real_time_payments_transfers"
---

# List Real-Time Payments Transfers

`GET /real_time_payments_transfers`

## Query parameters

- `cursor` string — Return the page of entries after this one.
- `limit` integer — Limit the size of the list that is returned. The default (and maximum) is 100 objects.
- `account_id` string — Filter Real-Time Payments Transfers to those belonging to the specified Account.
- `external_account_id` string — Filter Real-Time Payments Transfers to those made to the specified External Account.
- `idempotency_key` string — 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](https://increase.com/documentation/idempotency-keys).
- `status.in` string[] — 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.after` string, date-time — Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.before` string, date-time — Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_after` string, date-time — Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_before` string, date-time — Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

## Response `200`

Real-Time Payments Transfer List

- RealTimePaymentsTransferList — A list of Real-Time Payments Transfer objects.
  - `data` RealTimePaymentsTransfer[], required — The contents of the list.
    - `account_id` string, required — The Account from which the transfer was sent.
    - `account_number` string, required — The destination account number.
    - `acknowledgement` object, nullable, required — If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
      - `acknowledged_at` string, date-time, required — When the transfer was acknowledged.
    - `amount` integer, required — The transfer amount in USD cents.
    - `approval` object, nullable, required — If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
      - `approved_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
      - `approved_by` string, nullable, required — If the Transfer was approved by a user in the dashboard, the email address of that user.
    - `cancellation` object, nullable, required — If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
      - `canceled_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
      - `canceled_by` string, nullable, required — If the Transfer was canceled by a user in the dashboard, the email address of that user.
    - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
    - `created_by` object, nullable, required — What object created the transfer, either via the API or the dashboard.
      - `api_key` object, nullable — If present, details about the API key that created the transfer.
        - `description` string, nullable, required — The description set for the API key when it was created.
      - `category` 'api_key' | 'oauth_application' | 'user', required — The type of object that created this transfer.
      - `oauth_application` object, nullable — If present, details about the OAuth Application that created the transfer.
        - `name` string, required — The name of the OAuth Application.
      - `user` object, nullable — If present, details about the User that created the transfer.
        - `email` string, required — The email address of the User.
    - `creditor_name` string, required — The name of the transfer's recipient. This is set by the sender when creating the transfer.
    - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.
    - `debtor_name` string, nullable, required — The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
    - `external_account_id` string, nullable, required — The identifier of the External Account the transfer was made to, if any.
    - `id` string, required — The Real-Time Payments Transfer's identifier.
    - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
    - `pending_transaction_id` string, nullable, required — The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
    - `rejection` object, nullable, required — If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
      - `reject_reason_additional_information` string, nullable, required — Additional information about the rejection provided by the recipient bank when the `reject_reason_code` is `NARRATIVE`.
      - `reject_reason_code` 'account_closed' | 'account_blocked' | 'invalid_creditor_account_type' | 'invalid_creditor_account_number' | 'invalid_creditor_financial_institution_identifier' | 'end_customer_deceased' | 'narrative' | 'transaction_forbidden' | 'transaction_type_not_supported' | 'unexpected_amount' | 'amount_exceeds_bank_limits' | 'invalid_creditor_address' | 'unknown_end_customer' | 'invalid_debtor_address' | 'timeout' | 'unsupported_message_for_recipient' | 'recipient_connection_not_available' | 'real_time_payments_suspended' | 'instructed_agent_signed_off' | 'processing_error' | 'other', required — The reason the transfer was rejected as provided by the recipient bank or the Real-Time Payments network.
      - `rejected_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected.
    - `routing_number` string, required — The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
    - `source_account_number_id` string, required — The Account Number the recipient will see as having sent the transfer.
    - `status` 'pending_approval' | 'canceled' | 'pending_submission' | 'pending_reviewing' | 'requires_attention' | 'rejected' | 'submitted' | 'complete', required — The lifecycle status of the transfer.
    - `submission` object, nullable, required — After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
      - `submitted_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to The Clearing House.
      - `transaction_identification` string, required — The Real-Time Payments network identification of the transfer.
    - `transaction_id` string, nullable, required — The Transaction funding the transfer once it is complete.
    - `type` 'real_time_payments_transfer', required — A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.
    - `ultimate_creditor_name` string, nullable, required — The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.
    - `ultimate_debtor_name` string, nullable, required — The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.
    - `unstructured_remittance_information` string, required — Unstructured information that will show on the recipient's bank statement.
  - `next_cursor` string, 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`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)