Get a Wire bank account

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved a bank account for wire transfers.

data

object

Show child attributes

data.id

string<uuid>

required

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.status

enum<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.

Available options:

pending,

complete,

failed

data.description

string

required

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

Example:

"WELLS FARGO BANK, NA ****0010"

data.trackingRef

string

required

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

Example:

"CIR13FB13A"

data.transferTypesInfo

object

required

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

Show child attributes

data.transferTypesInfo.{key}

object

Additional information for specific transfer type.

Show child attributes

data.transferTypesInfo.{key}.currencies

enum<string>[]

required

Currency code.

Available options:

USD,

EUR,

MXN,

SGD,

BRL

data.transferTypesInfo.{key}.additionalProperties

object

Additional properties that apply to specific transfer type.

Show child attributes

data.transferTypesInfo.{key}.additionalProperties.transactionLimits

integer

Transaction amount limit for the transfer type.

Example:

100000

Example:

{
  "wire": { "currencies": ["USD", "EUR"] },
  "rtgs": { "currencies": ["USD"] }
}

data.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.

Example:

"eb170539-9e1c-4e92-bf4f-1d09534fdca2"

data.billingDetails

object

required

Show child attributes

data.billingDetails.name

string

required

Full name of the card or bank account holder.

Maximum string length: 1024

Example:

"Satoshi Nakamoto"

data.billingDetails.city

string

required

City portion of the address.

Maximum string length: 1024

Example:

"Boston"

data.billingDetails.country

string

required

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

Maximum string length: 2

Example:

"US"

data.billingDetails.line1

string

required

Line one of the street address.

Maximum string length: 1024

Example:

"100 Money Street"

data.billingDetails.postalCode

string

required

Postal / ZIP code of the address.

Maximum string length: 16

Example:

"01234"

data.billingDetails.line2

string

Line two of the street address.

Maximum string length: 1024

Example:

"Suite 1"

data.billingDetails.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.

Maximum string length: 16

Example:

"MA"

data.createDate

string

required

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.updateDate

string

required

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.bankAddress

object

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

Show child attributes

data.bankAddress.country

string

required

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

Maximum string length: 2

Example:

"US"

data.bankAddress.bankName

string

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

Maximum string length: 35

Example:

"SAN FRANCISCO"

data.bankAddress.city

string

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

Maximum string length: 35

Example:

"SAN FRANCISCO"

data.bankAddress.line1

string

Line one of the street address.

Maximum string length: 35

Example:

"100 Money Street"

data.bankAddress.line2

string

Line two of the street address.

Maximum string length: 35

Example:

"Suite 1"

data.bankAddress.district

string

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

Maximum string length: 16

Example:

"CA"

Core API

API Overview

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Get a Wire bank account

Authorizations

Path Parameters

Response