Create a Wire Drawdown Request

Changed on
post/wire_drawdown_requests

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/wire_drawdown_requests
  • Auth
    HTTP bearer

Request body

account_number_idstring required

The Account Number to which the debtor should send funds.

amountinteger required

The amount requested from the debtor, in USD cents.

charge_bearer'shared' | 'debtor' | 'creditor' | 'service_level'

Determines who bears the cost of the drawdown request. Defaults to shared if not specified.

creditor_namestring required

The creditor's name.

debtor_account_numberstring

The debtor's account number.

debtor_external_account_idstring

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

The debtor's name.

debtor_routing_numberstring

The debtor's routing number.

end_to_end_identificationstring

A free-form reference string set by the sender mirrored back in the subsequent wire transfer.

unstructured_remittance_informationstring required

Remittance information the debtor will see as part of the request.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 10000,
  "creditor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "postal_code": "10045",
    "state": "NY"
  },
  "creditor_name": "National Phonograph Company",
  "debtor_account_number": "987654321",
  "debtor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "postal_code": "10045",
    "state": "NY"
  },
  "debtor_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "unstructured_remittance_information": "Invoice 29582"
}

Response

Wire Drawdown Request

account_idstring required

The Account to which the debtor—the recipient of this request—is being requested to send funds.

account_number_idstring required

The Account Number to which the debtor—the recipient of this request—is being requested to send funds.

amountinteger required

The amount being requested in cents.

created_atstring date-time required

The ISO 8601 date and time at which the wire drawdown request was created.

creditor_namestring required

The creditor's name.

currencystring required

The ISO 4217 code for the amount being requested. Will always be "USD".

debtor_account_numberstring required

The debtor's account number.

debtor_external_account_idstring nullable required

The debtor's external account identifier.

debtor_namestring required

The debtor's name.

debtor_routing_numberstring required

The debtor's routing number.

end_to_end_identificationstring nullable required

A free-form reference string set by the sender, to be mirrored back in the subsequent wire transfer.

fulfillment_inbound_wire_transfer_idstring nullable required

If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.

idstring required

The Wire drawdown request 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.

status'pending_submission' | 'pending_response' | 'fulfilled' | 'refused' required

The lifecycle status of the drawdown request.

type'wire_drawdown_request' required

A constant representing the object's type. For this resource it will always be wire_drawdown_request.

unique_end_to_end_transaction_referencestring nullable required

The unique end-to-end transaction reference (UETR) of the drawdown request.

unstructured_remittance_informationstring required

Remittance information the debtor will see as part of the drawdown request.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 10000,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "debtor_external_account_id": null,
  "debtor_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "end_to_end_identification": "Invoice 29582",
  "fulfillment_inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3",
  "idempotency_key": null,
  "status": "fulfilled",
  "submission": {
    "input_message_accountability_data": "20220118MMQFMP0P000003"
  },
  "type": "wire_drawdown_request",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "Invoice 29582"
}

Changes

  • 21462c0df069Revision changes
    • info

      added the required property to the response with the status

  • 64a92a8cc343Revision changes
    • breaking

      the / request property's minLength was increased from 1 to 2

    • breaking

      the / request property's minLength was increased from 1 to 2

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status