Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
h) Wallets

Search for wallets in a tenant

Returns wallets matching the provided search criteria. At least one search field should be supplied; use onlyShowAllowed to restrict results to wallets the caller has permission to access.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets

Path parameters

tenantIdinteger required

Query parameters

IsObfuscateboolean

Deprecated. Use 'obfuscate' instead.

accountNumberstring

Wallet account number.

externalUniqueIdstring

External unique ID assigned to the wallet at creation.

fieldsstring

Comma-separated list of additional fields to include in the response.

lastNamestring

Customer's last (family) name. Max 50 characters.

nationalIdentityNumberstring

National identity number. Max 20 characters.

obfuscateboolean

When true, sensitive personal data in the response is obfuscated.

onlyShowAllowedboolean

When true, returns only wallets the caller has permission to access. When false and the caller lacks permission, an error is returned.

passportNumberstring

Passport number. Max 20 characters.

phonestring

Phone number with or without country code, e.g. 0821112222 or 27821112222.

statusstring

Comma-separated wallet statuses to filter by. Valid values: active, barred, pending, cancelled, locked.

walletFriendlyIdstring

Wallet friendly ID. Exactly 8 characters when provided.

walletIdinteger

Wallet ID to search for directly.

Response

OK

accountNumberstring

A bank account number for the wallet if supported by the sponsor bank

currencystring
customerIdinteger

A customerId for the wallet

externalUniqueIdstring
firstNamestring

Obfuscated first name. Only present if the owner has this field on their profile

lastNamestring

Obfuscated last name. Only present if the owner has this field on their profile

namestring

Obfuscated name of the organisation. Only present if the organisation has this field

nationalIdentityNumberstring

Obfuscated national identity number of the wallet holder. Only present if the owner has this field on their profile

passportNumberstring

Obfuscated passport number of the wallet holder. Only present if the owner has this field on their profile

phone1string

Obfuscated phone number 1 of the wallet holder. Only present if the owner has this field on their profile

phone2string

Obfuscated phone number 2 of the wallet holder. Only present if the owner has this field on their profile

status'ACTIVE' | 'BARRED' | 'CANCELED' | 'CANCELLED' | 'JOINT_ACTIVE' | 'JOINT_PARTIAL' | 'LOCKED' | 'PENDING'

Status of the wallet. ACTIVE:Can be used, LOCKED:Is blocked from use but can be customer controlled. CANCELED is deprecated. CANCELLED is in use, BARRED: Wallet cannot be used due to possible fraud or similar investigation

tenantIdinteger

The tenant ID of the tenant the wallet is held with

tenantNamestring

The name of the tenant the wallet is held with

tradingNamestring

Obfuscated trading name of the organisation. Only present if the organisation has this field

walletFriendlyIdstring

A unique string reference for a wallet used for deposit references and other transactions

walletIdinteger

A unique system generated numeric identifier for the wallet. This is the required identifier for doing transfers to the wallet in field toWalletId

walletNamestring

The name of the wallet

walletTypeIdinteger

The type ID of the wallet