Individual payments and payment reconciliation findings.
List payment reconciliation findings
What the daily payment reconciliation could not match between the provider's settlements and the local ledger — a provider charge with no local payment, a local success the provider never settled, an amount that disagrees, a refund or dispute the webhook rail lost — and what it repaired unattended (a lost success webhook, replayed). Most recently seen first. Filter with status=open for what still needs a person.
Required scope: payment.read (Read payments).
query Parameters
limitPage size (default 25, max 100)
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
statusKeep the findings in any of these statuses (ReconciliationFindingStatus: open, repaired, resolved). Repeatable or comma-separated; omit for all.
kindKeep the findings of any of these kinds (ReconciliationFindingKind: unknown_charge, unsettled_charge, amount_mismatch, unknown_refund, unknown_dispute, repaired_settlement, unapplied_payment). Repeatable or comma-separated; omit for all.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List payment reconciliation findings › Responses
OK
Resolve a payment reconciliation finding
Sets a finding's status to resolved: it is dealt with. The next reconciliation pass will not reopen it, even if the provider still shows the discrepancy. Returns the finding.
Required scope: payment.write (Manage payment methods).
path Parameters
idFinding UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Resolve a payment reconciliation finding › Request Body
statusresolved: the finding needs nothing more. The next reconciliation pass does not reopen it, even if the provider still shows the discrepancy.
noteWhy the finding needs nothing more — what was checked or put right. Recorded on the audit trail with the resolution.
Resolve a payment reconciliation finding › Responses
OK
Resolve a payment reconciliation finding
Deprecated: use PATCH /payments/reconciliation-findings/{id} instead. Removed on 2026-11-30.
Marks a finding as dealt with. The next reconciliation pass will not reopen it, even if the provider still shows the discrepancy.
Required scope: payment.write (Manage payment methods).
path Parameters
idFinding UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Resolve a payment reconciliation finding › Request Body
noteWhy the finding needs nothing more — what was checked or put right. Recorded on the audit trail with the resolution.
Resolve a payment reconciliation finding › Responses
OK
Get a payment
Returns one payment: what it pays for, its amount, where it stands at the provider and why it failed, if it did. 404 when the payment does not exist or is not in the caller's organization.
Required scope: payment.read (Read payments).
path Parameters
idPayment UUID
query Parameters
includeExtra data to add to the response: provenance. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400. provenance is sent without being asked until 2026-11-30; after that date it is sent only when named here.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get a payment › Responses
OK