SopagueDocs
v3

Armazenar Cartão no Cofre

POST/v2/cards/vault

Armazena um cartão de crédito ou débito diretamente no cofre seguro, persistindo os metadados mascarados e os dados protegidos com AES-256. O identificador retornado (vaultId) pode ser utilizado em compras futuras e soluções de 1 clique (One-Click Buy).

Sem necessidade de tokenização prévia

Não é necessário tokenizar o cartão antes de chamar este endpoint. Basta passar o número do cartão diretamente no campo cardNumber. O cofre processa e gera o vaultId diretamente.

Cabeçalhos (Headers)

CabeçalhoTipoObrigatórioDescrição
AuthorizationstringSimToken JWT Bearer (Bearer <token>) emitido pelo endpoint de autenticação
Content-TypestringSimapplication/json

Parâmetros de Entrada (Body JSON)

Exemplo de requisição
{
  "cardNumber": "5127480000001375",
  "expiryDate": "1228",
  "customerId": "cli_98765"
}

Resposta (200 OK)

Exemplo de resposta
{
  "vaultId": "b4c2b9a7-8a3e-4d56-b0ef-6cf45217992c10a2f4d1e2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3",
  "suffix": "1375",
  "bin": "512748",
  "customerId": "cli_98765"
}

Parâmetros de Retorno

Erros Possíveis

CódigoDescriçãoExemplo
400 Bad RequestFalha de validação nos campos (cardNumber, expiryDate, customerId)[{"tag": "expiryDate", "description": "A data de expiração informada é inválida ou já venceu."}]
401 UnauthorizedToken Bearer JWT inválido ou expirado[{"tag": "", "description": "Token inválido ou expirado."}]
409 ConflictIdentificador do cliente pagador já cadastrado (CUSTOMER_ID_ALREADY_IN_USE)[{"tag": "CUSTOMER_ID_ALREADY_IN_USE", "description": "Já existe um cartão cadastrado com este identificador."}]