# Inbound Wire Drawdown Requests
> Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).

[Events](https://increase.com/documentation/events.md) will be generated for this resource. The possible event categories are:  and `inbound_wire_drawdown_request.created`.

## The Inbound Wire Drawdown Request object
### Example
```json
{
  "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](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire drawdown request 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](https://en.wikipedia.org/wiki/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.

- `id` (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.

- `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](https://www.swift.com/payments/what-unique-end-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
GET /inbound_wire_drawdown_requests

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

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

### Returns a Inbound Wire Drawdown Request List object:
```json
{
  "data": [
    {
      "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
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Retrieve an Inbound Wire Drawdown Request
GET /inbound_wire_drawdown_requests/{inbound_wire_drawdown_request_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/inbound_wire_drawdown_requests/inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path 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
POST /simulations/inbound_wire_drawdown_requests
> Simulates receiving an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
### Example
```curl
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"
  }'
```

### Body Parameters
- `amount` (integer, required)
  The amount being requested in cents.

- `creditor_account_number` (string, required)
  The creditor's account number.

- `creditor_address_line1` (string, optional)
  A free-form address field set by the sender representing the first line of the creditor's address.

- `creditor_address_line2` (string, optional)
  A free-form address field set by the sender representing the second line of the creditor's address.

- `creditor_address_line3` (string, optional)
  A free-form address field set by the sender representing the third line of the creditor's address.

- `creditor_name` (string, optional)
  A free-form name field set by the sender representing the creditor's name.

- `creditor_routing_number` (string, required)
  The creditor's routing number.

- `currency` (string, required)
  The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".

- `debtor_account_number` (string, optional)
  The debtor's account number.

- `debtor_address_line1` (string, optional)
  A free-form address field set by the sender representing the first line of the debtor's address.

- `debtor_address_line2` (string, optional)
  A free-form address field set by the sender representing the second line of the debtor's address.

- `debtor_address_line3` (string, optional)
  A free-form address field set by the sender.

- `debtor_name` (string, optional)
  A free-form name field set by the sender representing the debtor's name.

- `debtor_routing_number` (string, optional)
  The debtor's routing number.

- `end_to_end_identification` (string, optional)
  A free-form reference string set by the sender, to help identify the transfer.

- `instruction_identification` (string, optional)
  The sending bank's identifier for the wire transfer.

- `recipient_account_number_id` (string, required)
  The Account Number to which the recipient of this request is being requested to send funds from.

- `unique_end_to_end_transaction_reference` (string, optional)
  The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.

- `unstructured_remittance_information` (string, optional)
  A free-form message set by the sender.