increase-test
POST/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit

Submit a Wire Drawdown Request to Fedwire in the sandbox

Simulates submitting a Wire Drawdown Request to Fedwire. Use this operation to test the submission flow for a request. The Wire Drawdown Request must be in a state that can be submitted.

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

1 parameter
wire_drawdown_request_idstringrequired
The identifier of the Wire Drawdown Request to submit.

3 status codes
200Returns the updated Wire Drawdown Request, including its identifier, requested amount, accounts, and debtor details.
account_idstringrequired
The Account to which the debtor—the recipient of this request—is being requested to send funds.
account_number_idstringrequired
The Account Number to which the debtor—the recipient of this request—is being requested to send funds.
amountintegerrequired
The amount being requested in cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the wire drawdown request was created.
creditor_addressobjectrequired
The creditor's address.
creditor_namestringrequired
The creditor's name.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
debtor_account_numberstringrequired
The debtor's account number.
debtor_addressobjectrequired
The debtor's address.
debtor_external_account_idstringrequired
The debtor's external account identifier.
debtor_namestringrequired
The debtor's name.
debtor_routing_numberstringrequired
The debtor's routing number.
end_to_end_identificationstringrequired
A free-form reference string set by the sender, to be mirrored back in the subsequent wire transfer.
fulfillment_inbound_wire_transfer_idstringrequired
If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.
idstringrequired
The Wire drawdown request 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).
statusstringrequired
The lifecycle status of the drawdown request.
Allowed:pending_submissionfulfilledpending_responserefused
submissionobjectrequired
After the drawdown request is submitted to Fedwire, this will contain supplemental details.
typestringrequired
A constant representing the object's type. For this resource it will always be `wire_drawdown_request`.
Allowed:wire_drawdown_request
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 drawdown request.
unstructured_remittance_informationstringrequired
Remittance information the debtor will see as part of the drawdown request.
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

The wire_drawdown_request_id path parameter must identify the Wire Drawdown Request to submit. The request must be in a state that can be submitted to Fedwire.