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

Update Customer

Updates an existing customer's information including status, contact details, and metadata. Returns the updated customer object.

Endpoint

PATCH/v2/customer/{customerId}

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

customerId

string

Customer ID to update.

Yes

"DqCsgSE-4e95-ViYbNI"

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Content-Type

application/json

Yes

Accept

application/json

Yes

Request Body (JSON)

All fields are optional - only include the fields you want to update.

Field
Type
Description & Values
Example

name

string

First name or company name.

"John" or "Acme Inc."

lastname

string

Last name (individuals only).

"Smith"

comment

string

Internal notes/comments.

"Updated contact info"

company

string

Company name (if corporate).

"Acme Corporation"

status

string

Customer status: - NEW - READY_FOR_MODERATION - MODERATED - VERIFY - ACCEPT - REJECT - BANNED

"ACCEPT"

type

string

Customer type: - CORPORATE - INDIVIDUAL

"INDIVIDUAL"

Example Request Body:

json


Response (200 OK)

Returns the updated customer object with all current values.

Response Fields

Field
Type
Description
Example

cuid

string

Customer ID (unchanged).

"DqCsgSE-4e95-ViYbNI"

puid

string

Partner ID (unchanged).

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

status

string

Updated status.

"ACCEPT"

createAt

string

Original creation timestamp.

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

updateAt

string

New update timestamp.

"2024-05-21T09:15:00Z"

name

string

Updated name.

"John"

lastname

string

Updated last name.

"Smith"

comment

string

Updated comment.

"Verified customer"

company

string

Updated company name.

""

type

string

Customer type.

"INDIVIDUAL"

balance

object

Current balance (unchanged).

-

balanceHold

object

Current held balance (unchanged).

-

Money Object

Field
Type
Description
Example

currencyCode

string

Currency code.

"USD"

units

string

Whole units.

"1500"

nanos

integer

Fractional units.

500000000 (= $0.50)

Example Response:

json


Examples

Request

bash

Corporate Customer Update

Request:

json


Error Responses

  1. Customer Not Found:

    json

  2. Invalid Status:

    json

  3. Validation Error:

    json


Notes

  • Partial Updates: Only included fields are modified.

  • Status Restrictions: Some status changes may be restricted (e.g., BANNED → ACCEPT).

  • Type Changes: Changing from INDIVIDUAL to CORPORATE may require additional company fields.

Real request Example

Real response example

200 OK

Last updated