Skip to navigation
API ReferenceProviders and paymentsPayments

List payments

Provider-neutral records of the top-ups and invoice payments taken at your payment providers, each with the provider’s own reference. Provider chargebacks show here, separate from outcome disputes.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

customer_idstringOptional
Only objects belonging to this customer.
payment_providerstringOptional
Only payments taken at this provider.
kindenumOptional
Only payments of this kind.
Allowed values:
statusenumOptional
Only payments with this status.
Allowed values:
disputedbooleanOptional
Only payments that have, or have not, been disputed at the provider.
created_afterdatetimeOptional
Only objects created at or after this time.
created_beforedatetimeOptional
Only objects created before this time.
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

Response

A page of payments.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error