Cobranças
Criar cobrança
Gera uma cobrança (BKY-) por Pix (Copia e Cola, que também vira QR Code), cartão de crédito (link da página de pagamento) ou cripto (valor na moeda e endereço).
POST
Escopo da forma de pagamento:
payments:write no Pix, card:write no cartão e crypto:write em cripto (sem ele, 403 FORBIDDEN). A cobrança nasce pending; quando o pagamento é confirmado, vira paid e o webhook payment.paid avisa. Sem pagamento até a validade, vira expired (no Pix, ainda assim é creditada se o Pix cair depois). Veja antes as formas disponíveis para a conta.
8 a 128 caracteres, única por pedido (um UUID ou o número do pedido). Repetir com os mesmos dados devolve a mesma cobrança; com dados diferentes,
422 IDEMPOTENCY_KEY_REUSED.Valor em centavos. Abaixo do mínimo da conta:
BELOW_MINIMUM; fora da faixa aceita no momento: BELOW_PROVIDER_MINIMUM ou ABOVE_PROVIDER_MAXIMUM.Forma de pagamento:
pix (Copia e Cola e QR Code), card (cartão de crédito à vista, a partir de R 2,00, válido por 10 minutos). Forma indisponível no momento: 422 METHOD_UNAVAILABLE.Só com
method: "crypto": ltc (padrão), btc, eth, sol, trx, doge, ada ou matic. Fora da lista: INVALID_CRYPTO_CURRENCY; enviada em outra forma: VALIDATION.Até 140 caracteres. Vai para o extrato e para o webhook; no cartão, aparece também na página de pagamento.
Só no Pix: validade do QR Code, de 5 a 43200 (30 dias). Sem o campo, a validade padrão da conta.
sacc_... ou externalId de uma subconta: quando paga, a venda é creditada a ela (menos a tarifa e a sua comissão). Desativada: 422 SUBACCOUNT_INACTIVE; se ela for desativada depois, a venda fica com você.Divide a venda entre até 10 subcontas, no lugar de
subaccountId (os dois juntos: 422 INVALID_SPLIT). Cada item é { "subaccountId": "sacc_... ou externalId", "amount": centavos }; a soma pode ser menor que o valor (o resto fica com você), nunca maior. A mesma subconta duas vezes, parte sem valor ou mais de 10: 422 INVALID_SPLIT. Quando paga, cada subconta recebe a parte dela menos a sua comissão e a tarifa da WyzeCash na proporção da parte. Estorno e MED tiram de cada uma na mesma proporção.Rastreio para os plugins de marketing ligados no painel. Campos opcionais, textos de até 500 caracteres:
utm_source, utm_medium, utm_campaign, utm_content, utm_term, src, sck, fbc, fbp, gaClientId, gaSessionId, ip, userAgent, pageUrl. Nada disso vai para quem paga.Resposta
Texto em português: Entrada pendente, paga (Pix recebido, Cartão aprovado ou Cripto recebida), Entrada expirada, Estornada.
Pix: o código Copia e Cola (BR Code). Gere o QR Code a partir dele.
null no cartão e na cripto.Cartão: o link da página segura de pagamento, para mandar ao cliente ou abrir num botão.
null nas outras formas.Cartão aprovado:
brand (bandeira) e last4 (final). null antes do pagamento e nas outras formas.Cartão: quando o valor sai da retenção e entra no saldo disponível (15 dias depois da aprovação, D+15).