v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Sandbox: Complete a Real-Time Payments Transfer

Simulates submission of a Real-Time Payments Transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.

post/simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete

Path parameters

real_time_payments_transfer_idstring required

The identifier of the Real-Time Payments Transfer you wish to complete.

Request body

Example request

{}

Response

Real-Time Payments Transfer

account_idstring required

The Account from which the transfer was sent.

account_numberstring required

The destination account number.

amountinteger required

The transfer amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

creditor_namestring required

The name of the transfer's recipient. This is set by the sender when creating the transfer.

currency'USD' required

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

debtor_namestring nullable required

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

external_account_idstring nullable required

The identifier of the External Account the transfer was made to, if any.

idstring required

The Real-Time Payments Transfer's identifier.

idempotency_keystring 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.

pending_transaction_idstring nullable required

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

routing_numberstring required

The destination American Bankers' Association (ABA) Routing Transit Number (RTN).

source_account_number_idstring required

The Account Number the recipient will see as having sent the transfer.

The lifecycle status of the transfer.

transaction_idstring 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_namestring 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_namestring 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_informationstring required

Unstructured information that will show on the recipient's bank statement.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "acknowledgement": {
    "acknowledged_at": "2020-01-31T23:59:59Z"
  },
  "amount": 100,
  "approval": null,
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_name": null,
  "external_account_id": null,
  "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
  "idempotency_key": null,
  "pending_transaction_id": null,
  "rejection": null,
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "complete",
  "submission": {
    "submitted_at": "2020-01-31T23:59:59Z",
    "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"
}