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

Get Customer

Retrieves detailed information about a specific customer including balances, contact information, and status.

Endpoint

POST/v2/customer/{customerId}

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

customerId

string

Customer ID to retrieve.

Yes

"DqCsgSE-4e95-ViYbNI"

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns a customer object with complete details.

Response Fields

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: - NEW - READY_FOR_MODERATION - MODERATED - VERIFY - ACCEPT - REJECT - BANNED

"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 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 Corporation"

type

string

CORPORATE or INDIVIDUAL.

"INDIVIDUAL"

balance

object

Available balance (Money Object).

-

balanceHold

object

Held/restricted balance (Money Object).

-

phone

string

Contact phone number.

"+1234567890"

email

string

Contact email address.

"[email protected]"

Money Object

Field
Type
Description
Example

currencyCode

string

Currency code (ISO 4217).

"USD"

units

string

Whole units.

"1500"

nanos

integer

Fractional units (10^-9).

500000000 (= $0.50)

Example Response:

json

Translation: $1500.50 available, $250.00 on hold


Examples

Request

bash

Corporate Customer Example

Response:

json


Error Responses

  1. Customer Not Found:

    json

  2. Unauthorized:

    json


Notes

  • Balance Types:

    • balance: Available for transactions

    • balanceHold: Temporarily locked (pending transactions, reserves)

  • Status Flow:

    • NEW → MODERATED → ACCEPT (typical flow)

    • BANNED accounts cannot perform transactions

  • Contact Info: Phone/email may be masked for privacy ("j***@example.com")

Real request example

Real response example

200 OK

Last updated