API Reference — Increase

Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our Wire Drawdown Requests documentation.

The Wire Drawdown Request object

{
  "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_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "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",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_number_id

string

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

amount

integer

The amount being requested in cents.

created_at

string

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

creditor_address

dictionary

The creditor's address.

creditor_name

string

The creditor's name.

currency

string

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

debtor_account_number

string

The debtor's account number.

debtor_address

dictionary

The debtor's address.

debtor_name

string

The debtor's name.

debtor_routing_number

string

The debtor's routing number.

fulfillment_inbound_wire_transfer_id

string

Nullable

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

string

The Wire drawdown request identifier.

idempotency_key

string

Nullable

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

enum

The lifecycle status of the drawdown request.

submission

dictionary

Nullable

After the drawdown request is submitted to Fedwire, this will contain supplemental details.

type

string

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

unstructured_remittance_information

string

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

Sandbox: Refuse a Wire Drawdown Request

Simulates a Wire Drawdown Request being refused by the debtor.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3/refuse" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

wire_drawdown_request_id

string

Required

The identifier of the Wire Drawdown Request you wish to refuse.

List Wire Drawdown Requests

curl \
  --url "${INCREASE_URL}/wire_drawdown_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in

array of strings

Filter Wire Drawdown Requests for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

Create a Wire Drawdown Request

curl -X "POST" \
  --url "${INCREASE_URL}/wire_drawdown_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "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"
  }'

Parameters

account_number_id

string

Required

The Account Number to which the debtor should send funds.

amount

integer

Required

The amount requested from the debtor, in USD cents.

creditor_address

dictionary

Required

The creditor's address.

creditor_name

string

Required

The creditor's name.

140 character maximum

debtor_account_number

string

Required

The debtor's account number.

34 character maximum

debtor_address

dictionary

Required

The debtor's address.

debtor_name

string

Required

The debtor's name.

140 character maximum

debtor_routing_number

string

Required

The debtor's routing number.

9 character maximum

unstructured_remittance_information

string

Required

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

140 character maximum

Retrieve a Wire Drawdown Request

curl \
  --url "${INCREASE_URL}/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

wire_drawdown_request_id

string

Required

The identifier of the Wire Drawdown Request to retrieve.