Consultar Cliente
GET/v2/payment-customers/{customerId}
Consulta os dados cadastrais do cliente pagador com proteção e máscara de privacidade (LGPD).
Cabeçalhos (Headers)
| Cabeçalho | Valor | Obrigatório | Descrição |
|---|---|---|---|
Authorization | Bearer <token> | Sim | Token JWT Bearer autenticado |
Parâmetros
Exemplo de requisição
curl --request GET \
--url 'https://api.sopague.com.br/gateway/v2/payment-customers/{customerId}' \
--header 'Authorization: Bearer {token}'Resposta (200 OK)
Exemplo de resposta
{
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"externalId": "CLI-9921",
"documentType": "PF",
"documentNumber": "***.222.333-**",
"name": "Carlos Eduardo",
"email": "c***@example.com",
"phoneNumber": "(11) ****-4444",
"mobilePhoneNumber": "(11) 9****-7777",
"address": {
"street": "Avenida Paulista",
"number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310100"
},
"status": "ACTIVE"
}Erros
As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.
Ver validações observadas em homologação
Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.
[
{
"tag": "CustomerId",
"description": "'Customer Id' deve ser informado."
}
]Campos da resposta de erro
A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.
