SopagueDocs
v3

Listar Meios de Pagamento

GET/v2/payment-customers/{customerId}/payment-methods

Lista todos os cartões cadastrados e tokenizados do cliente com dados sensíveis devidamente mascarados.

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/{customerId}/payment-methods' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
[
  {
    "id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "paymentCustomerId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "cardBrand": "VISA",
    "cardBin": "41****",
    "cardSuffix": "1111",
    "cardExpirationDate": "1228",
    "isDefault": true,
    "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.