API BANKING PUBLIC API · 2026-08-21

Integre pagamentos com uma API clara e previsível.

Integração HTTPS/JSON para os produtos publicados. Esta especificação descreve somente contratos disponíveis no domínio atual; recursos não publicados aparecem na matriz de disponibilidade e não devem ser inferidos.

Começar integração Baixar Postman

Base URL de produçãohttps://api.appbanking.com.br

HTTPS + JSON

Contratos simples, respostas estruturadas e exemplos prontos para o backend.

Idempotência

Repetições seguras nas operações financeiras sem duplicar movimentações.

Webhooks assinados

Entrega autenticada e retentativas com identificador estável.

Fundamentos

Autenticação

As rotas privadas usam duas credenciais enviadas somente pelo seu servidor. Nunca exponha o Client Secret no navegador, aplicativo móvel ou repositório.

Headers obrigatórios

Apikey: SEU_CLIENT_ID
X-Client-Secret: SEU_CLIENT_SECRET
Content-Type: application/json

Confiabilidade

Idempotência

Use de 8 a 100 caracteres e repita a mesma chave somente ao repetir exatamente o mesmo corpo. Corpo divergente com a mesma chave retorna conflito.

Regra importanteUse a mesma chave apenas quando estiver repetindo exatamente o mesmo corpo da requisição.

Criptomoedas

Fluxo de carteira, depósito e envio

A API cripto usa as mesmas credenciais servidor-a-servidor. Consulte o catálogo antes de operar: ele é a fonte de verdade para moedas, redes, confirmações e disponibilidade de entrada ou saída.

Crie a carteira

Liste /api/v1/crypto/assets e envie o par asset/network para /api/v1/crypto/wallets. A criação é idempotente por conta, moeda e rede.

Receba automaticamente

Consulte o endereço da carteira. A Api Banking monitora a blockchain, aguarda as confirmações da rede e credita o ledger sem ação manual.

Envie automaticamente

Calcule o preview, confirme com a mesma cotação e uma Idempotency-Key. Reserva, assinatura KMS, transmissão e confirmação continuam em segundo plano.

Valores e segurançaEnvie valores cripto como string decimal na unidade do ativo. No painel o usuário confirma com PIN; na API, o Client Secret e o escopo cashout autenticam o servidor integrador. Nunca coloque essas credenciais no frontend.

Acompanhe o resultadoConsulte /api/v1/crypto/withdrawals/{withdrawalId} até o estado terminal e use /api/v1/crypto/transactions para conciliação. Repetições devem preservar corpo e chave de idempotência.

Eventos

Webhooks

Valide a assinatura usando o corpo bruto recebido antes de interpretar o JSON. Respostas 2xx confirmam a entrega.

Headers de entrega

X-Vexus-Event: checkout.order.status_changed
X-Vexus-Delivery: <uuid>
X-Vexus-Timestamp: <unix_timestamp>
X-Vexus-Signature: v1=<hmac_sha256>

Referência completa

Endpoints publicados

Os exemplos abaixo são derivados do mesmo contrato que gera o OpenAPI e a coleção Postman.

Módulo

Status

Disponibilidade técnica sem autenticação.

GET /health/live Público

Liveness

Verifica se o processo HTTP está ativo.

cURL

curl -X GET 'https://api.appbanking.com.br/health/live'

GET /health/ready Público

Readiness

Valida banco, migrações e dependências internas necessárias para receber tráfego.

cURL

curl -X GET 'https://api.appbanking.com.br/health/ready'

Módulo

PIX

Entrada, saída, leitura e pagamento de QR Code PIX.

POST /api/v1/cashin Credenciais

Criar cobrança PIX

Cria uma cobrança PIX dinâmica.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cashin' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": 25.9,
    "payer_name": "Cliente de Exemplo",
    "payer_document": "52998224725",
    "payer_email": "cliente@example.com",
    "description": "Pedido 1024",
    "external_id": "pedido-1024"
}'

Ver corpo de exemplo

{
    "amount": 25.9,
    "payer_name": "Cliente de Exemplo",
    "payer_document": "52998224725",
    "payer_email": "cliente@example.com",
    "description": "Pedido 1024",
    "external_id": "pedido-1024"
}

POST /api/v1/cashout Credenciais

