Documentação · Pagamento online

ConfraOnline

Link de pagamento, checkout com cartão e autenticação 3DS no sandbox ConfraOnline.

Base: https://sandbox.confraonline.com.br/api
Autenticação: Authorization: Bearer <token do seller EC gerado em Credenciais>

Particularidades só no sandbox

O fluxo tem duas etapas: `/store` cria o link; `/payment` envia cartão e cliente.
3DS (`in analysis`) e conclusão do pagamento podem ser simulados localmente no portal.
Não envie dados de cartão no `/store`.

Criar link de pagamento

Cria a cobrança link sem dados sensíveis de cartão.

Endpoint de teste

Criar link de pagamento

POSThttps://sandbox.confraonline.com.br/api/transaction-ec/store

Authorization: Bearer <token>

Sandbox ConfraOnline. Bearer token do seller EC. O playground local simula o mesmo contrato.

Parâmetros

amount obrigatório · number
Valor em reais.
payment_type opcional · debit|credit
Restringe o tipo no checkout.
brand opcional · string
Bandeira sugerida (visa, mastercard, elo…).
fee_exempt obrigatório · string
Parcelas sem juros; use none quando não houver.
description opcional · string
Descrição até 255 caracteres.
date_expiration opcional · string
Expiração AAAA-MM-DD HH:MM:SS.
callback_url opcional · string
Webhook http(s).

Respostas

status 201
Link criado.
transaction.status processing
Aguardando pagamento no checkout.
environment "sandbox"
Ambiente de teste.

Só no sandbox

O playground gera o mesmo contrato e guarda a cobrança só no tenant autenticado.

Exemplo de request

{
  "amount": 20,
  "fee_exempt": "none",
  "description": "Pagamento de teste",
  "callback_url": "https://example.com/callback",
  "date_expiration": "2026-12-31 23:59:59"
}

Submeter pagamento do link

Segunda etapa: cartão, cliente e parcelamento.

Endpoint de teste

Submeter pagamento do link

POSThttps://sandbox.confraonline.com.br/api/transaction-ec/payment

Authorization: Bearer <token>

Segunda etapa do ConfraOnline: envia cartão e cliente. Não incluir dados de cartão no /store.

Parâmetros

uuid obrigatório · string
Uuid do link criado no store.
payment_type obrigatório · debit|credit
Tipo de pagamento.
number_installments obrigatório · number
Parcelas (≥ 1).
ip_address obrigatório · string
IP do pagador.
customer obrigatório · object
Dados do cliente e cartão (holder, number, security_code, expiration_date, brand).
redirect_url opcional · string
Retorno após 3DS/checkout.

Respostas

transaction.status string
succeeded | declined | in analysis.
payment.urlAuthentication string|null
URL 3DS quando status = in analysis.
allowsRealMovement false
Sem captura real.

Só no sandbox

No portal, o checkout e o 3DS são simulados; cartões de teste não geram autorização bancária.

Consultar status do link

Polling do status após store/payment/3DS.

Endpoint de teste

Consultar status da transação

GEThttps://sandbox.confraonline.com.br/api/transaction-ec/show/{uuid}

Authorization: Bearer <token>

Use o uuid da cobrança. Pode ser usado em polling até a confirmação.

Parâmetros

uuid obrigatório · path
Uuid da cobrança.

Respostas

transaction.status string
processing | in analysis | succeeded | declined | expired | refunded.
transaction.confirmed boolean
Indica finalização.

Status após autenticação 3DS

Enquanto `in analysis`, consulte o show até a conclusão.

Endpoint de teste

Status após autenticação 3DS

GEThttps://sandbox.confraonline.com.br/api/transaction-ec/show/{uuid}

Authorization: Bearer <token>

Enquanto status for in analysis, consulte o show. A conclusão 3DS no portal é simulada localmente.

Parâmetros

uuid obrigatório · path
Uuid da cobrança em análise.

Respostas

transaction.status string
Passa de in analysis para succeeded/declined.

Só no sandbox

A conclusão 3DS no portal é local e não chama o host ConfraOnline.

← Voltar à documentação