Skip to main content
POST
/
v1
/
banks
/
wires
Create a wire bank account
curl --request POST \
  --url https://api-sandbox.circle.com/v1/banks/wires \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "accountNumber": "12340010",
  "routingNumber": "121000248",
  "billingDetails": {
    "name": "Satoshi Nakamoto",
    "city": "Boston",
    "country": "US",
    "line1": "100 Money Street",
    "postalCode": "01234",
    "line2": "Suite 1",
    "district": "MA",
    "valid": true
  },
  "bankAddress": {
    "country": "US",
    "bankName": "SAN FRANCISCO",
    "city": "SAN FRANCISCO",
    "line1": "100 Money Street",
    "line2": "Suite 1",
    "district": "CA"
  },
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890"
}
'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "status": "pending",
    "description": "WELLS FARGO BANK, NA ****0010",
    "trackingRef": "<string>",
    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
    "billingDetails": {
      "name": "Satoshi Nakamoto",
      "city": "Boston",
      "country": "US",
      "line1": "100 Money Street",
      "postalCode": "01234",
      "line2": "Suite 1",
      "district": "MA",
      "valid": true
    },
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z",
    "type": "wire",
    "bankAddress": {
      "country": "US",
      "bankName": "SAN FRANCISCO",
      "city": "SAN FRANCISCO",
      "line1": "100 Money Street",
      "line2": "Suite 1",
      "district": "CA"
    },
    "virtualAccountEnabled": false,
    "ffcMemo": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request object used to create a bank account for wire transfers. Wraps the standard wire creation request with an optional clientEntityId for 3rd-party flows.

​
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

​
accountNumber
string
required

Account number that identifies the bank account.

Required string length: 6 - 35
Example:

"12340010"

​
routingNumber
string
required

ABA routing number for the bank account.

Example:

"121000248"

​
billingDetails
object
required
​
bankAddress
object
required

The address details for the bank, as provided during bank account creation.

​
clientEntityId
string<uuid>

Identifier of the client entity. Required for 3rd-party flows.

Example:

"a3f1b2c4-d5e6-7890-abcd-ef1234567890"

Response

Successfully created a bank account for wire transfers.

​
data
object

A wire bank account summary.