Payments

List confirmed payments

Lists confirmed payments, newest first by creation time. A payment appears here only after the payment provider verifies settlement; payments cannot be created through the API. Each payment also reports whether it has reached the ERP as a receipt (erp_push_status and the other erp_* fields), so money Finero holds but the ERP has not recorded is visible without a second call. There is no erp_push_status query filter — read the field on each returned payment. 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.

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

get/v1/payments

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/payments
  • 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.

invoice_idstring uuid

Filter by invoice.

customer_idstring uuid

Only payments on invoices belonging to this customer (customer.id). Resolved through the invoice — a payment carries no customer of its own — so 'everything this customer paid' is one call, not one per invoice.

payment_link_idstring uuid

Filter by payment link.

provider'stripe' | 'wix'

Filter by provider.

confirmed_sincestring date-time

Only payments confirmed at or after this ISO 8601 timestamp.

confirmed_beforestring date-time

Only payments confirmed at or before this ISO 8601 timestamp. With confirmed_since, one period is one bounded call — 'collected this month against last' is two calls, not a walk.

Response

Success

Changes

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