Skip to main content

List Mercury Payment Requests

GET 
/api/mercury/payment-requests

Lists payment requests sent to Mercury for this instance, newest first, paginated.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Each request groups one supplier's payables. status is Mercury's approval state (pendingApproval, approved, rejected, cancelled); status_label / status_color are display-ready and read Paid once the money moved and payments were recorded against every allocation.

dashboard_link opens the request in Mercury. Mercury has no API to withdraw a request — a pending request is approved or declined in Mercury, and the status is picked up automatically.

Filters: each column below can be filtered with filter[{column}.{operator}]=value, or combined into an AND/OR tree passed as base64-encoded JSON in filter_groups. Text operators: is, is_not, contains, does_not_contain, starts_with, ends_with, is_one_of, is_empty, is_not_empty. Numeric: is, greater_than, less_than, between. Date-time: before, after, between, today.

Filterable columns: id, amount, supplier_id (numeric); status, method, mercury_request_id, supplier_name (text); created_at, updated_at (date-time).

Authentication: Requires Bearer token.

Use filter[in_progress_for]=bill:{id} to find a payment still in progress for a document before paying it again; a second payment for a document with one in progress is rejected.

Payments awaiting approval in SKU.io also carry approvers: the users who can approve that payment (everyone with the Approve Mercury payments permission, plus admins, minus the person who sent it).

Request​

Responses​

OK

Response Headers
    Content-Type