Documentação da API
Autenticação
Subcontas
Contas Bancárias
Clientes
Tokenização de Cartões
Assinaturas de Recorrência
Saldo e Transferências
Antecipações de Recebíveis
Webhooks
Clientes
Adicionar cliente
Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.
POST
/
customers
Copy
curl --request POST \
--url https://sandbox-api.superpagamentos.com/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"phoneNumber": "00000000000",
"document": "00000000000",
"birthdate": "1994-10-04",
"address": {
"zipcode": 87654321,
"street": "Rua B",
"streetNumber": 200,
"complement": "Casa 10",
"reference": "Ao lado da padaria",
"neighborhood": "Jardins",
"city": "São Paulo",
"state": "SP"
}
}'
Copy
{
"data": {
"id": "8a2edf48-704b-4c23-8278-a902e88a5f93",
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"phoneNumber": "00000000000",
"document": "00000000000",
"birthdate": "1994-10-04",
"address": {
"statusId": "APPROVED",
"zipcode": 87654321,
"street": "Rua B",
"streetNumber": 200,
"complement": "Casa 10",
"reference": "Ao lado da padaria",
"neighborhood": "Jardins",
"city": "São Paulo",
"state": "SP"
},
"statusId": "APPROVED",
"createdAt": "2025-06-01T16:14:10.535Z"
},
"message": "Cliente criado com sucesso"
}
Authorizations
Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer <token>
Body
application/json
Response
200
application/json
Cliente criado com sucesso
The response is of type object
.
Copy
curl --request POST \
--url https://sandbox-api.superpagamentos.com/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"phoneNumber": "00000000000",
"document": "00000000000",
"birthdate": "1994-10-04",
"address": {
"zipcode": 87654321,
"street": "Rua B",
"streetNumber": 200,
"complement": "Casa 10",
"reference": "Ao lado da padaria",
"neighborhood": "Jardins",
"city": "São Paulo",
"state": "SP"
}
}'
Copy
{
"data": {
"id": "8a2edf48-704b-4c23-8278-a902e88a5f93",
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"phoneNumber": "00000000000",
"document": "00000000000",
"birthdate": "1994-10-04",
"address": {
"statusId": "APPROVED",
"zipcode": 87654321,
"street": "Rua B",
"streetNumber": 200,
"complement": "Casa 10",
"reference": "Ao lado da padaria",
"neighborhood": "Jardins",
"city": "São Paulo",
"state": "SP"
},
"statusId": "APPROVED",
"createdAt": "2025-06-01T16:14:10.535Z"
},
"message": "Cliente criado com sucesso"
}
Assistant
Responses are generated using AI and may contain mistakes.