v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

List Wire Drawdown Requests

get/wire_drawdown_requests

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

status.instring[]

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_keystring

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.

Response

Wire Drawdown Request List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "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",
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}