How much this taxpayer can pay right now

Consulta orientativa de limites por CPF/CNPJ, uso e faixas sem retenção/retida. A criação revalida a operação e as condições da chave, inclusive custódia sem carência. max_amount_cents não substitui mínimos de taxa, rota/provedor ou gates contratuais. Retenção pode ocorrer no provedor ou localmente; confira held_hours, hold_hours e liberar_em na cobrança. Não fixe a régua no cliente.

get/cashin/limits

Request

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

Query parameters

payer_taxstring required

CPF (11 digits) or CNPJ (14 digits), digits only.

Response

Current ladder state

payer_taxstring

Masked back to you, never in full.

stage'first_transaction' | 'first_24h' | 'mature' | 'disabled' | 'desconhecido'
max_amount_centsinteger

Faixa máxima orientativa do documento, incluindo eventual retenção; criação revalida chave, mínimos e disponibilidade.

used_centsinteger
available_centsinteger nullable

What still clears without a hold at the current stage. Alias: instant_available_cents. Null quando a regra de limite estiver desativada (stage=disabled).

limit_centsinteger nullable

Null quando a regra de limite estiver desativada (stage=disabled).

next_stageobject nullable

When the ceiling rises and to what.

instant_available_centsinteger

Same as available_cents — what clears without a hold, spelled out.

Changes

No recorded changes to this operation across all 3 revisions of this API.