POST
/simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/completeComplete a Real-Time Payments transfer in the sandbox
Simulates completion of a Real-Time Payments transfer by handling the destination financial institution's response. The transfer must have a pending_submission status before you complete it. Set rejection to simulate a rejection with a reject_reason_code, or omit it to simulate completion without rejection.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
real_time_payments_transfer_idstringrequired
The identifier of the Real-Time Payments transfer to complete.
Optional rejection configuration for the simulated transfer completion.
rejectionobjectoptional
If set, the simulation will reject the transfer.
200Returns the updated Real-Time Payments transfer, including its identifier, amount, currency, account, recipient, and current status.
account_idstringrequired
The Account from which the transfer was sent.
account_numberstringrequired
The destination account number.
acknowledgementobjectrequired
If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
amountintegerrequired
The transfer amount in USD cents.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
creditor_namestringrequired
The name of the transfer's recipient. This is set by the sender when creating the transfer.
currencystringrequired
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_namestringrequired
The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
external_account_idstringrequired
The identifier of the External Account the transfer was made to, if any.
idstringrequired
The Real-Time Payments Transfer's identifier.
idempotency_keystringrequired
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).
inbound_real_time_payments_request_for_payment_idstringrequired
The identifier of the Inbound Real-Time Payments Request for Payment this transfer was sent in response to, if any.
pending_transaction_idstringrequired
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.
rejectionobjectrequired
If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
routing_numberstringrequired
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
source_account_number_idstringrequired
The Account Number the recipient will see as having sent the transfer.
statusstringrequired
The lifecycle status of the transfer.
submissionobjectrequired
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
transaction_idstringrequired
The Transaction funding the transfer once it is complete.
typestringrequired
A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.
ultimate_creditor_namestringrequired
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_namestringrequired
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_informationstringrequired
Unstructured information that will show on the recipient's bank statement.
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.
Error handling
The real_time_payments_transfer_id path parameter must identify a transfer with pending_submission status. If you set rejection, include reject_reason_code; accepted values include account_closed, account_blocked, narrative, and transaction_forbidden.