Bill payments
Only registered if BILL_PAYMENTS_ENABLED is set server-side (on by default). See Bill payments for the underlying flow.
search_bill_companies
Section titled “search_bill_companies”| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Search term (name or code). Omit to list all. |
{ "companies": [{ "code": "EDENOR", "name": "EDENOR", "supportedMethods": [{ "id": "...", "type": "...", "description": "...", "helpText": "..." }] }], "count": 1 }get_bill
Section titled “get_bill”| Parameter | Type | Required | Description |
|---|---|---|---|
company_code | string | ✓ | e.g. EDENOR |
ref_id | string | ✓ | Reference/client number from the invoice |
method_id | string | Lookup method; auto-detected if omitted |
{ "bills": [{ "companyName": "EDENOR", "referenceId": "...", "type": "FIXED", "amount": "18500.00", "minAmount": "", "maxAmount": "", "allowedAmounts": [], "expireAt": "2026-08-01T00:00:00Z", "description": "..." }], "count": 1, "method_id": "..." }pay_bill
Section titled “pay_bill”| Parameter | Type | Required | Description |
|---|---|---|---|
company_code | string | ✓ | Company code |
ref_id | string | ✓ | Bill reference ID |
method_id | string | Optional | |
amount_ars | number | Required for OPEN/variable-amount bills |
If the bill requires an amount you didn’t provide, returns a confirmation payload instead of paying:
{ "requires_amount": true, "message": "This bill requires an amount. Retry with amount_ars set.", "bill": { "bills": [{ "type": "OPEN", "minAmount": "1000", "maxAmount": "50000", "allowedAmounts": [] }], "count": 1, "method_id": "..." }}Otherwise:
{ "id": "c2f0...", "company_code": "EDENOR", "company_name": "EDENOR", "ref_id": "...", "bill_type": "FIXED", "amount_ars": 18500, "status": "pending", "created_at": "..." }list_bill_payments
Section titled “list_bill_payments”| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | Default 20 |
{ "payments": [{ "id": "...", "company_code": "EDENOR", "company_name": "EDENOR", "ref_id": "...", "bill_type": "FIXED", "amount_ars": 18500, "status": "completed", "confirmation_code": "...", "created_at": "..." }] }add_bill_to_whitelist
Section titled “add_bill_to_whitelist”| Parameter | Type | Required | Description |
|---|---|---|---|
company_code | string | ✓ | Company code |
per_payment_limit_ars | number | Cap per auto-approved payment. Omit for no limit. |
{ "added": { "id": "...", "company_code": "EDENOR", "company_name": "EDENOR", "per_payment_limit_ars": null, "created_at": "..." } }remove_bill_from_whitelist
Section titled “remove_bill_from_whitelist”| Parameter | Type | Required | Description |
|---|---|---|---|
company_code | string | ✓ | Company code to remove |
Returns plain text confirmation, not JSON.
list_bill_whitelist
Section titled “list_bill_whitelist”Parameters: none.
{ "whitelist": [{ "id": "...", "company_code": "EDENOR", "company_name": "EDENOR", "per_payment_limit_ars": 20000, "created_at": "..." }] }