For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Customers

Retrieves a paginated list of customers with filtering options. Returns customer details including balances, status, and metadata.

Endpoint

GET/v2/customer

Link

Request

Query Parameters

Parameter
Type
Description & Values
Required
Example

customerId

string

Filter by customer ID.

No

"DqCsgSE-4e95-ViYbNI"

customerName

string

Filter by customer name (partial match).

No

"John"

fromCreateAt

string

Filter customers created after this date (ISO 8601).

No

"2024-01-01T00:00:00Z"

meta.page

integer

Page number (starts from 0).

No

0

meta.pageSize

integer

Items per page.

No

10

status

string

Filter by customer status: - NEW: Registered user - READY_FOR_MODERATION: Sent to moderator - MODERATED: Moderator reviewed - VERIFY: In verification - ACCEPT: Approved - REJECT: Rejected - BANNED: Blocked

No

"ACCEPT"

toCreateAt

string

Filter customers created before this date (ISO 8601).

No

"2024-12-31T23:59:59Z"

type

string

Filter by customer type: - CORPORATE: Business entity - INDIVIDUAL: Person

No

"INDIVIDUAL"

userUuid

string

Filter by user UUID.

No

"b5f8e835-d669-4d4d-8ddf-198263364821"


Response (200 OK)

Returns paginated customer data with metadata.

Response Fields

1. Meta Object

Field
Type
Description
Example

pageSize

integer

Items per page.

10

page

integer

Current page number.

0

total

string

Total customers (across all pages).

"150"

2. Customer Object (items[])

Field
Type
Description
Example

cuid

string

Customer unique ID.

"DqCsgSE-4e95-ViYbNI"

puid

string

Partner/user ID.

"127c9ea7-3ea7-4063-9fa4-c69e796c55e4"

status

string

Current status (see values above).

"ACCEPT"

createAt

string

Creation timestamp (ISO 8601).

"2024-01-15T10:30:00Z"

updateAt

string

Last update timestamp (ISO 8601).

"2024-05-20T14:45:00Z"

name

string

First name (individual) or company name.

"John" or "Acme Inc."

lastname

string

Last name (individuals only).

"Doe"

comment

string

Internal notes/comments.

"VIP client"

company

string

Company name (if corporate).

"Acme Inc."

type

string

CORPORATE or INDIVIDUAL.

"INDIVIDUAL"

balance

object

Available balance (Money Object).

-

balanceHold

object

Held/restricted balance (Money Object).

-

Money Object

Field
Type
Description
Example

currencyCode

string

Currency code (ISO 4217).

"USD"

units

string

Whole units.

"1000"

nanos

integer

Fractional units (10^-9).

500000000 (= $0.50)


Examples

Request

bash

Response

json


Error Responses

  1. Invalid Status/Type:

    json

  2. Unauthorized:

    json


Notes

  • Pagination: Default pageSize is typically 20-50 items.

  • Date Format: Use ISO 8601 (YYYY-MM-DDThh:mm:ssZ).

  • Balance Types:

    • balance: Available for transactions.

    • balanceHold: Temporarily locked (e.g., pending transactions).

Real request Example 1

Real response example 1

200 OK

Real request 2

Real response 2

Last updated