Create a customer (merchant-scoped)

Create a customer, then pass its id as customer_id on POST /v1/payment_intents.

merchantId and tenantId are always set from your credentials; any values in the body are replaced. Creating is not deduplicated, so search first to reuse a returning customer.

Merchant users work on their own merchant's customers. Tenant owners and admins can work on any merchant in their tenant by passing ?merchantId=. A merchant in another tenant returns 404. Other roles are refused.

Authenticate with a dashboard session token, or a merchant-pinned secret key in X-API-Key. A secret key acts only for its own merchant: anything it creates belongs to that merchant and records the key as the actor, and another merchant's customers return 404. Publishable, payout_write and agent_onboarding keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Tenant admin/owner override — target merchant within the caller's tenant (UUID). Required for tenant_admin/tenant_owner; ignored for role merchant and for a secret key (scope comes from the credential).

Body Params

Send name, or at least one of companyName, firstName and lastName (otherwise 400 VALIDATION_ERROR on name).

string
length between 1 and 255

Optional when a name part is given. If omitted it is set to companyName, else firstName and lastName joined by a space. An explicit name always wins.

string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null

ISO 3166-1 alpha-2 (e.g. US); any case, stored uppercase.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json