How much this taxpayer can pay right now
lunium_check_payer_limitRequires an API key. Returns how much a specific Brazilian taxpayer (CPF for a person, CNPJ for a company) can move through a PIX charge right now, in cents. Read-only — no charge is created.
Call it before lunium_create_pix_charge whenever the payer is new or the amount is not trivial. Limits are an anti-fraud ladder per taxpayer: a first-time payer starts small and grows with settled history, so a value that passed for someone else can be refused for this one. Checking first turns a rejected charge into a conversation about the right amount.
Send digits only — no dots, slashes or dashes. Do not use it as a document-validity check, and do not read a high limit as approval: a charge can still be refused for other reasons.
Errors: acao=corrigir → the document is malformed, fix the digits. acao=esperar → quota, retry later with the same input. acao=repetir → transient, retry once. If the returned maximum is below what the user wants, offer that value or a different payer — do not attempt the charge anyway.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payer_tax_number | Yes | Payer's CPF (11 digits) or CNPJ (14 digits), digits only. |