Enviar PIX

Envia um PIX para a chave informada, sujeito a saldo, produto e limites da conta.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cashout' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": 20,
    "pix_key": "<chave-pix-destino>",
    "pix_key_type": "random",
    "description": "Repasse"
}'

Ver corpo de exemplo

{
    "amount": 20,
    "pix_key": "<chave-pix-destino>",
    "pix_key_type": "random",
    "description": "Repasse"
}

POST /api/v1/pix/qr/decode Credenciais

Ler QR Code PIX

Valida e decodifica um payload EMV PIX sem movimentar saldo.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/pix/qr/decode' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907Api Banking6009SAO PAULO62070503***6304ABCD"
}'

Ver corpo de exemplo

{
    "payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907Api Banking6009SAO PAULO62070503***6304ABCD"
}

POST /api/v1/pix/qr/pay Credenciais

Pagar QR Code PIX

Paga um QR Code PIX após validação do payload e dos limites.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/pix/qr/pay' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907Api Banking6009SAO PAULO62070503***6304ABCD",
    "amount": 39.9,
    "description": "Fornecedor"
}'

Ver corpo de exemplo

{
    "payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907Api Banking6009SAO PAULO62070503***6304ABCD",
    "amount": 39.9,
    "description": "Fornecedor"
}

Módulo

Boleto

Emissão, consulta e pagamento de boleto.

POST /api/v1/boleto/issue Credenciais

Emitir boleto

Emite uma cobrança direta usando o cadastro da conta.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/boleto/issue' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": 99.9,
    "due_date": "2026-09-30",
    "description": "Cobrança por boleto"
}'

Ver corpo de exemplo

{
    "amount": 99.9,
    "due_date": "2026-09-30",
    "description": "Cobrança por boleto"
}

POST /api/v1/boleto/info Credenciais

Consultar boleto

Consulta os dados de um boleto sem movimentar saldo.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/boleto/info' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "billetCode": "00000000000000000000000000000000000000000000"
}'

Ver corpo de exemplo

{
    "billetCode": "00000000000000000000000000000000000000000000"
}

POST /api/v1/boleto/pay Credenciais

Pagar boleto

Reconsulta o valor e o beneficiário no provedor; envie somente o código.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/boleto/pay' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "billetCode": "00000000000000000000000000000000000000000000"
}'

Ver corpo de exemplo

{
    "billetCode": "00000000000000000000000000000000000000000000"
}

Módulo

Cripto

Catálogo, carteiras, endereços, saldos, histórico e envios on-chain.

GET /api/v1/crypto/networks Credenciais

Listar redes cripto

Retorna as redes de custódia habilitadas pela Api Banking para a conta.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/networks' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/assets Credenciais

Listar ativos cripto

Retorna ativos por rede, casas decimais e capacidades de depósito, saque e swap.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/assets' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/wallets Credenciais

Listar carteiras cripto

Retorna as carteiras HD por rede da conta.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/wallets' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/crypto/wallets Credenciais

Criar carteira cripto

Cria de forma idempotente uma carteira para a rede BSC ou TRON. Tokens da mesma rede usam o mesmo endereço.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/wallets' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "network": "BSC"
}'

Ver corpo de exemplo

{
    "network": "BSC"
}

GET /api/v1/crypto/wallets/{walletId} Credenciais

Consultar carteira cripto

Retorna endereço, rede e estado da carteira.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/wallets/{walletId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/wallets/{walletId}/balances Credenciais

Consultar saldos cripto

Retorna saldos em unidades inteiras: ledger, disponível, reservado, pendente e on-chain.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/wallets/{walletId}/balances' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/wallets/{walletId}/transactions Credenciais

Listar transações da carteira

Lista depósitos e saques vinculados à carteira.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/wallets/{walletId}/transactions' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/deposits Credenciais

Listar depósitos cripto

Lista depósitos detectados, confirmados, creditados e demais estados de reconciliação.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/deposits' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/crypto/deposits/{depositId} Credenciais

Consultar depósito cripto

Retorna o estado atual de um depósito.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/deposits/{depositId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/crypto/withdrawals/quote Credenciais

Cotar saque cripto

Valida destino e retorna cotação autoritativa, taxas, débito total e expiração. Não movimenta saldo.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/withdrawals/quote' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "network": "BSC",
    "asset": "USDT_BSC",
    "destination_address": "0x1111111111111111111111111111111111111111",
    "amount_units": "1000000000000000000",
    "amount_mode": "NET"
}'

Ver corpo de exemplo

{
    "network": "BSC",
    "asset": "USDT_BSC",
    "destination_address": "0x1111111111111111111111111111111111111111",
    "amount_units": "1000000000000000000",
    "amount_mode": "NET"
}

POST /api/v1/crypto/withdrawals Credenciais

Confirmar saque cripto

Confirma somente uma quote_id válida. O status 202 significa agendamento; acompanhe o recurso até o estado terminal.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/withdrawals' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "quote_id": "00000000-0000-4000-8000-000000000002"
}'

