Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Headers

X-Idempotency-Key
string
required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours. Successful (2xx) responses are stored and replayed for the key. On POST /v1/payments, a 502 PROVIDER_TEMPORARILY_UNAVAILABLE for a boleto payment is stored and replayed too: to recover that payment, repeat the request once with the same externalId and a new key. A retry of an earlier card payment request now returns 400 CARD_PAYMENTS_NOT_AVAILABLE_VIA_API instead of the stored response (201 or 502): recover that payment with GET /v1/payments/txid/{txId}, or with a create request with the same externalId, mode: "hosted" and methods: ["CARD"], no card object or card fields, and a new key.

Maximum string length: 100

Body

application/json
externalId
string

Your own customer ID.

Maximum string length: 100
name
string
Required string length: 1 - 200
email
string<email>
Maximum string length: 255
document
string

CPF or CNPJ number.

Maximum string length: 20
documentType
enum<string>
Available options:
CPF,
CNPJ
phone
string
Maximum string length: 20
metadata
object

Response

Customer created.

customer
object