v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

Create a Wire Transfer

post/wire_transfers

Request body

account_idstring required

The identifier for the account that will send the transfer.

account_numberstring

The account number for the destination account.

amountinteger required

The transfer amount in USD cents.

external_account_idstring

The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number and routing_number must be absent.

inbound_wire_drawdown_request_idstring

The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.

require_approvalboolean

Whether the transfer requires explicit approval via the dashboard or API.

routing_numberstring

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

source_account_number_idstring

The ID of an Account Number that will be passed to the wire's recipient

Example request

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "amount": 100,
  "creditor": {
    "address": {
      "unstructured": {
        "line1": "33 Liberty Street",
        "line2": "New York",
        "line3": "NY 10045"
      }
    },
    "name": "Ian Crease"
  },
  "remittance": {
    "category": "unstructured",
    "unstructured": {
      "message": "New account transfer"
    }
  },
  "routing_number": "101050001"
}

Response

Wire Transfer

account_idstring required

The Account to which the transfer belongs.

account_numberstring required

The destination account number.

amountinteger required

The transfer amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

currency'USD' required

The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.

external_account_idstring nullable required

The identifier of the External Account the transfer was made to, if any.

idstring required

The wire transfer's identifier.

idempotency_keystring nullable required

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.

inbound_wire_drawdown_request_idstring nullable required

The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.

network'wire' required

The transfer's network.

pending_transaction_idstring nullable required

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

routing_numberstring required

The American Bankers' Association (ABA) Routing Transit Number (RTN).

source_account_number_idstring nullable required

The Account Number that was passed to the wire's recipient.

The lifecycle status of the transfer.

transaction_idstring nullable required

The ID for the transaction funding the transfer.

type'wire_transfer' required

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

unique_end_to_end_transaction_referencestring nullable required

The unique end-to-end transaction reference (UETR) of the transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "amount": 100,
  "approval": {
    "approved_at": "2020-01-31T23:59:59Z",
    "approved_by": null
  },
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor": {
    "address": {
      "unstructured": {
        "line1": "1500 Pennsylvania Avenue, NW",
        "line2": "Washington, DC 20220",
        "line3": null
      }
    },
    "name": "National Phonograph Company"
  },
  "currency": "USD",
  "debtor": {
    "address": {
      "unstructured": {
        "line1": "33 Liberty Street",
        "line2": "New York, NY 10045",
        "line3": null
      }
    },
    "name": "Ian Crease"
  },
  "external_account_id": "external_account_ukk55lr923a3ac0pp7iv",
  "id": "wire_transfer_5akynk7dqsq25qwk9q2u",
  "idempotency_key": null,
  "inbound_wire_drawdown_request_id": null,
  "network": "wire",
  "pending_transaction_id": null,
  "remittance": {
    "category": "unstructured",
    "unstructured": {
      "message": "Invoice 29582"
    }
  },
  "reversal": null,
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "complete",
  "submission": {
    "input_message_accountability_data": "20220118MMQFMP0P000002",
    "submitted_at": "2020-01-31T23:59:59Z"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "wire_transfer",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a"
}