Ver corpo de exemplo

{
    "quote_id": "00000000-0000-4000-8000-000000000002"
}

GET /api/v1/crypto/withdrawals/{withdrawalId} Credenciais

Consultar saque cripto

Retorna estado, hash blockchain, valores e taxas.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/withdrawals/{withdrawalId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/crypto/swaps/quote Credenciais

Cotar swap cripto

Consulta cotação por ativos da mesma rede usando unidades inteiras; não movimenta saldo.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/swaps/quote' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "asset_in": "USDT_BSC",
    "asset_out": "USDC_BSC",
    "amount_in_units": "1000000000000000000",
    "slippage_bps": 50
}'

Ver corpo de exemplo

{
    "asset_in": "USDT_BSC",
    "asset_out": "USDC_BSC",
    "amount_in_units": "1000000000000000000",
    "slippage_bps": 50
}

POST /api/v1/crypto/swaps Credenciais

Executar swap cripto

Reserva e agenda um swap pela quote_id. HTTP 202 não confirma liquidação; acompanhe o recurso.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/swaps' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "quote_id": "00000000-0000-4000-8000-000000000003"
}'

Ver corpo de exemplo

{
    "quote_id": "00000000-0000-4000-8000-000000000003"
}

GET /api/v1/crypto/swaps/{swapId} Credenciais

Consultar swap cripto

Retorna o estado do swap e hashes de liquidação quando disponíveis.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/swaps/{swapId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/crypto/conversions/brl-usdt/preview Credenciais

Prévia BRL para USDT

Compatibilidade legada. Consulte capabilities e use somente quando a conversão estiver habilitada pela Api Banking.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/conversions/brl-usdt/preview' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": "100.00",
    "destination_mode": "Api Banking_WALLET"
}'

Ver corpo de exemplo

{
    "amount": "100.00",
    "destination_mode": "Api Banking_WALLET"
}

POST /api/v1/crypto/conversions/brl-usdt Credenciais

Confirmar BRL para USDT

Compatibilidade legada sujeita às capacidades publicadas pela Api Banking.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/crypto/conversions/brl-usdt' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": "100.00",
    "destination_mode": "Api Banking_WALLET",
    "pin": "123456"
}'

Ver corpo de exemplo

{
    "amount": "100.00",
    "destination_mode": "Api Banking_WALLET",
    "pin": "123456"
}

GET /api/v1/crypto/conversions/brl-usdt/{conversionId} Credenciais

Consultar conversão BRL para USDT

Retorna o estado conciliado da conversão.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/crypto/conversions/brl-usdt/{conversionId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

Módulo

Cartões

Emissão e gestão de cartões virtuais Api Banking.

GET /api/v1/cards/products Credenciais

Listar produtos de cartão

Retorna os tipos de cartão virtual habilitados para a conta Api Banking.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards/products' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/cards/rates Credenciais

Consultar taxas de cartões

Retorna as taxas e limites publicados para cartões virtuais Api Banking.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards/rates' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/cards/webhooks Credenciais

Listar webhooks de OTP

Lista os endpoints HTTPS cadastrados para receber eventos de OTP de cartão virtual.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards/webhooks' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/cards/webhooks Credenciais

Configurar webhook de OTP

Cadastra um endpoint HTTPS para receber eventos assinados de OTP de cartão virtual.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cards/webhooks' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "label": "Meu endpoint OTP",
    "url": "https://example.com/api/card-otp"
}'

Ver corpo de exemplo

