Skip to navigation

Get customer list

List customers for a merchant

Authentication

OR
Authorizationstring
API Key authentication via header

Query parameters

limitdoubleOptional
pagedoubleOptional
blockedstringOptional
searchstringOptional
sortByenumOptional
Allowed values:
sortDirectiondoubleOptional
protectionstringOptional

Response

Ok
emailstring
createdAtdatetime
_idstring
merchantstring or object
availabilityobject
chargebackProtectionEnabledboolean
failedAttemptSettingenum
Allowed values:
verificationSettingenum
Allowed values:
walletstring
blockchainenumOptional
verificationobjectOptional
geoBlockOverrideobjectOptional

Per-customer exemption from real-time geographic enforcement.

When set and not expired, withdrawal blocking rules with method GEOLOCATION or IP are skipped for this withdrawer. KYC_ADDRESS rules still apply — KYC is the compliance floor and must remain enforceable.

Auditable by construction: reason and setBy are required so admins can review why a specific user was exempted. expiresAt is optional but strongly recommended; long-lived overrides should be avoided.

uboslist of objectsOptional
verisoulobjectOptional
customerInfoobjectOptional
exempt3DSbooleanOptional
chargebackProtectionOverrideLogobjectOptional
blockConfigOverrideobjectOptional

Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.

customerOverrideLimitobjectOptional
overrideExposureLimitobjectOptional
fraudOverrideWhitelistbooleanOptional
excludeBlockCardReuseAcrossCustomersbooleanOptional