API Reference

Create a Wire bank account

posthttps://api-sandbox.circle.com/v1/businessAccount/banks/wires

Reference
Playground

Body parameters

option 1: US Bank Account

Show 5 properties

idempotencyKey

string

Required

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

accountNumber

string

Required

Account number that identifies the bank account.

routingNumber

string

Required

ABA routing number for the bank account. Note this has to be specific for bank wire transfers.

billingDetails

object

Required

Show 7 properties

name

string

Required

Full name of the card or bank account holder.

city

string

Required

City portion of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

bankAddress

object

Required

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

Show 6 properties

bankName

string

Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'

city

string

City portion of the address. This property is required for bank accounts outside of the US.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.

option 2: Non US Bank Account - IBAN Supported

Show 4 properties

idempotencyKey

string

Required

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

iban

string

Required

International Bank Account Number (IBAN) for the bank account.

billingDetails

object

Required

Show 7 properties

name

string

Required

Full name of the card or bank account holder.

city

string

Required

City portion of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

bankAddress

object

Required

The address of the bank. City and country fields are required.

Show 6 properties

bankName

string

Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'

city

string

Required

City portion of the address. This property is required for bank accounts outside of the US.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.

option 3: Non US Bank Account - IBAN Not Supported

Show 5 properties

idempotencyKey

string

Required

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

accountNumber

string

Required

Account number that identifies the bank account.

routingNumber

string

Required

The bank's SWIFT / BIC code.

billingDetails

object

Required

Show 7 properties

name

string

Required

Full name of the card or bank account holder.

city

string

Required

City portion of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

bankAddress

object

Required

The address of the bank. BankName, City and Country fields are required.

Show 6 properties

bankName

string

Required

Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'

city

string

Required

City portion of the address. This property is required for bank accounts outside of the US.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.

Response

201CreateBusinessWireAccountResponse

Response Body

object

data

object

Show 10 properties

string

Required

Unique system generated identifier for the entity.

status

string

Required

Status of the account. A pending status indicates that the linking is in-progress; complete indicates the account was linked successfully; failed indicates it failed.

Allowed valuespendingcompletefailed

description

string

Required

Bank name plus last four digits of the bank account number or IBAN.

trackingRef

string

Required

Wire tracking ref that needs to be set in the wire reference to beneficiary field.

transferTypesInfo

object

Required

A <TransferType, TransferTypeInfo> map which shows transfer types supported on this account as well as additional information for each.

fingerprint

string

Required

A UUID that uniquely identifies the account number. If the same account is used more than once, each card object will have a different id, but the fingerprint will stay the same.

billingDetails

object

Required

Show 7 properties

name

string

Required

Full name of the card or bank account holder.

city

string

Required

City portion of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

bankAddress

object

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

Show 6 properties

bankName

string

Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'

city

string

City portion of the address. This property is required for bank accounts outside of the US.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.

createDate

string

Required

ISO-8601 UTC date/time format.

updateDate

string

Required

ISO-8601 UTC date/time format.

400BadRequest

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "status": "pending",
5    "description": "WELLS FARGO BANK, NA ****0010",
6    "trackingRef": "CIR13FB13A",
7    "transferTypesInfo": {
8      "wire": {
9        "currencies": [
10          "USD",
11          "EUR"
12        ]
13      },
14      "rtgs": {
15        "currencies": [
16          "USD"
17        ]
18      }
19    },
20    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
21    "billingDetails": {
22      "name": "Satoshi Nakamoto",
23      "city": "Boston",
24      "country": "US",
25      "line1": "100 Money Street",
26      "line2": "Suite 1",
27      "district": "MA",
28      "postalCode": "01234"
29    },
30    "bankAddress": {
31      "bankName": "SAN FRANCISCO",
32      "city": "SAN FRANCISCO",
33      "country": "US",
34      "line1": "100 Money Street",
35      "line2": "Suite 1",
36      "district": "CA"
37    },
38    "createDate": "2020-04-10T02:13:30.000Z",
39    "updateDate": "2020-04-10T02:13:30.000Z"
40  }
41}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy