cURL
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",
"document": "00000000000",
"phoneNumber": "00000000000",
"birthdate": "1994-10-04"
}
'import requests
url = "https://sandbox-api.superpagamentos.com/customers"
payload = {
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"document": "00000000000",
"phoneNumber": "00000000000",
"birthdate": "1994-10-04"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'João',
lastName: 'Silva',
email: 'email@email.com',
document: '00000000000',
phoneNumber: '00000000000',
birthdate: '1994-10-04'
})
};
fetch('https://sandbox-api.superpagamentos.com/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.superpagamentos.com/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'João',
'lastName' => 'Silva',
'email' => 'email@email.com',
'document' => '00000000000',
'phoneNumber' => '00000000000',
'birthdate' => '1994-10-04'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.superpagamentos.com/customers"
payload := strings.NewReader("{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.superpagamentos.com/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.superpagamentos.com/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"data": {
"message": [
"O campo email \"email\" informado é inválido",
"O documento informado é inválido",
"O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd",
"address.O campo rua \"street\" é obrigatório",
"address.O campo rua \"street\" deve ser um texto válido",
"address.O campo número \"streetNumber\" é obrigatório",
"address.O campo número \"streetNumber\" deve ser um número válido",
"address.O campo bairro \"neighborhood\" é obrigatório",
"address.O campo bairro \"neighborhood\" deve ser um texto válido",
"address.O campo cidade \"city\" é obrigatório",
"address.O campo cidade \"city\" deve ser um texto válido",
"address.O campo estado \"state\" é obrigatório",
"address.O campo estado \"state\" deve ser um texto válido",
"address.O campo CEP \"zipcode\" é obrigatório",
"address.O campo CEP \"zipcode\" deve ser um número válido"
],
"error": "Bad Request",
"statusCode": 400
}
}Clientes
Adicionar cliente
Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.
POST
/
customers
cURL
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",
"document": "00000000000",
"phoneNumber": "00000000000",
"birthdate": "1994-10-04"
}
'import requests
url = "https://sandbox-api.superpagamentos.com/customers"
payload = {
"firstName": "João",
"lastName": "Silva",
"email": "email@email.com",
"document": "00000000000",
"phoneNumber": "00000000000",
"birthdate": "1994-10-04"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'João',
lastName: 'Silva',
email: 'email@email.com',
document: '00000000000',
phoneNumber: '00000000000',
birthdate: '1994-10-04'
})
};
fetch('https://sandbox-api.superpagamentos.com/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.superpagamentos.com/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'João',
'lastName' => 'Silva',
'email' => 'email@email.com',
'document' => '00000000000',
'phoneNumber' => '00000000000',
'birthdate' => '1994-10-04'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.superpagamentos.com/customers"
payload := strings.NewReader("{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.superpagamentos.com/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.superpagamentos.com/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"João\",\n \"lastName\": \"Silva\",\n \"email\": \"email@email.com\",\n \"document\": \"00000000000\",\n \"phoneNumber\": \"00000000000\",\n \"birthdate\": \"1994-10-04\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"data": {
"message": [
"O campo email \"email\" informado é inválido",
"O documento informado é inválido",
"O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd",
"address.O campo rua \"street\" é obrigatório",
"address.O campo rua \"street\" deve ser um texto válido",
"address.O campo número \"streetNumber\" é obrigatório",
"address.O campo número \"streetNumber\" deve ser um número válido",
"address.O campo bairro \"neighborhood\" é obrigatório",
"address.O campo bairro \"neighborhood\" deve ser um texto válido",
"address.O campo cidade \"city\" é obrigatório",
"address.O campo cidade \"city\" deve ser um texto válido",
"address.O campo estado \"state\" é obrigatório",
"address.O campo estado \"state\" deve ser um texto válido",
"address.O campo CEP \"zipcode\" é obrigatório",
"address.O campo CEP \"zipcode\" deve ser um número válido"
],
"error": "Bad Request",
"statusCode": 400
}
}Authorizations
Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer
Body
application/json
Nome do cliente
Example:
"João"
Sobrenome do cliente
Example:
"Silva"
Email do cliente
Example:
"email@email.com"
CPF ou CNPJ do cliente
Example:
"00000000000"
Número de telefone do cliente
Example:
"00000000000"
Data de nascimento do cliente no formato yyyy-mm-dd
Example:
"1994-10-04"
Endereço do cliente
Show child attributes
Show child attributes
⌘I