Create a Wire bank account
POST {{baseUrl}}/v1/businessAccount/banks/wires
Body Params
Option 1
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)
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.
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
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)
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.
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
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)
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.
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.
Request Body
{"idempotencyKey"=>"{{$guid}}", "accountNumber"=>"12340010", "routingNumber"=>"121000248", "billingDetails"=>{"name"=>"Satoshi Nakamoto", "city"=>"Boston", "country"=>"US", "line1"=>"100 Money Street", "postalCode"=>"01234", "line2"=>"Suite 1", "district"=>"MA"}, "bankAddress"=>{"country"=>"US", "bankName"=>"SAN FRANCISCO", "city"=>"SAN FRANCISCO", "line1"=>"100 Money Street", "line2"=>"Suite 1", "district"=>"CA"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"id":"8af774bb-a726-40a2-9e33-bd75f0b02fbe","status":"pending","description":"Commerzbank GF-B48 ****3000","trackingRef":"CIR2AZYEHT","fingerprint":"bcd8d325-6229-4594-a89b-0790143e0489","virtualAccountEnabled":true,"billingDetails":{"name":"Satoshi Nakamoto","line1":"100 Money Street","line2":"Suite 1","city":"Boston","postalCode":"01234","district":"MA","country":"US"},"bankAddress":{"bankName":"Commerzbank GF-B48","city":"Kassel","country":"DE"},"createDate":"2024-01-16T21:53:08.104Z","updateDate":"2024-01-16T21:53:08.104Z"}}