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,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_account_number": "987654321",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_address_line3": null,
  "creditor_name": "Ian Crease",
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_address_line3": null,
  "debtor_name": "Ian Crease",
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
  "input_message_accountability_data": null,
  "instruction_identification": null,
  "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "type": "inbound_wire_drawdown_request",
  "unique_end_to_end_transaction_reference": null,
  "unstructured_remittance_information": null
}

Attributes

amount

integer

The amount being requested in cents.

created_at

string

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

creditor_account_number

string

The creditor's account number.

creditor_address_line1

string

Nullable

A free-form address field set by the sender.

creditor_address_line2

string

Nullable

A free-form address field set by the sender.

creditor_address_line3

string

Nullable

A free-form address field set by the sender.

creditor_name

string

Nullable

A name set by the sender.

creditor_routing_number

string

The creditor's routing number.

currency

string

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

debtor_address_line1

string

Nullable

A free-form address field set by the sender.

debtor_address_line2

string

Nullable

A free-form address field set by the sender.

debtor_address_line3

string

Nullable

A free-form address field set by the sender.

debtor_name

string

Nullable

A name set by the sender.

end_to_end_identification

string

Nullable

A free-form reference string set by the sender, to help identify the drawdown request.

string

The Wire drawdown request identifier.

input_message_accountability_data

string

Nullable

A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.

instruction_identification

string

Nullable

The sending bank's identifier for the drawdown request.

recipient_account_number_id

string

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

More about Account Numbers.

type

string

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

unique_end_to_end_transaction_reference

string

Nullable

The Unique End-to-end Transaction Reference (UETR) of the drawdown request.

unstructured_remittance_information

string

Nullable

A free-form message set by the sender.

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.

More about Inbound Wire Drawdown Requests.

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,
    "creditor_account_number": "987654321",
    "creditor_address_line1": "33 Liberty Street",
    "creditor_address_line2": "New York, NY, 10045",
    "creditor_name": "Ian Crease",
    "creditor_routing_number": "101050001",
    "currency": "USD",
    "debtor_account_number": "987654321",
    "debtor_address_line1": "33 Liberty Street",
    "debtor_address_line2": "New York, NY, 10045",
    "debtor_name": "Ian Crease",
    "debtor_routing_number": "101050001",
    "instruction_identification": null,
    "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  }'

Parameters

amount

integer

Required

The amount being requested in cents.

creditor_account_number

string

Required

The creditor's account number.

200 character maximum

creditor_address_line1

string

A free-form address field set by the sender representing the first line of the creditor's address.

200 character maximum

creditor_address_line2

string

A free-form address field set by the sender representing the second line of the creditor's address.

200 character maximum

creditor_address_line3

string

A free-form address field set by the sender representing the third line of the creditor's address.

200 character maximum

creditor_name

string

A free-form name field set by the sender representing the creditor's name.

200 character maximum

creditor_routing_number

string

Required

The creditor'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

debtor_account_number

string

The debtor's account number.

200 character maximum

debtor_address_line1

string

A free-form address field set by the sender representing the first line of the debtor's address.

200 character maximum

debtor_address_line2

string

A free-form address field set by the sender representing the second line of the debtor's address.

200 character maximum

debtor_address_line3

string

A free-form address field set by the sender.

200 character maximum

debtor_name

string

A free-form name field set by the sender representing the debtor's name.

200 character maximum

debtor_routing_number

string

The debtor's routing number.

200 character maximum

end_to_end_identification

string

A free-form reference string set by the sender, to help identify the transfer.

200 character maximum

instruction_identification

string

The sending bank's identifier for the wire transfer.

200 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.

More about Account Numbers.

unique_end_to_end_transaction_reference

string

The Unique End-to-end Transaction Reference (UETR) of the transfer.

200 character maximum

unstructured_remittance_information

string

A free-form message set by the sender.

200 character maximum