Skip to main content
GET
cURL
Read top-up and contract-funding payment attempts, including pending, failed, settled, returned and refunded states. Pending or failed payments are not spendable credits. All IDs and cursors must belong to the authorized workspace and environment. Required scope: billing:read. Owner authority is required. Related reads can pin snapshot_id from billing summary to reconcile the same as-of state; expired snapshots return 410, never a silent refresh. Examples use synthetic IDs. Replace them with values returned by your environment.

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Query Parameters

cursor
string

cursor

Minimum string length: 1
limit
integer
default:25

limit

Required range: 1 <= x <= 100
status
enum<string>

status

Available options:
pending,
processing,
succeeded,
failed,
cancelled,
partially_refunded,
refunded,
returned
purpose
enum<string>

purpose

Available options:
initial_funding,
renewal,
automatic_top_up,
manual_top_up
created_from
string<date-time>

created from. UTC ranges are inclusive from and exclusive to; reject to <= from.

created_to
string<date-time>

created to. UTC ranges are inclusive from and exclusive to; reject to <= from.

snapshot_id
string

snapshot id

Minimum string length: 1

Response

Successful response.

data
object[]
required
meta
object
required
page
object
required

Opaque cursor binds filters, authorization and a stable snapshot. Expired cursors return 410; never silently restart.