Skip to main content
GET
List Payments
The Rewards Engine API replaces this endpoint.New customers should use List Payout Groups instead.
OAuth Scope

Authorizations

Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

ref_ids
string[]

No other parameters are allowed if ref_ids are provided

payment_ids
string[]

No other parameters are allowed if payment_ids are provided

customer_id
string

Use together with product to list for a specific customer and product

product
enum<string>

Use together with product to list for a specific customer and product

Available options:
USDG_REWARDS
payment_status
enum<string>

Optional, filter by payment status

Available options:
PAYMENT_STATUS_PENDING,
PAYMENT_STATUS_COMPLETED,
PAYMENT_STATUS_FAILED
limit
integer<int32>

Number of results to return. Defaults to 100 if no limit is provided.

order
enum<string>

Sort order for the results by created at, defaults to DESC if not provided.

Available options:
DESC,
ASC
page_cursor
string

Cursor for getting the next page of results.

Response

200 - application/json

Successfully retrieve payments

payments
object[]
next_page_cursor
string