Create hosted card session

post

https://api.autra.io/v1/acquiring/card-sessions

Cria uma sessão de tokenização hospedada, de uso único e curta duração, e retorna a hostedCardUrl que o app carrega no React Native Card SDK. O portador digita o cartão na página hospedada da Autra e a tokenização acontece lá — o PAN/CVV nunca passa pelo merchant. Server-to-server: chame do seu backend com o access token, nunca do app. O IP do backend precisa estar na allow-list do tenant (senão 403).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

documentId

string

required

CPF ou CNPJ do merchant dono da sessão (somente dígitos) — não é o documento do portador.

purpose

string

enum

Defaults to TOKENIZE

TOKENIZE (padrão) só salva o cartão. ENROLLMENT salva o cartão E abre a série recorrente na própria página hospedada: primeira venda de valor zero com isFirstRecurring, usando o CVV que a página acabou de receber. O resultado (paymentId, brandReferenceId) volta para a página, para o webhook acquiring.card_enrollment.completed|failed e em GET /v1/acquiring/payments/{id}. Vendas seguintes da série vão com slugStoredCard + recurringData.brandReferenceId, sem CVV.

Allowed:

channel

string

enum

Defaults to app

app (padrão) é a WebView do app com o React Native Card SDK. web embute a página no site do estabelecimento (@autra-io/card-sdk-web): exige a feature card_sdk_web no tenant (403 CARD_SDK_WEB_DISABLED) e uma origin cadastrada e ativa em /v1/tenants/card-sdk/origins (422 CARD_SDK_ORIGIN_NOT_REGISTERED).

Allowed:

origin

string

Obrigatória em channel=web. https://<host>[:porta] do site que vai embutir a página, exatamente como o navegador envia: minúsculas, sem caminho nem barra final, sem :443, porta 1–65535 sem zero à esquerda, host DNS com 2+ rótulos, sem IP (422 CARD_SDK_ORIGIN_INVALID fora disso).

enrollmentCharge

string

enum

Defaults to ZERO_DOLLAR

Só em ENROLLMENT. ZERO_DOLLAR abre a série sem cobrar. IMMEDIATE (cobrar na adesão) ainda não está disponível — 422 ENROLLMENT_CHARGE_UNAVAILABLE.

Allowed:

externalRef

string

length ≤ 120

^[A-Za-z0-9._:\-]{1,120}$

Só em ENROLLMENT. Identificador do cliente ou pedido no seu sistema; volta no webhook da adesão. Com subscriptionId, omita ou envie o mesmo externalRef da assinatura (422 SUBSCRIPTION_EXTERNAL_REF_MISMATCH).

subscriptionId

uuid

Só em ENROLLMENT. Assinatura (POST /v1/acquiring/subscriptions) em PENDING_ENROLLMENT do mesmo estabelecimento cujo plano aceita CARD. Quando a adesão é aprovada, o cartão salvo passa a ser o meio de pagamento da assinatura, ela vira ACTIVE e o webhook subscription.activated é emitido; as faturas passam a ser cobradas nesse cartão a cada vencimento. Só a assinatura informada aqui é ativada — nunca por coincidência de externalRef. 404 SUBSCRIPTION_NOT_FOUND fora do estabelecimento; 409 SUBSCRIPTION_NOT_AWAITING_ENROLLMENT se ela já está ativa, cancelada ou o plano não aceita cartão.

Responses

400

Corpo inválido ou documentId ausente

403

Tenant não autenticado ou IP fora da allow-list

404

Merchant não encontrado no tenant; SUBSCRIPTION_NOT_FOUND

409

Merchant não está pronto para adquirência (ACQUIRING_NOT_READY); SUBSCRIPTION_NOT_AWAITING_ENROLLMENT

422

CPF/CNPJ inválido; CARD_SDK_ORIGIN_INVALID; CARD_SDK_ORIGIN_NOT_REGISTERED; ENROLLMENT_CHARGE_UNAVAILABLE; SUBSCRIPTION_EXTERNAL_REF_MISMATCH

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Sessão criada