Diamond Pay
Criar conta
EN PT
Integração — Referência de API

Fundamentos

Visão geralArquitetura da plataformaComeçando

Pagamentos

CobrançasCheckout & Payment LinksRecorrênciaTokenização3DS & ZeroauthEstornos e chargebacks

Operações

PayoutsCâmbio e multi-moeda

Motor

Gestão de riscoOrquestraçãoLiquidação

Integração

Referência de APIWebhooks

Plataformas

Console do operadorPortal do lojista

Integração

Referência de API

A API é o coração da integração. Aqui está o mapa dos endpoints mais usados em cada área da plataforma.

Autenticação

As chamadas de servidor para servidor usam suas credenciais de API. Ambientes administrativos (staff e operador) usam sessão OAuth/Keycloak; lojistas usam sessão própria do portal.

Cobranças (Bank Manager)

MétodoEndpointDescrição
POST/api/v1/bank/wallet/charge/Cria uma cobrança
GET/api/v1/bank/wallet/charge/Consulta cobranças
POST/api/v1/bank/wallet/charge/capture/Captura uma cobrança
POST/api/v1/bank/wallet/charge/<uuid>/refund/<wallet_uuid>/Estorna uma cobrança
GET/api/v1/bank/public/chargeCheckout público de cobrança
POST/api/v1/bank/public/charge/<uuid>/payPaga uma cobrança (fluxo público)

Carteiras e pagamentos

MétodoEndpointDescrição
POST/api/v1/bank/wallet/Cria carteira
GET/api/v1/bank/wallet/Lista carteiras
POST/api/v1/bank/wallet/payout/Cria payout
GET/api/v1/bank/wallet/payout/<uuid>/<wallet_uuid>/Consulta payout

Payment links e assinaturas

MétodoEndpointDescrição
POST/api/v1/bank/wallet/payment-link/Cria payment link / checkout
POST/api/v1/bank/wallet/subscription/Cria assinatura
POST/api/v1/bank/wallet/subscription/<uuid>/cancel/<wallet_uuid>/Cancela assinatura

Câmbio, tokenização, autenticação e BIN

MétodoEndpointDescrição
GET/api/v1/bank/wallet/fx/rate/Consulta taxa de câmbio
POST/api/v1/bank/wallet/tokenization/Tokeniza um cartão
POST/api/v1/bank/wallet/zeroauth/Autorização de valor zero
POST/api/v1/bank/wallet/setup-authentication/Prepara autenticação 3DS
POST/api/v1/bank/wallet/charge/authentication/<uuid>/validate/Valida autenticação
GET/api/v1/bank/wallet/bin/<card_bin>/Consulta dados do BIN

Gestão (BFF)

MétodoEndpointDescrição
GET/api/v1/bff/accounts/Contas e resumo operacional
GET/api/v1/bff/transactions/Transações do operador
GET/api/v1/bff/analytics/approval-rate-dashboardAnálise de taxa de aprovação
GET/api/v1/bff/risk/rulesRegras de risco
GET/api/v1/bff/orchestration/workflowsWorkflows de orquestração
GET/api/v1/bff/merchant/analytics/summaryResumo do lojista

Boas práticas

  • Use idempotência em criação de cobrança e payout — nunca duplique o mesmo pedido.
  • Confirme pagamento pela API antes de entregar produto ou serviço.
  • Trate estornos e chargebacks de forma programática, não manual.
  • Monitore webhooks: eles são a única notificação assíncrona dos eventos.