Conta

BRL balance (custody) — available, on hold, next releases

Changed on

Saldo BRL da casa ou da subconta customer_ref. Retorna disponível, bloqueado, próximas liberações e condições efetivas de custódia. Taxas e carência dependem da chave. Retenção local da cobrança, retenção do provedor e carência do saldo são regras distintas. Somente disponivel_cents financia saques; GET /saldo/consolidado soma casa e clientes. Sandbox retorna saldo ficticio persistente; aceita depositos simulados, saques e transferencias.

get/saldo

Request

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

Query parameters

customer_refstring

Sub-account (your end customer id). Omit for the key's main balance.

Response

OK

customer_refstring nullable
disponivel_centsinteger required
bloqueado_centsinteger required
total_centsinteger required
movimentosinteger
custodia_ativaboolean

false = this key cannot hold BRL (destino "saldo" is refused).

carencia_horasinteger

Carência configurada para esta chave; zero quando o crédito entra no saldo sem carência. Retenções da cobrança e créditos bloqueados continuam independentes.

deposito_fee_bpsinteger

Sempre 0 para novos depósitos em saldo.

saque_taxa_estimada_centsinteger

Tarifa fixa ou piso estimado do provedor. Para percentual, aplique saque_taxa_provedor_formula; não é preço total de todo saque.

saque_fee_bpsinteger

Taxa Lunium do saque Pix do saldo; padrão 150 bps, mais comissão do parceiro. Processamento informado separadamente.

saque_cripto_fee_bpsinteger

Sobretaxa no débito de cripto: 0. A taxa Lunium é aplicada uma única vez na conversão.

primeiro_deposito_emstring date-time nullable

When the first deposit of this sub-account was credited (null = never deposited).

carencia_atestring date-time nullable

Fim da carência do primeiro depósito, quando em curso; null caso contrário. Leia também bloqueado_cents e proximas_liberacoes.

retencao_acima_centsinteger

Limiar de política para primeiro pagamento elegível em custódia. Não significa retenção de todo depósito acima deste valor; a régua e a chave também decidem.

deposito_fee_fixed_centsinteger

Sempre 100 centavos por novo depósito em saldo.

saque_taxa_provedor_formulastring nullable

Fórmula vigente: fixa (piso_cents) ou percentual com piso. Não fixe um provedor como sempre ativo.

saque_taxa_provedor_tipo'fixo' | 'percentual'

Tipo vigente de tarifa do provedor de payout.

saque_taxa_provedor_piso_centsinteger

Tarifa fixa ou piso da tarifa percentual, em centavos.

sandboxboolean

true na resposta reduzida de teste.

saque_partner_fee_bpsinteger

Sub fee do parceiro na saida (PIX e cripto), por cima da taxa da Lunium.

saque_fee_total_bpsinteger

Single service rate for customer display: house fee plus partner markup, in bps (250 = 2.5%). Display with the fixed tariff, without a separate partner commission. Use actual quoted/stored monetary fee amounts; internal components round to cents independently. Production and sandbox.

saque_cripto_conversao_fee_bpsinteger

Percentual Lunium na conversão do saldo em cripto, sobre a cotação Binance sem ágio; padrão 330 bps.

saque_cripto_conversao_fee_fixed_centsinteger

Zero: o custo de entrada já foi cobrado no depósito.

deposito_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).

partner_deposito_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).

Changes

    • info

      added the optional property to the response with the status

    • info

      the response's property default value 0 was added for the status