increase-test
POST/simulations/fednow_transfers/{fednow_transfer_id}/complete

Complete a FedNow transfer in the sandbox

Simulates submitting a FedNow Transfer and processing the response from the destination financial institution. Use this operation for a transfer with status pending_submitting; you can optionally simulate rejection by supplying rejection.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
fednow_transfer_idstringrequired
The identifier of the FedNow Transfer to complete.

Optional configuration for simulating the destination institution's response.

rejectionobjectoptional
If set, the simulation will reject the transfer.

3 status codes
200Returns the FedNow Transfer object with the outcome of the simulated destination-institution processing.
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.
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_addressobjectrequired
The creditor's address.
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 FedNow transfers this is always equal to `USD`.
Allowed:USD
debtor_addressobjectrequired
The debtor's address.
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 FedNow 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).
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer.
rejectionobjectrequired
If the transfer is rejected by FedNow or the destination financial institution, this will contain supplemental details.
returnsarray<FedNowTransferFedNowTransferReturn>required
If the transfer is returned by the recipient's bank, this will contain details of each return. FedNow allows returning part of a transfer, so a transfer can be returned more than once.
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.
Allowed:pending_submittingpending_reviewingcanceledrequires_attentionpending_approvalpending_responsecompleterejectedreturned
submissionobjectrequired
After the transfer is submitted to FedNow, 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 `fednow_transfer`.
Allowed:fednow_transfer
unique_end_to_end_transaction_referencestringrequired
The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.
unstructured_remittance_informationstringrequired
Unstructured information that will show on the recipient's bank statement.
4XXReturned when the request cannot be processed because of a client error.
5XXReturned when the request cannot be processed because of a server error.

Error handling

The fednow_transfer_id path parameter must identify a FedNow Transfer with status pending_submitting. If you supply rejection, it must include reject_reason_code with an accepted rejection reason code.