Account

id string

Possible values: <= 20 characters

Account id.

customerId string

Possible values: <= 20 characters

externalId string

Possible values: <= 40 characters

currencyCode Currency (string)required

Possible values: >= 3 characters and <= 3 characters

Currency alphabetic code as specified by ISO 4217

totalBalance int64

Amount in minor units

availableBalance int64

Amount in minor units

virtualInstrument

object[]

Array [

instrumentType

string

required

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Instrument type.

SEPA_BANK_ACCOUNT

iban stringrequired

The International Bank Account Number (IBAN) of the account.

bic stringrequired

The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

UK_BANK_ACCOUNT

accountNumber stringrequired

A bank account number.

sortCode stringrequired

Use our sort code checker to easily find and check UK sort codes.

US_BANK_ACCOUNT

accountNumber stringrequired

Possible values: >= 4 characters and <= 17 characters

This is the bank account number.

routingNumber stringrequired

Possible values: >= 9 characters and <= 9 characters

For USD accounts, this is the 9-digit routing number of the bank.

status string

Possible values: [ACTIVE]

Instrument status.

]

virtualAccountAssignmentStatus

object[]

Array [

instrumentType VirtualInstrumentType (string)required

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Instrument type.

requestDate date-timerequired

lastChangeDate date-time

status stringrequired

Possible values: [ACCEPTED, PENDING, COMPLETED, REJECTED, FAILED]

Status of the virtual payment instrument request.

statusReason string

Additional information for the current status of the virtual payment instrument request.

]

creationTime date-time
hasVirtualInstrument booleandeprecated
virtualAccountAssignment boolean

Create a virtual banking account for this e-money account.