---
title: "Sandbox: Create an Inbound Real-Time Payments Transfer"
method: POST
path: "/simulations/inbound_real_time_payments_transfers"
---

# Sandbox: Create an Inbound Real-Time Payments Transfer

`POST /simulations/inbound_real_time_payments_transfers`

Simulates an [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to your account. Real-Time Payments are a beta feature.

## Request body

- SandboxCreateAnInboundRealTimePaymentsTransferParameters
  - `account_number_id` string, required — The identifier of the Account Number the inbound Real-Time Payments Transfer is for.
  - `amount` integer, required — The transfer amount in USD cents. Must be positive.
  - `debtor_account_number` string — The account number of the account that sent the transfer.
  - `debtor_name` string — The name provided by the sender of the transfer.
  - `debtor_routing_number` string — The routing number of the account that sent the transfer.
  - `request_for_payment_id` string — The identifier of a pending Request for Payment that this transfer will fulfill.
  - `unstructured_remittance_information` string — Additional information included with the transfer.

## Response `200`

Inbound Real-Time Payments Transfer

- InboundRealTimePaymentsTransfer — An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.
  - `account_id` string, required — The Account to which the transfer was sent.
  - `account_number_id` string, required — The identifier of the Account Number to which this transfer was sent.
  - `amount` integer, required — The amount in USD cents.
  - `confirmation` object, nullable, required — If your transfer is confirmed, this will contain details of the confirmation.
    - `confirmed_at` string, date-time, required — The time at which the transfer was confirmed.
    - `transaction_id` string, required — The id of the transaction for the confirmed transfer.
  - `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.
  - `creditor_name` string, required — The name the sender of the transfer specified as the recipient of the transfer.
  - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
  - `debtor_account_number` string, required — The account number of the account that sent the transfer.
  - `debtor_name` string, required — The name provided by the sender of the transfer.
  - `debtor_routing_number` string, required — The routing number of the account that sent the transfer.
  - `decline` object, nullable, required — If your transfer is declined, this will contain details of the decline.
    - `declined_at` string, date-time, required — The time at which the transfer was declined.
    - `declined_transaction_id` string, required — The id of the transaction for the declined transfer.
    - `reason` 'account_number_canceled' | 'account_number_disabled' | 'account_restricted' | 'group_locked' | 'entity_not_active' | 'real_time_payments_not_enabled', required — The reason for the transfer decline.
  - `id` string, required — The inbound Real-Time Payments transfer's identifier.
  - `status` 'pending_confirming' | 'timed_out' | 'confirmed' | 'declined', required — The lifecycle status of the transfer.
  - `transaction_identification` string, required — The Real-Time Payments network identification of the transfer.
  - `type` 'inbound_real_time_payments_transfer', required — A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer`.
  - `unstructured_remittance_information` string, nullable, required — Additional information included with the transfer.

## 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/c6111f49e8b7/schema)