{
    "label": "Meu endpoint OTP",
    "url": "https://example.com/api/card-otp"
}

GET /api/v1/cards Credenciais

Listar cartões virtuais

Lista os cartões virtuais pertencentes à conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/cards Credenciais

Emitir cartão virtual

Emite um cartão virtual Api Banking para o produto e valor informados.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cards' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "product_code": "Api Banking_international",
    "amount": "10.00",
    "name_on_card": "CLIENTE EXEMPLO"
}'

Ver corpo de exemplo

{
    "product_code": "Api Banking_international",
    "amount": "10.00",
    "name_on_card": "CLIENTE EXEMPLO"
}

GET /api/v1/cards/{cardId} Credenciais

Consultar cartão virtual

Retorna o estado e os dados não sensíveis do cartão virtual.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards/{cardId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

DELETE /api/v1/cards/{cardId} Credenciais

Cancelar cartão virtual

Cancela o cartão virtual. A operação não pode ser desfeita.

Exige Idempotency-Key.

cURL

curl -X DELETE 'https://api.appbanking.com.br/api/v1/cards/{cardId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{}'

Ver corpo de exemplo

{}

POST /api/v1/cards/{cardId}/fund Credenciais

Recarregar cartão virtual

Adiciona saldo ao cartão virtual usando a conta Api Banking.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cards/{cardId}/fund' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": "10.00"
}'

Ver corpo de exemplo

{
    "amount": "10.00"
}

POST /api/v1/cards/{cardId}/freeze Credenciais

Congelar cartão virtual

Congela temporariamente o cartão virtual.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cards/{cardId}/freeze' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{}'

Ver corpo de exemplo

{}

POST /api/v1/cards/{cardId}/unfreeze Credenciais

Descongelar cartão virtual

Descongela o cartão virtual.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/cards/{cardId}/unfreeze' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{}'

Ver corpo de exemplo

{}

GET /api/v1/cards/{cardId}/transactions Credenciais

Listar transações do cartão

Lista as transações do cartão virtual sem expor dados sensíveis.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/cards/{cardId}/transactions' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

Módulo

Checkout

Meios, produtos, links e relatório do checkout Api Banking.

GET /api/v1/checkout/methods Credenciais

Listar meios de checkout

Retorna somente meios de pagamento homologados e disponíveis para a conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/methods' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/checkout/report Credenciais

Consultar relatório de checkout

Retorna métricas agregadas dos links e pedidos pertencentes à conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/report' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/checkout/products Credenciais

Listar produtos de checkout

Lista produtos ativos e arquivados do catálogo da conta.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/products' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/checkout/products Credenciais

Criar produto de checkout

Cria um produto no catálogo. Meios que exigem identificação de produto externo só podem ser usados quando provider_product_id for informado.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/checkout/products' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "name": "Produto de exemplo",
    "price": "49.90",
    "currency": "BRL",
    "payment_methods": [
        "PIX"
    ]
}'

Ver corpo de exemplo

{
    "name": "Produto de exemplo",
    "price": "49.90",
    "currency": "BRL",
    "payment_methods": [
        "PIX"
    ]
}

GET /api/v1/checkout/products/{productId} Credenciais

Consultar produto de checkout

Retorna o produto do catálogo pertencente à conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/products/{productId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

PUT /api/v1/checkout/products/{productId} Credenciais

Atualizar produto de checkout

Atualiza uma versão do produto. Envie version retornado na leitura para impedir sobrescrita concorrente.

Exige Idempotency-Key.

cURL

curl -X PUT 'https://api.appbanking.com.br/api/v1/checkout/products/{productId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "name": "Produto atualizado",
    "price": "59.90",
    "currency": "BRL",
    "payment_methods": [
        "PIX"
    ],
    "version": 1
}'

Ver corpo de exemplo

{
    "name": "Produto atualizado",
    "price": "59.90",
    "currency": "BRL",
    "payment_methods": [
        "PIX"
    ],
    "version": 1
}

DELETE /api/v1/checkout/products/{productId} Credenciais

Arquivar produto de checkout

Arquiva o produto e os links ativos associados. A ação exige Idempotency-Key e não aceita corpo.

Exige Idempotency-Key.

cURL

curl -X DELETE 'https://api.appbanking.com.br/api/v1/checkout/products/{productId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1'

