Início

PIX · Cartão · Boleto

Cobrança, conciliação e saque no mesmo lugar.

Cada seção abaixo descreve o que a API faz hoje — com os limites e os padrões exatos.

methods: ["PIX"]

PIX

QR dinâmico e copia e cola gerados na criação da cobrança, com liquidação no saldo em D+0.

pixCopyPaste00020126...
  • Expiração configurável de 5 minutos a 7 dias — padrão de 60 minutos
  • Estorno total ou parcial pela API, uma vez por cobrança
  • MED acompanhado na plataforma, com eventos MED_RECEIVED e MED_RESOLVED
  • endToEndId disponível para conciliação bancária

methods: ["CARD"]

Cartão de crédito

Cobrança direta à vista, com pré-autorização opcional em duas etapas.

authorizeOnlyAUTHORIZEDcapture → PAIDvoid → CANCELLED
  • authorizeOnly retém o valor; captura ou cancelamento em chamada própria
  • Bandeira e final do cartão na resposta, nunca o número completo
  • Valor mínimo de R$ 5,00
  • Sem parcelamento: transações à vista

methods: ["BOLETO"]

Boleto

Linha digitável, código de barras e PDF na resposta da criação.

  • Vencimento configurável em até 1 ano
  • Multa, juros e desconto por antecipação, por boleto
  • Boleto pago após o vencimento ainda liquida no saldo
  • Valor mínimo de R$ 5,00

mode: "hosted"

Checkout hospedado

mode: hosted devolve uma URL de pagamento pronta; o pagador escolhe o meio e a cobrança avança sozinha.

PENDING_METHOD_SELECTIONPIX · CARD · BOLETOPAID
  • URL própria por cobrança em checkout.yuvexpay.com
  • Meios oferecidos definidos por cobrança no campo methods
  • returnUrl e completionUrl para voltar à sua loja
  • Status PENDING_METHOD_SELECTION até a escolha do pagador

/v1/products

Catálogo de produtos

Produtos com preço e imagem, referenciados na cobrança por productId.

  • CRUD completo via API e dashboard
  • externalId para casar com o seu catálogo
  • Disponível também no sandbox

ledger

Extrato e relatórios

Cada lançamento carrega o saldo resultante — o extrato fecha por construção, e dá para provar.

ledgeramountbalance
PAYMENT_RECEIVED+ 129,908.412,05
FEE− 6,688.405,37
WITHDRAWAL− 2.500,005.905,37
  • Extrato com saldo após cada lançamento e verificação de integridade sob demanda
  • Exportação de pagamentos, saques e extrato em CSV, XLSX, PDF e OFX
  • Análise de taxas e previsão de liquidação por período
  • Filtros por status, meio, datas e valores em todas as listagens

HMAC-SHA256

Webhooks

Cada mudança de status vira um evento assinado no seu endpoint.

X-Webhook-Signature: v1=8f2ba9...X-Webhook-Timestamp: 1784822400X-Webhook-Event: PAYMENT_PAIDX-Webhook-Attempt: 1
  • Doze eventos, de PAYMENT_CONFIRMED a WITHDRAWAL_FAILED
  • Assinatura HMAC-SHA256 com timestamp e janela anti-replay de 300 segundos
  • Retentativas com backoff exponencial — 3 por padrão, até 10
  • Cabeçalhos de entrega com evento, tentativa e id únicos

Comece no sandbox.

Toda conta nasce em sandbox, com chaves de teste e webhooks reais. Ativar produção não muda uma linha do seu código.

Webhooks assinados com HMAC-SHA256Liquidação PIX em D+0Estorno total ou parcial via APIExportação CSV, XLSX, PDF e OFXExtrato com verificação de integridadePré-autorização e captura no cartãoSandbox com webhooks reaisLGPD: exportação e exclusão de dados