Pular para o conteúdo principal
POST
/
customers
Criar um cliente
curl --request POST \
  --url https://api.pague.dev/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "name": "João da Silva",
  "document": "12345678909",
  "email": "jsmith@example.com",
  "phone": "+5511999998888"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "João da Silva",
  "email": "jsmith@example.com",
  "documentType": "cpf",
  "document": "***456789**",
  "createdAt": "2023-11-07T05:31:56Z",
  "phone": "+5511999998888"
}

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Corpo

application/json
name
string
obrigatório

Nome do cliente

Maximum string length: 255
Exemplo:

"João da Silva"

document
string
obrigatório

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números

Pattern: ^(\d{11}|\d{14})$
Exemplo:

"12345678909"

email
string<email>

E-mail do cliente

Maximum string length: 255
phone
string

Telefone do cliente com DDI

Pattern: ^\+\d{10,15}$
Exemplo:

"+5511999998888"

Resposta

Cliente criado com sucesso

id
string<uuid>
obrigatório

ID do cliente

name
string
obrigatório

Nome do cliente

Exemplo:

"João da Silva"

email
string<email>
obrigatório

E-mail do cliente

documentType
enum<string>
obrigatório

Tipo do documento

Opções disponíveis:
cpf,
cnpj
document
string
obrigatório

Número do documento mascarado

Exemplo:

"***456789**"

createdAt
string<date-time>
obrigatório

Data de criação

phone
string

Telefone do cliente com DDI

Exemplo:

"+5511999998888"