Gerar cobrança PIX para custódia BRL ou entrega de cripto

Valor da cobrança em CENTAVOS de real, inteiro (ex.: 15000 = R$ 150,00). Consulte GET /cashin/limits antes de criar; ele publica as faixas sem retenção e com retenção vigentes para o pagador.

Rede da rota de entrega. Use o network do catálogo neste campo chain.

Ativo da rota entregável em GET /cashin/catalog; não limitado a stablecoins.

Carteira por cobrança para destino=cripto; se omitida, pode usar settlement_address da chave. Omitir para destino=saldo. Endereço deve corresponder à rede escolhida.

CPF (11 dígitos) ou CNPJ (14 dígitos) do pagador, somente números. Identifica o pagador e alimenta os limites e retenções anti-fraude publicados por GET /cashin/limits.

Identificador idempotente de até 64 caracteres. Mantenha o mesmo identificador e todos os parâmetros nos retries. A comparação de divergência varia por rota; não use o replay para alterar uma operação. 409 external_id_divergente sinaliza conflito detectado.

saldo credita custódia BRL líquida das taxas, sem carteira. cripto (padrão) entrega na carteira informada ou configurada. Consulte taxas/carência em GET /saldo e retenção na cobrança/status.

Optional sub-account of the balance (your end customer id). With destino: "saldo", the credit lands on this sub-account; GET /saldo?customer_ref= reads it and POST /payouts with the same customer_ref spends it. Omit to use the key's main balance.

Legado: campo ignorado. A retenção exigida pela faixa do pagador é automática, inclusive com false. Não bloqueie a criação pelo limite sem retenção; consulte max_amount_cents/held_qr e mostre held_hours e hold_hours/liberar_em antes do pagamento.

Memo/tag do destino. OBRIGATORIO nas redes coletivas — XRP, XLM, TON, ATOM, HBAR, ALGO, EOS, KAVA, LUNA — onde a carteira de destino e compartilhada e o memo e quem identifica o dono. Sem ele a API responde 400 memo_obrigatorio antes de criar qualquer cobranca. Em XRP e a destination tag: inteiro de 0 a 4294967295. Aliases aceitos: memo, tag, destination_tag. O catalogo marca essas rotas com memoRequired: true. Aliases aceitos: memo, tag, destination_tag.

Nome do pagador, quando informado.

Only for a sandbox key. GET /sandbox provides the scenario matrix by flow. Omit in production. All prices, payments and withdrawals remain fictitious.

Somente para chain="liquid" (DePix). "full" (padrão) entrega o DePix direto na carteira informada, com o valor cheio — a taxa da chave não é descontada. "split" faz o caminho receber-e-repassar: a Lunium recebe o DePix, desconta a taxa da chave (fixa + percentual) e envia o líquido para payout_address; net_cents na resposta é exatamente o que o destinatário recebe. Em split, payout_address é obrigatório. Sem o campo, vale o padrão da sua chave.

Identificador da cobrança (ci_…).

Estado do PIX. paid não comprova sozinho crédito/entrega; leia settlement_status.

Valor do PIX em centavos.

cripto (entrega on-chain) ou saldo (credita a custódia BRL da chave, usável em POST /payouts e POST /saldo/sacar-cripto).

Fonte do valor na criação: PIX ou saque do saldo.

Sua referência do cliente final (subconta no saldo).

Carteira que recebe a cripto (destino=cripto).

Memo/tag da carteira de destino em redes coletivas (destino=cripto).

Rede de entrega (id de GET /cashin/catalog).

Ativo entregue (usdt, usdc, btc, …).

Taxa percentual congelada na cobrança, em bps.

Parcela fixa congelada na cobrança, em centavos.

Subfee exclusiva do depósito Pix em saldo BRL, em basis points (100 = 1%). Padrão 0, máximo 1000. Aplicada ao valor recebido após a taxa fixa Lunium, descontada antes do crédito no saldo. Independente de compra, venda e saque. Congelada na criação; comissão creditada somente após liberação e crédito concluído (paid/sent). Para compra direta, este campo congela partner_fee_bps.

PIX copia e cola na criação; null no saque custodial.

Imagem do QR (PNG) — só na resposta da criação.

Identificador idempotente de até 64 caracteres. Mantenha o mesmo identificador e todos os parâmetros nos retries. A comparação de divergência varia por rota; não use o replay para alterar uma operação. 409 external_id_divergente sinaliza conflito detectado.

Validade da própria cobrança; leia este timestamp, inclusive para validade estendida pelo bot.

Instante de liberação informado para retenção do provedor, quando disponível.

Quando o crédito no saldo sai da carência. null quando já entra disponível (padrão desde 16/09/2026).

Retenção local da cobrança em horas. Não é alias de held_hours nem da carência geral do saldo.

Retenção solicitada ao provedor. Pode ser zero enquanto existe retenção local (hold_hours/liberar_em).

true quando held_hours > 0. Isoladamente não revela retenção local.

True for fictitious sandbox operations.

Só em chain="liquid": como o DePix foi entregue. Ausente nas outras redes.

Só em chain="liquid" com delivery_mode="split": quanto o destinatário recebe em DePix, já sem a taxa. É este valor que a Lunium envia on-chain.

Só em chain="liquid" com delivery_mode="split": tudo que saiu do bruto (taxa fixa + percentual). net_cents + fee_total_cents == amount_cents.

Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança.

Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança.