Conta

Withdraw BRL balance as crypto to a self-custodial wallet

Changed on

Converte saldo BRL disponível em cripto. Escolha uma rota entregavel=true de GET /cashin/catalog e informe carteira/memo por saque; carteira fixa não é necessária. Liquid/DePix não são suportados. Debita amount_cents mais a taxa da casa antes da entrega; conversão e custos da rota afetam a quantidade final. Acompanha pelo cashin_id em GET /cashin/{cashin_id}/status. Compartilha o espaço de external_id com cobranças. Não há endpoint público de prévia de saque.

post/saldo/sacar-cripto

Request

  • Base URL: https://api.luniumpay.com
  • URL: https://api.luniumpay.com/saldo/sacar-cripto
  • Auth: API key in header X-API-Key

Request body

amount_centsinteger required

Valor BRL em centavos inteiros. Mínimo efetivo depende da chave, taxas e rota. Consulte GET /keys/me e min_brl_cents/limits retornados; não fixe o mínimo do exemplo.

chainstring

Network (aliases accepted: sol, trc20, erc20, bep20, arbitrum, base…).

assetstring

Asset code in lowercase (usdt, usdc, btc, eth, sol…), as listed by GET /cashin/catalog.

payout_addressstring required

Destination wallet, validated for the network.

tax_numberstring required

CPF (11 digits) or CNPJ (14) of the customer who owns the balance.

customer_refstring

Sub-account to debit. Omit for the key's main balance.

external_idstring

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.

payout_tagstring

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.

max_debited_centsinteger

Limite opcional do débito BRL (valor + taxa da casa). Excesso retorna 409 taxa_alterada. Não trava câmbio nem quantidade de tokens.

sandbox_scenario'success' | 'delayed' | 'held' | 'expired' | 'refunded' | 'failed' | 'payer_mismatch' | 'settlement_failed' | 'settlement_uncertain' | 'route_unavailable' | 'provider_unavailable'

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

Response

Debited and queued for delivery. Same view as POST /cashin/charge (cashin_id, status = paid — the balance is the payment —, chain, asset, payout_address, amount_cents, settlement_status, settlement_tx_hash) plus fee_cents (house fee debited), debited_cents (amount + fee), fonte: "saldo", destino: "cripto", customer_ref. Follow settlement_status on GET /cashin/{cashin_id}/status until sent.

cashin_idstring

Identificador da cobrança (ci_…).

status'pending' | 'delayed' | 'under_review' | 'paid' | 'expired' | 'refunded' | 'failed'

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

amount_centsinteger

Valor do PIX em centavos.

destino'cripto' | 'saldo'

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

fonte'saldo'

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

customer_refstring nullable

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

payout_addressstring nullable

Carteira que recebe a cripto (destino=cripto).

payout_tagstring nullable

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

chainstring

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

assetstring

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

lunium_fee_bpsinteger

Taxa percentual congelada na cobrança, em bps.

lunium_fee_fixed_centsinteger

Parcela fixa congelada na cobrança, em centavos.

partner_fee_bpsinteger

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.

qr_copypastestring nullable

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

qr_image_urlstring nullable

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

external_idstring nullable

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.

created_atstring date-time nullable
expires_atstring date-time nullable

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

delay_untilstring date-time nullable

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

liberar_emstring date-time nullable

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

hold_hoursinteger

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

held_hoursinteger

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

heldboolean

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

sandboxboolean

True for fictitious sandbox operations.

simulationobject
timelineobject[]
delivery_mode'full' | 'split'

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

net_centsinteger

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.

fee_total_centsinteger

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

lunium_fee_centsinteger

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

partner_fee_centsinteger

Sub fee do parceiro debitada do saldo por cima da taxa da Lunium (24/09/2026).

settlement_status'pending' | 'sending' | 'entregando' | 'sent' | 'incerto' | 'failed' | 'null' nullable

Estado do crédito/entrega: sent concluiu; incerto exige conciliação. PIX pago e entrega são estados distintos.

settlement_tx_hashstring nullable

Hash on-chain da entrega (ou id interno quando a entrega é pela corretora).

fee_centsinteger

Taxa da Lunium debitada do saldo.

debited_centsinteger

amount_cents + fee_cents + partner_fee_cents.

Changes

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status