Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
z) Global Functionality

Search for a wallet across all tenants

Returns wallet information without disclosing personal details. Either a phone number or at least two matching search fields are required. This endpoint is rate-limited; callers should store the walletId rather than searching on each use.

get/eclipse-conductor/rest/v1/global/wallets

Query parameters

accountNumberstring

Account number

externalUniqueIdstring

External unique Id

lastNamestring

Customers last (family) name of max length 50

nationalIdentityNumberstring

Max length 20

passportNumberstring

Max length 20

phonestring

Either with or without the country code. E.g. 0821112222 or 27821112222

transferableboolean

If transferable is true it will return the list of wallets from tenants which accept the cross tenant payments

walletFriendlyIdstring

Will be length 8 if provided

walletIdinteger

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