Skip to main content
Antes de integrar, vale entender os objetos principais e como eles se encaixam.

​
O modelo em uma frase

Uma transação representa uma cobrança e contém um ou mais pagamentos (tentativas de pagamento por um método). Quando um pagamento é pago, o valor é creditado em uma ou mais carteiras de recebedores, opcionalmente dividido por um split.

​
Glossário rápido

No mundo de assinaturas existem mais objetos — plano (plan_), preço (price_), Assinatura (sub_) e fatura (inv_). Veja Assinaturas. Outros prefixos que você verá: documento de chargeback (cbkd_), conta bancária (rba_) e movimentações de carteira (wtx_).

​
Transação × pagamento

Uma transação pode ter mais de um pagamento (pagamento combinado — ex.: parte no cartão, parte no PIX). O status da transação é calculado a partir dos status dos seus pagamentos: A lógica completa de cálculo está em Transactions.

​
Recebedor, carteira e saque

  • Por padrão, você é o recebedor “owner” e recebe 100% do valor (menos as taxas).
  • Em um marketplace, você cria outros recebedores e usa split para dividir cada venda.
  • O valor recebido entra na wallet do recebedor (com saldo available, pending e blocked).
  • O recebedor pode então solicitar um saque para a conta bancária.
Veja Split, Wallets e Valores & Taxas.