Get wallet accounts

GET 
/v2/customers/:customerId/accounts

Get accounts

Request

Path Parameters

customerId stringrequired

Query Parameters

currency string

Get account for specific currency

Responses

200

OK

application/json

Schema

Schema

• Array [

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.

• ]

Example (from schema)

[
  {
    "id": "string",
    "customerId": "5435323362",
    "externalId": "string",
    "currencyCode": "EUR",
    "totalBalance": 0,
    "availableBalance": 0,
    "virtualInstrument": [
      {
        "instrumentType": "SEPA_BANK_ACCOUNT",
        "status": "ACTIVE"
      }
    ],
    "virtualAccountAssignmentStatus": [
      {
        "instrumentType": "SEPA_BANK_ACCOUNT",
        "requestDate": "2019-08-24T14:15:22Z",
        "lastChangeDate": "2019-08-24T14:15:22Z",
        "status": "COMPLETED",
        "statusReason": "Request has been denied by the issuing bank."
      }
    ],
    "creationTime": "2019-08-24T14:15:22Z",
    "virtualAccountAssignment": false
  }
]

ACCOUNTS

[
  {
    "id": "509876034",
    "customerId": "5435323362",
    "currencyCode": "GBP",
    "totalBalance": 55000,
    "availableBalance": 50000,
    "creationTime": "2019-08-24T14:15:22Z",
    "hasVirtualInstrument": false
  }
]

application/xml

Schema

Schema

• Array [

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.

• ]

Example (from schema)

<0>
  <id>string</id>
  <customerId>5435323362</customerId>
  <externalId>string</externalId>
  <currencyCode>EUR</currencyCode>
  <totalBalance>0</totalBalance>
  <availableBalance>0</availableBalance>
  <virtualInstrument>
    <instrumentType>SEPA_BANK_ACCOUNT</instrumentType>
    <status>ACTIVE</status>
  </virtualInstrument>
  <virtualAccountAssignmentStatus>
    <instrumentType>SEPA_BANK_ACCOUNT</instrumentType>
    <requestDate>2019-08-24T14:15:22Z</requestDate>
    <lastChangeDate>2019-08-24T14:15:22Z</lastChangeDate>
    <status>COMPLETED</status>
    <statusReason>Request has been denied by the issuing bank.</statusReason>
  </virtualAccountAssignmentStatus>
  <creationTime>2019-08-24T14:15:22Z</creationTime>
  <virtualAccountAssignment>false</virtualAccountAssignment>
</0>

400

Bad Request

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INVALID_CUSTOMER_ID

{
  "error": {
    "code": "DW-CUSTOMER-ID-SHOULD-BE-VALID",
    "message": "CustomerId is not supported",
    "details": [
      "CustomerId should be a valid value"
    ]
  }
}

404

Not found

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

NOT_FOUND

{
  "error": {
    "code": "5269",
    "message": "Entity not found",
    "details": [
      "The ID(s) specified in the URL do not correspond to the values in the system."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_SERVER_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error",
    "details": [
      "There was an error while processing the operation"
    ]
  }
}

503

Service Unavailable. Please try again later.

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

SERVICE_UNAVAILABLE

{
  "error": {
    "code": "DW-SERVICE-UNAVAILABLE",
    "message": "Service Unavailable",
    "details": [
      "Service Unavailable"
    ]
  }
}

Loading...