Payment links

List payment links

Lists the tenant's payment links, newest first by creation time. Links created in one call share that time, so their order relative to each other here is not significant — the create answers in the order given. Cursor-paginated: pass limit (1–100) and send pagination.next_cursor back as cursor until has_more is false. To learn HOW MANY rows match without walking every page, pass include_total=true once and read pagination.total_count. The url field is the live hosted checkout page.

Available to admin and readonly API keys (no side effects).

get/v1/payment-links

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/payment-links
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1–100. Default 25.

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor.

order'asc' | 'desc'

Sort direction. Ordering is ALWAYS by when the record was CREATED in Finero, never by when it changed — updated_since narrows the set but does not reorder it, so the most recently updated row is not necessarily first. Creation time is immutable, which is what lets the cursor stay stable: ordering by a value that changes would move a row mid-walk and make a page skip or repeat it. Default desc (newest first by creation time).

include_totalboolean

Return pagination.total_count — the number of rows matching the filters, ignoring paging. It is the SAME number on every page, including alongside a cursor. Off by default: an exact count scans the whole filtered set, so asking on each page pays repeatedly for an answer that does not change — ask on the first request and keep it.

status'active' | 'processing' | 'paid' | 'inactive' | 'needs_replacement' | 'action_required'

Filter by lifecycle status.

invoice_idstring uuid

Filter by invoice.

installment_idstring uuid

Filter by installment.

customer_idstring uuid

Only links on invoices belonging to this customer (customer.id). Resolved through the invoice — a link carries no customer of its own — so 'every link this customer has' is one call, not one per invoice.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.