SopagueDocs
v3

Listar Clientes

GET/v2/payment-customers

Lista os clientes pagadores cadastrados na conta com suporte a filtros de busca e paginação.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado

Parâmetros

Exemplo de requisição
curl --request GET \
  --url 'https://api.sopague.com.br/gateway/v2/payment-customers' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
[
  {
    "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "name": "Carlos Eduardo",
    "documentNumber": "***.222.333-**",
    "status": "ACTIVE"
  }
]

Erros

As respostas de erro específicas deste endpoint ainda não foram confirmadas. A referência HTTP abaixo apresenta uma possibilidade geral, não um retorno validado nesta rota.

Possível resposta HTTP

O 404 pode ocorrer quando a rota ou o recurso solicitado não é encontrado. Confira a URL base, a versão da API, o caminho e o identificador do recurso, quando aplicável.

HTTP/1.1 404 Not Found

Este exemplo ilustra o status HTTP. O corpo da resposta depende da rota e do ambiente.