increase-test
POST/wire_drawdown_requests

Create a wire drawdown request

Creates a wire drawdown request asking a debtor to send funds to an account number. Supply the requested amount, creditor details, debtor details, and remittance information; use either debtor_external_account_id or the debtor account and routing numbers.

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

12 body fields

Wire drawdown request details, including the destination account number, requested amount, and debtor and creditor information.

account_number_idstringrequired
The Account Number to which the debtor should send funds.
amountintegerrequired
The amount requested from the debtor, in USD cents.
charge_bearerstringoptional
Determines who bears the cost of the drawdown request. Defaults to `shared` if not specified.
Allowed:shareddebtorcreditorservice_level
creditor_addressobjectrequired
The creditor's address.
creditor_namestringrequired
The creditor's name.
debtor_account_numberstringoptional
The debtor's account number.
debtor_addressobjectrequired
The debtor's address.
debtor_external_account_idstringoptional
The ID of an External Account to initiate a transfer to. If this parameter is provided, `debtor_account_number` and `debtor_routing_number` must be absent.
debtor_namestringrequired
The debtor's name.
debtor_routing_numberstringoptional
The debtor's routing number.
end_to_end_identificationstringoptional
A free-form reference string set by the sender mirrored back in the subsequent wire transfer.
unstructured_remittance_informationstringrequired
Remittance information the debtor will see as part of the request.

3 status codes
200Returns the created wire drawdown request, including its identifier, requested amount, account details, and debtor and creditor information.
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 results in a client error.
5XXReturned when the request results in a server error.

Error handling

account_number_id, amount, unstructured_remittance_information, debtor_name, debtor_address, creditor_name, and creditor_address are required. amount must be between 1 and 999999999999 cents; each address must include line1, city, and country, and country must be a two-character code. If you provide debtor_external_account_id, omit debtor_account_number and debtor_routing_number.