VCNRevelar dados do VCN

Revelar dados do VCN

Use o Sandbox para preparar a integração e validar a autenticação e o contrato.

Devolve PAN, CVV e validade de uma VCN já emitida. A emissão entrega esses dados uma única vez; use esta rota para reobtê-los. O vcnId precisa pertencer ao cliente autenticado.

Segurança

A resposta traz PAN e CVV em claro e vem com Cache-Control: no-store. Trate os dados só em memória, não logue, não cacheie e prefira exibição única na sua interface.

Erros

  • 400 bad-request-exception — vcnId inválido no path (field path.vcnId).
  • 400 bad-request-exception — X-Partner-Id ausente ou fora do formato (field headers.x-partner-id). Veja Identificação da plataforma.
  • 403 caller-not-authorized — o partner do X-Partner-Id não está vinculado à sua credencial (details.reason PARTNER_NOT_BOUND), ou falta à credencial o escopo da rota (details.requiredScope). Veja Identificação da plataforma.
  • 404 vcn-not-found — VCN inexistente, de outra empresa ou substituída por reemissão. Logo após a emissão, repita antes de concluir.
  • 409 vcn-cancelled — a VCN foi cancelada; não repita. O estado aparece em Consultar VCN. Bloqueada ou com a janela vencida, ela continua sendo revelada.
  • 500 internal-exception — erro interno, inclusive falha transitória do provedor: esta rota não tem 503. Repetir é seguro.

Regras

Repetir chamadas · Ordem de avaliação

curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/vcns/01JQ8ZK7X4M8N2P5R6T7V8W9XY/reveal" \
  -H "Content-Type: application/json" \
  -H "X-Partner-Id: ptn_01JQ8ZK7X4M8N2P5R6T7V8W9XY" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "pan": "4111111111111111",
  "cvv": "123",
  "expirationDate": "06/2031"
}
GET
/credit-cards/v1/vcns/{vcnId}/reveal
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
path
vcnIdstring
Required

Identificador do VCN retornado na emissão (campo vcnId).

header
X-Partner-Idstring
Required

Identificador da plataforma integradora (partner) pela qual a chamada é feita: ptn_ seguido de um ULID de 26 caracteres. É gerado pela Conta Simples e entregue a você no onboarding. Veja Identificação da plataforma.

Pattern: ^ptn_[0-9A-HJKMNP-TV-Z]{26}$
header
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header
Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

vcnIdstring
Required

Identificador do VCN retornado na emissão (campo vcnId).

Example:
01JQ8ZK7X4M8N2P5R6T7V8W9XY

Headers

X-Partner-Idstring
Required

Identificador da plataforma integradora (partner) pela qual a chamada é feita: ptn_ seguido de um ULID de 26 caracteres. É gerado pela Conta Simples e entregue a você no onboarding. Veja Identificação da plataforma.

Example:
ptn_01JQ8ZK7X4M8N2P5R6T7V8W9XY
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Responses

panstring
Required

Número do cartão (PAN). Não deve ser logado.

cvvstring
Required

Código de segurança (CVV).

expirationDatestring
Required

Validade física do cartão, no formato MM/YYYY — mês com dois dígitos e ano com quatro (ex.: 06/2031 = junho de 2031).