GET /api/v1/checkout/links Credenciais

Listar links de checkout

Lista links de pagamento, estado e métricas da conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/links' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/checkout/links Credenciais

Criar link de checkout

Cria um link avulso ou associado a produto. O payment_path retornado deve ser combinado com seu domínio Api Banking.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/checkout/links' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "title": "Link de exemplo",
    "product_id": 1,
    "payment_methods": [
        "PIX"
    ]
}'

Ver corpo de exemplo

{
    "title": "Link de exemplo",
    "product_id": 1,
    "payment_methods": [
        "PIX"
    ]
}

GET /api/v1/checkout/links/{linkId} Credenciais

Consultar link de checkout

Retorna a configuração e o payment_path do link pertencente à conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/checkout/links/{linkId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

PUT /api/v1/checkout/links/{linkId} Credenciais

Atualizar link de checkout

Atualiza uma versão do link. Envie version retornado na leitura para impedir sobrescrita concorrente.

Exige Idempotency-Key.

cURL

curl -X PUT 'https://api.appbanking.com.br/api/v1/checkout/links/{linkId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "title": "Link atualizado",
    "product_id": 1,
    "payment_methods": [
        "PIX"
    ],
    "version": 1
}'

Ver corpo de exemplo

{
    "title": "Link atualizado",
    "product_id": 1,
    "payment_methods": [
        "PIX"
    ],
    "version": 1
}

POST /api/v1/checkout/links/{linkId}/archive Credenciais

Arquivar link de checkout

Arquiva o link e impede novos pagamentos. Exige Idempotency-Key e não aceita corpo.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/checkout/links/{linkId}/archive' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1'

POST /api/v1/checkout/links/{linkId}/cancel Credenciais

Cancelar link de checkout

Cancela o link com motivo auditável e impede novos pagamentos. Exige Idempotency-Key.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/checkout/links/{linkId}/cancel' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "reason": "Cancelamento solicitado pelo integrador."
}'

Ver corpo de exemplo

{
    "reason": "Cancelamento solicitado pelo integrador."
}

Módulo

Conta

Consulta de saldo conforme o produto habilitado.

GET /api/v1/account/fees Credenciais

Taxas da conta

Retorna as taxas comerciais efetivas para PIX, boleto, cartão, cartão virtual, transferência interna e regras por ativo/rede cripto.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/account/fees' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/account/limits Credenciais

Limites da conta

Retorna os limites financeiros efetivos da conta em BRL para agregado, PIX, boleto e transferência interna.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/account/limits' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/balance Credenciais

Consultar saldo

Consulta o saldo exposto pelo contrato da conta. Envie um objeto JSON vazio.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/balance' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Content-Type: application/json' \
  --data '{}'

Ver corpo de exemplo

{}

Módulo

White Label

Contrato, plano, taxas, cobrança e status da conta Api Banking.

GET /api/v1/white-label Credenciais

Consultar White Label

Retorna, em uma única resposta, a situação do contrato, plano, adicionais, cobrança, taxas e produtos efetivamente habilitados.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/white-label' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/white-label/plan Credenciais

Consultar plano White Label

Retorna o plano e os adicionais contratados pela conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/white-label/plan' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/white-label/fees Credenciais

Consultar taxas White Label

Retorna as taxas comerciais do plano, incluindo PIX, boleto, cartão virtual e regras por ativo/rede cripto.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/white-label/fees' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/white-label/billing Credenciais

Consultar cobrança White Label

Retorna mensalidade, entrada, valor pendente, vencimento e situação de acesso. Não cria cobrança nem movimenta saldo.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/white-label/billing' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

GET /api/v1/white-label/status Credenciais

Consultar status White Label

Retorna somente a situação do contrato e se operações financeiras pela API estão liberadas.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/white-label/status' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

Módulo

Split

Regras, execução, consulta, cancelamento, devolução e relatório de Split Payment.

GET /api/v1/splits/rules Credenciais

Listar regras de split

Lista as regras pertencentes à conta autenticada.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/splits/rules' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/splits/rules Credenciais

Criar regra de split

Cria uma regra versionada por percentuais ou valores fixos.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/splits/rules' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "name": "Parceiros",
    "mode": "PERCENTAGE",
    "currency": "BRL",
    "participants": [
        {
            "handle": "conta-parceira",
            "percentage": "20.00"
        }
    ]
}'

