API Reference — Increase

Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our Wire Drawdown Requests documentation.

The Inbound Wire Drawdown Request object

{
  "amount": 10000,
  "beneficiary_account_number": "987654321",
  "beneficiary_address_line1": "33 Liberty Street",
  "beneficiary_address_line2": "New York, NY, 10045",
  "beneficiary_address_line3": null,
  "beneficiary_name": "Ian Crease",
  "beneficiary_routing_number": "101050001",
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
  "message_to_recipient": "Invoice 29582",
  "originator_account_number": "987654321",
  "originator_address_line1": "33 Liberty Street",
  "originator_address_line2": "New York, NY, 10045",
  "originator_address_line3": null,
  "originator_name": "Ian Crease",
  "originator_routing_number": "101050001",
  "originator_to_beneficiary_information_line1": null,
  "originator_to_beneficiary_information_line2": null,
  "originator_to_beneficiary_information_line3": null,
  "originator_to_beneficiary_information_line4": null,
  "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "type": "inbound_wire_drawdown_request"
}

Attributes

amount

integer

The amount being requested in cents.

beneficiary_account_number

string

The drawdown request's beneficiary's account number.

beneficiary_address_line1

string

Nullable

Line 1 of the drawdown request's beneficiary's address.

beneficiary_address_line2

string

Nullable

Line 2 of the drawdown request's beneficiary's address.

beneficiary_address_line3

string

Nullable

Line 3 of the drawdown request's beneficiary's address.

beneficiary_name

string

Nullable

The drawdown request's beneficiary's name.

beneficiary_routing_number

string

The drawdown request's beneficiary's routing number.

created_at

string

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

currency

string

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

string

The Wire drawdown request identifier.

message_to_recipient

string

Nullable

A message from the drawdown request's originator.

originator_account_number

string

Nullable

The drawdown request's originator's account number.

originator_address_line1

string

Nullable

Line 1 of the drawdown request's originator's address.

originator_address_line2

string

Nullable

Line 2 of the drawdown request's originator's address.

originator_address_line3

string

Nullable

Line 3 of the drawdown request's originator's address.

originator_name

string

Nullable

The drawdown request's originator's name.

originator_routing_number

string

The drawdown request's originator's routing number.

originator_to_beneficiary_information_line1

string

Nullable

Line 1 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line2

string

Nullable

Line 2 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line3

string

Nullable

Line 3 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line4

string

Nullable

Line 4 of the information conveyed from the originator of the message to the beneficiary.

recipient_account_number_id

string

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

type

string

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

List Inbound Wire Drawdown Requests

curl \
  --url "${INCREASE_URL}/inbound_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.

Retrieve an Inbound Wire Drawdown Request

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

Parameters

inbound_wire_drawdown_request_id

string

Required

The identifier of the Inbound Wire Drawdown Request to retrieve.

Sandbox: Create an Inbound Wire Drawdown request

Simulates receiving an Inbound Wire Drawdown Request.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_wire_drawdown_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 10000,
    "beneficiary_account_number": "987654321",
    "beneficiary_address_line1": "33 Liberty Street",
    "beneficiary_address_line2": "New York, NY, 10045",
    "beneficiary_name": "Ian Crease",
    "beneficiary_routing_number": "101050001",
    "currency": "USD",
    "message_to_recipient": "Invoice 29582",
    "originator_account_number": "987654321",
    "originator_address_line1": "33 Liberty Street",
    "originator_address_line2": "New York, NY, 10045",
    "originator_name": "Ian Crease",
    "originator_routing_number": "101050001",
    "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  }'

Parameters

amount

integer

Required

The amount being requested in cents.

beneficiary_account_number

string

Required

The drawdown request's beneficiary's account number.

200 character maximum

beneficiary_address_line1

string

Line 1 of the drawdown request's beneficiary's address.

35 character maximum

beneficiary_address_line2

string

Line 2 of the drawdown request's beneficiary's address.

35 character maximum

beneficiary_address_line3

string

Line 3 of the drawdown request's beneficiary's address.

35 character maximum

beneficiary_name

string

The drawdown request's beneficiary's name.

35 character maximum

beneficiary_routing_number

string

Required

The drawdown request's beneficiary's routing number.

200 character maximum

currency

string

Required

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

200 character maximum

message_to_recipient

string

Required

A message from the drawdown request's originator.

140 character maximum

originator_account_number

string

Required

The drawdown request's originator's account number.

200 character maximum

originator_address_line1

string

Line 1 of the drawdown request's originator's address.

35 character maximum

originator_address_line2

string

Line 2 of the drawdown request's originator's address.

35 character maximum

originator_address_line3

string

Line 3 of the drawdown request's originator's address.

35 character maximum

originator_name

string

The drawdown request's originator's name.

35 character maximum

originator_routing_number

string

Required

The drawdown request's originator's routing number.

200 character maximum

originator_to_beneficiary_information_line1

string

Line 1 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum

originator_to_beneficiary_information_line2

string

Line 2 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum

originator_to_beneficiary_information_line3

string

Line 3 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum

originator_to_beneficiary_information_line4

string

Line 4 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum

recipient_account_number_id

string

Required

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