Chave Pública do Cartão
Dados da API
API Gateway
Esta API é utilizada para operações do gateway de pagamento:
- Produção: https://api.sopague.com.br/gateway
- Homologação: https://api-hmg.sopague.com.br/gateway
- Arquitetura: Representational State Transfer (REST)
Obter Chave Pública RSA
Retorna a chave pública RSA do cliente autenticado, usada para criptografar dados sensíveis do cartão no frontend.
GET /v1/cards/public-key
Via request Representational State Transfer (REST) sem body:
Requisição
GET /v1/cards/public-key
Authorization: Bearer {seu_token}
Headers Obrigatórios
| PROPRIEDADE | DESCRIÇÃO | TIPO | LOCAL | OBRIGATÓRIO |
|---|---|---|---|---|
| Authorization | Token de autenticação da API | string | header | sim |
Fluxo
O processo para obter a chave pública RSA segue os seguintes passos:
- Solicitação do cliente: O cliente autenticado solicita a rota
/v1/cards/public-key. - Geração/Recuperação da chave: O sistema gera (ou recupera) uma chave privada RSA vinculada ao cliente.
- Retorno da chave pública: A chave pública correspondente é retornada para uso na criptografia dos dados do cartão.
Resposta
Sucesso (200)
Resposta de Sucesso
{
"key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA..."
}
Dicionário de dados - Resposta
| PROPRIEDADE | DESCRIÇÃO | TIPO |
|---|---|---|
| key | Chave pública RSA em formato PEM para criptografia dos dados do cartão | string |
Códigos de Erro
| CÓDIGO | DESCRIÇÃO |
|---|---|
| 401 | Não autenticado |
| 400 | Erro ao gerar ou recuperar chave |
| 500 | Erro interno |
Uso
A chave pública deve ser usada para criptografar os dados do cartão antes de enviá-los para as seguintes rotas de pagamento:
Rotas de Pagamento
- Pagamento com Antifraude -
POST /v1/payments - Pagamento com 3DS -
POST /v1/payments/3ds - Validar Pagamento 3DS -
POST /v1/payments/3ds/validate
Implementação Recomendada
- Obtenha a chave pública: Faça uma requisição para este endpoint antes de iniciar o processo de pagamento.
- Criptografe os dados: Use a chave pública para criptografar os dados sensíveis do cartão no frontend.
- Envie para pagamento: Utilize os dados criptografados nas rotas de pagamento mencionadas acima.
Segurança
A criptografia RSA garante que os dados sensíveis do cartão sejam protegidos durante a transmissão, seguindo as melhores práticas de segurança para pagamentos online.
Para dúvidas ou problemas, acesse a seção de suporte no