Skip to main content
PATCH
Update a customer

What this endpoint does

Updates supported fields on an existing customer without replacing the whole record.

When to use it

Use it when customer details change and the schema permits that field to be edited.

Before you call

Use a secret API key with customer write access and pass a customer ID owned by the same tenant account.

Money and balance effect

This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.

States and completion

An update may cause verification data to require review. Read the customer and entitlements after asynchronous checks complete.

Safe retries

PATCH does not use an Idempotency-Key. After an unknown response, read the customer first; retry the identical field update only if the desired values are not present. Read Customers for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Path Parameters

id
string
required

Body

application/json
contact
object
metadata
object

Response

The updated customer.

id
string
required

Unique Wayex identifier for this customer.

Minimum string length: 1
counterpartyId
string
required

The client account (counterparty) this customer belongs to. For API callers this is always your own account id.

Minimum string length: 1
type
enum<string>
required

Whether the customer is an individual (natural person) or a business (legal entity).

Available options:
individual,
business
contact
object
required
verificationStatus
enum<string>
required

Current verification state. Value can only move on the customer's behalf once approved.

Available options:
in_progress,
approved,
rejected,
requires_action
entitlements
object[]
required

The capabilities this customer is cleared for, granted as verification completes.

createdAt
string<date-time>
required

When the customer was created (ISO 8601).

externalCustomerId
string

Your own identifier for this customer, echoed back for cross-referencing.

Minimum string length: 1
businessDetails
object
individualDetails
object
metadata
object