Get Wallet Accounts
GET/profile/accounts
Returns account information for the logged in customer.
Request
Query Parameters
Possible values: >= 3 characters
and <= 3 characters
Get account for specific currency
Responses
- 200
- 401
- 500
- 503
OK
- application/json
- application/xml
- Schema
- Example (from schema)
- ACCOUNTS
Schema
Array [
Array [
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
- VISA - VISA
- MC - Mastercard The scheme is derived from the card PAN.
]
]
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Possible values: <= 20 characters
Account id.
Possible values: <= 20 characters
Paysafe embedded wallet internal customer identifier.
Possible values: non-empty
and <= 40 characters
External identifier in merchant system. Must be passed during onboarding.
Amount in minor units
Amount in minor units
instruments
object[]
List of payment instruments associated with this account, provided by Paysafe. This list might include virtual bank accounts or pre-paid cards funded by the account.
The instrument id
Customer to which this instrument belongs.
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
Instrument type.
Value | Description |
---|---|
SEPA_BANK_ACCOUNT | SEPA Bank account |
UK_BANK_ACCOUNT | UK Bank account |
US_BANK_ACCOUNT | US Bank account |
CCI_BANK_ACCOUNT | CCI Bank account |
CARD | Card |
Card Number
Possible values: <= 160 characters
Card holder name.
Bank name.
expiryDate
object
required
Card expiry date.
Possible values: [VISA
, MC
]
Card scheme information.
Possible values: <= 20 characters
Name to be associated with the card.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
A bank account number.
Use our sort code checker to easily find and check UK sort codes.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account. As per regulations the Wallet holder and bank account holder must be the same.
Possible values: >= 4 characters
and <= 17 characters
This is the bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
Bank name.
Possible values: [SAVINGS
, CHECKING
, LOAN
]
Possible values: >= 20 characters
and <= 20 characters
A bank account number (Código de Cuenta Interbancario), has 20 digits
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
Instrument status.
Represents RFC 3339, section 5.6 date-time.
Instrument creation time.
[
{
"currencyCode": "EUR",
"id": "5029090724",
"customerId": "123456789",
"externalId": "a2322550-af91-417f-867e-681efad44b9d",
"totalBalance": 0,
"availableBalance": 0,
"instruments": [
{
"id": "string",
"customerId": "5435323362",
"instrumentType": "CARD",
"status": "VERIFIED",
"creationTime": "2021-07-15T17:54:12Z"
}
],
"creationTime": "2019-08-24T14:15:22Z"
}
]
[
{
"id": "509876034",
"customerId": "5435323362",
"externalId": "121345",
"currencyCode": "GBP",
"totalBalance": 55000,
"availableBalance": 50000,
"creationTime": "2019-08-24T14:15:22Z"
}
]
- Schema
- Example (from schema)
Schema
Array [
Array [
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
- VISA - VISA
- MC - Mastercard The scheme is derived from the card PAN.
]
]
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Possible values: <= 20 characters
Account id.
Possible values: <= 20 characters
Paysafe embedded wallet internal customer identifier.
Possible values: non-empty
and <= 40 characters
External identifier in merchant system. Must be passed during onboarding.
Amount in minor units
Amount in minor units
instruments
object[]
List of payment instruments associated with this account, provided by Paysafe. This list might include virtual bank accounts or pre-paid cards funded by the account.
The instrument id
Customer to which this instrument belongs.
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
Instrument type.
Value | Description |
---|---|
SEPA_BANK_ACCOUNT | SEPA Bank account |
UK_BANK_ACCOUNT | UK Bank account |
US_BANK_ACCOUNT | US Bank account |
CCI_BANK_ACCOUNT | CCI Bank account |
CARD | Card |
Card Number
Possible values: <= 160 characters
Card holder name.
Bank name.
expiryDate
object
required
Card expiry date.
Possible values: [VISA
, MC
]
Card scheme information.
Possible values: <= 20 characters
Name to be associated with the card.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
A bank account number.
Use our sort code checker to easily find and check UK sort codes.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account. As per regulations the Wallet holder and bank account holder must be the same.
Possible values: >= 4 characters
and <= 17 characters
This is the bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
Bank name.
Possible values: [SAVINGS
, CHECKING
, LOAN
]
Possible values: >= 20 characters
and <= 20 characters
A bank account number (Código de Cuenta Interbancario), has 20 digits
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
Instrument status.
Represents RFC 3339, section 5.6 date-time.
Instrument creation time.
<0>
<currencyCode>EUR</currencyCode>
<id>5029090724</id>
<customerId>123456789</customerId>
<externalId>a2322550-af91-417f-867e-681efad44b9d</externalId>
<totalBalance>0</totalBalance>
<availableBalance>0</availableBalance>
<instruments>
<id>string</id>
<customerId>5435323362</customerId>
<instrumentType>CARD</instrumentType>
<status>VERIFIED</status>
<creationTime>2021-07-15T17:54:12Z</creationTime>
</instruments>
<creationTime>2019-08-24T14:15:22Z</creationTime>
</0>
Unauthorized
- application/json
- Schema
- Example (from schema)
- UNAUTHORIZED
- INVALID_CREDENTIALS
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "5275",
"message": "Authentication credentials expired",
"details": [
"The authentication credentials have expired."
]
}
}
{
"error": {
"code": "5279",
"message": "Invalid credentials",
"details": [
"The authentication credentials are invalid."
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- INTERNAL_SERVER_ERROR
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-INTERNAL-SERVER-ERROR",
"message": "Internal Server Error",
"details": [
"There was an error while processing the operation"
]
}
}
Service Unavailable. Please try again later.
- application/json
- Schema
- Example (from schema)
- SERVICE_UNAVAILABLE
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-SERVICE-UNAVAILABLE",
"message": "Service Unavailable",
"details": [
"Service Unavailable"
]
}
}