Ver corpo de exemplo

{
    "name": "Parceiros",
    "mode": "PERCENTAGE",
    "currency": "BRL",
    "participants": [
        {
            "handle": "conta-parceira",
            "percentage": "20.00"
        }
    ]
}

PUT /api/v1/splits/rules/{ruleId} Credenciais

Revisar regra de split

Arquiva a versão anterior e cria uma nova versão da regra.

Exige Idempotency-Key.

cURL

curl -X PUT 'https://api.appbanking.com.br/api/v1/splits/rules/{ruleId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "name": "Parceiros v2",
    "mode": "PERCENTAGE",
    "currency": "BRL",
    "participants": [
        {
            "handle": "conta-parceira",
            "percentage": "25.00"
        }
    ]
}'

Ver corpo de exemplo

{
    "name": "Parceiros v2",
    "mode": "PERCENTAGE",
    "currency": "BRL",
    "participants": [
        {
            "handle": "conta-parceira",
            "percentage": "25.00"
        }
    ]
}

DELETE /api/v1/splits/rules/{ruleId} Credenciais

Arquivar regra de split

Arquiva a regra da conta. Esta operação não aceita corpo.

cURL

curl -X DELETE 'https://api.appbanking.com.br/api/v1/splits/rules/{ruleId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/splits Credenciais

Criar split

Cria a operação financeira e suas alocações a partir de uma regra ativa.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/splits' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "rule_id": "00000000-0000-4000-8000-000000000001",
    "amount": 100,
    "payer": {
        "name": "Cliente de Exemplo",
        "document": "52998224725",
        "email": "cliente@example.com"
    }
}'

Ver corpo de exemplo

{
    "rule_id": "00000000-0000-4000-8000-000000000001",
    "amount": 100,
    "payer": {
        "name": "Cliente de Exemplo",
        "document": "52998224725",
        "email": "cliente@example.com"
    }
}

GET /api/v1/splits/{splitId} Credenciais

Consultar split

Retorna a operação e as alocações visíveis à conta proprietária.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/splits/{splitId}' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/splits/{splitId}/cancel Credenciais

Cancelar split

Cancela um split somente quando o estado financeiro permitir. Não aceita corpo.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/splits/{splitId}/cancel' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

POST /api/v1/splits/{splitId}/refund Credenciais

Solicitar devolução do split

Solicita devolução parcial ou total; uma resposta 202 indica processamento assíncrono.

Exige Idempotency-Key.

cURL

curl -X POST 'https://api.appbanking.com.br/api/v1/splits/{splitId}/refund' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET' \
  -H 'Idempotency-Key: pedido-1024-tentativa-1' \
  -H 'Content-Type: application/json' \
  --data '{
    "amount": 25,
    "comment": "Devolução parcial solicitada pelo cliente"
}'

Ver corpo de exemplo

{
    "amount": 25,
    "comment": "Devolução parcial solicitada pelo cliente"
}

GET /api/v1/splits/report Credenciais

Relatório de participante

Retorna itens da conta autenticada no intervalo UTC informado.

cURL

curl -X GET 'https://api.appbanking.com.br/api/v1/splits/report' \
  -H 'Apikey: SEU_CLIENT_ID' \
  -H 'X-Client-Secret: SEU_CLIENT_SECRET'

Transparência

Disponibilidade

PIX cash-in/cash-out/QR PUBLISHED

Boleto issue/info/pay PUBLISHED

Crypto assets/wallets/deposits/withdrawals/history PUBLISHED

Crypto swap quote PUBLISHED_QUOTE_ONLY

BRL para USDT BEP20 PUBLISHED

Split rules/create/get/cancel/refund/report PUBLISHED

Virtual cards/products/issue/fund/freeze PUBLISHED

Generic transaction query NOT_PUBLISHED

Api Banking Cards PUBLISHED_WITH_EXPLICIT_AUTHORIZATION

Checkout management API PUBLISHED

Account fees and limits PUBLISHED_WITH_EXPLICIT_AUTHORIZATION

White Label contract/plan/fees/billing/status PUBLISHED

Client webhooks PUBLISHED

Public MED/dispute API NOT_PUBLISHED