Skip to main content
POST
/
v1
/
customers
Criar cliente
curl --request POST \
  --url https://api.valorapayments.com.br/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "cliente@exemplo.com.br",
  "phone_number": "11999990000",
  "document_number": "12345678901"
}
'
{
  "customer_id": "cust_a1b2c3d4",
  "business_id": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "document_number": "<string>",
  "ip": "<string>",
  "metadata": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Chave de API gerada no painel Valora. Envie em todas as requisições.

Body

application/json

Pelo menos um campo de identificação é recomendado

email
string<email>
Example:

"cliente@exemplo.com.br"

phone_number
string

Telefone com DDD, sem formatação

Example:

"11999990000"

document_number
string

CPF ou CNPJ sem formatação

Example:

"12345678901"

ip
string<ipv4>

IP do cliente para antifraude

metadata
string

JSON serializado com dados extras

Response

Cliente criado

customer_id
string
Example:

"cust_a1b2c3d4"

business_id
string
email
string | null
phone_number
string | null
document_number
string | null
ip
string | null
metadata
string | null
created_at
string<date-time>