Integração — Referência de API

Fundamentos

Visão geral Arquitetura da plataforma Começando Autenticação Ambientes e credenciais

Receber

Criar cobrança Meios de pagamento Ciclo de vida e status Estornos e chargebacks Payment Links e Checkout Assinaturas e recorrência

Serviços de cartão

Tokenização Zeroauth e validação

Liquidação

Saques e transferências

Integração

Webhooks Referência de API Portal do lojista

Testes

Cartões de teste

Integração

Referência de API

Referência completa dos endpoints públicos da plataforma. Todas as autenticações usam Authorization: Bearer <token>.

Carteiras

GET/api/v1/bank/wallet/

Lista as carteiras da conta autenticada.

POST/api/v1/bank/wallet/

Cria uma carteira (outras carteiras vinculadas à entidade).

Cobranças

POST/api/v1/bank/wallet/charge/

Cria uma cobrança Pix, boleto, cartão ou outro meio.

GET/api/v1/bank/wallet/charge/

Lista cobranças da carteira com filtros por status e período.

POST/api/v1/bank/wallet/charge/capture/

Captura um cartão previamente autorizado (confirmed).

POST/api/v1/bank/wallet/charge/<charge_uuid>/refund/<wallet_uuid>/

Estorna total ou parcialmente uma cobrança.

GET/api/v1/bank/public/charge/<charge_uuid>/

Consulta pública de cobrança (exibe dados de pagamento).

Checkout e recorrência

POST/api/v1/bank/wallet/payment-link/

Cria um payment link com página de pagamento hospedada.

GET/api/v1/bank/wallet/payment-link/

Lista os payment links da carteira.

POST/api/v1/bank/wallet/subscription/

Cria uma assinatura recorrente.

POST/api/v1/bank/wallet/subscription/<subscription_uuid>/cancel/<wallet_uuid>/

Cancela uma assinatura.

Serviços de cartão

POST/api/v1/bank/wallet/tokenization/

Tokeniza um cartão.

POST/api/v1/bank/wallet/zeroauth/

Valida um cartão com autorização de valor zero.

GET/api/v1/bank/wallet/bin/<card_bin>/

Consulta os dados do BIN do cartão.

Payouts

POST/api/v1/bank/payout/

Cria um saque para a sua conta bancária ou uma transferência interna de split.

GET/api/v1/bank/payout/<payout_uuid>/<wallet_uuid>/

Consulta o status de um payout.

Portal do lojista

GET/api/v1/bff/account/

Dados da conta autenticada e recursos habilitados.

GET/api/v1/bff/merchant/transactions/

Transações do merchant para o portal do lojista.