Skip to main content
GET
List Customers
Returns a paginated, filterable list of customers in the pay centre. Requires a MANAGER token.

Request Headers

string
required
JWT Access Token of an authenticated manager.
string
default:"fincode"
required
Platform identifier. Use fincode.
string
default:"200"
required
Unique request identifier.

Query Parameters

integer
default:"1"
Page number (1-based). Defaults to 1.
integer
default:"20"
Number of records per page. Defaults to 20.
Free-text search by customer name, email, or phone number.
string
Filter by verification status. Common values: VERIFIED, UNVERIFIED, PENDING.
string
Filter by a specific pay centre ID. Defaults to the pay centre of the authenticated manager.
string
Filter by customer profile type.

Code Example

cURL

Headers

platform
string
default:fincode
required
uuid
string
default:200
required
X-Auth-Token
string
required

Query Parameters

page
number
Example:

1

size
number
Example:

10

customer_verification_status
string
paycenter_id
string
profile
string
Example:

"sender"

Response

200

Customers list