List Payments

List payments based on the provided filters

GET /statements/payments

Try it

List Payments

cURL

curl --request GET \
  --url https://api.paxos.com/v2/statements/payments \
  --header 'Authorization: Bearer <token>'

200

{
  "payments": [
    {
      "id": "08ae7260-0967-44e4-b2e3-e9c837a3de69",
      "customer_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a",
      "profile_id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "ref_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a-USDG_REWARDS-cdcbff8e-cf51-4536-ba6f-92ef6846e48a-2025-02-USDG-100.5-seq#1",
      "product": "USDG_REWARDS",
      "payment_type": "PAYMENT_TYPE_CRYPTO_WITHDRAWAL",
      "payment_destination": "f45b7f18-a10d-4e19-bea2-9aa91cab6b69",
      "payment_asset": "USDG",
      "payment_amount": "100.5",
      "payment_status": "PAYMENT_STATUS_COMPLETED",
      "created_at": "2025-03-19T14:00:45.589886Z",
      "processed_at": "2025-03-19T19:21:57.172302Z"
    },
    {
      "id": "b05683f7-28ac-43fa-8ed8-b332cf28051e",
      "customer_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a",
      "profile_id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "ref_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a-USDG_REWARDS-cdcbff8e-cf51-4536-ba6f-92ef6846e48a-2025-03-USDG-100.5-seq#1",
      "product": "USDG_REWARDS",
      "payment_type": "PAYMENT_TYPE_CRYPTO_WITHDRAWAL",
      "payment_destination": "f45b7f18-a10d-4e19-bea2-9aa91cab6b69",
      "payment_asset": "USDG",
      "payment_amount": "100.5",
      "payment_status": "PAYMENT_STATUS_COMPLETED",
      "created_at": "2025-03-18T19:26:54.298637Z",
      "processed_at": "2025-03-20T14:26:06.649645Z"
    }
  ],
  "next_page_cursor": "CgwI-Pr1vgYQyLLpswESJDM2NGU2MTgyLTRhZjctNDg4NC1iY2MxLTM0MThmNTA0MWYzYg"
}

OAuth Scope

statements:read_payment

Authorizations

Authorization · string · header · required

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

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

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[]

Show child attributes

payments. id · string

Unique identifier for the payment.

payments. customer_id · string

UUID of the customer.

payments. profile_id · string

payments. account_id · string

payments. ref_id · string

Statement reference string this payment resolves.

payments. product · enum<string>

Available options: USDG_REWARDS

payments. payment_type · enum<string>

Available options: PAYMENT_TYPE_CRYPTO_WITHDRAWAL

payments. payment_source · string

payments. payment_destination · string

UUID of the payout address used.

payments. payment_asset · string

Should be USDG.

payments. payment_amount · string

Total amount paid.

payments. payment_status · enum<string>

Available options: PAYMENT_STATUS_PENDING, PAYMENT_STATUS_COMPLETED, PAYMENT_STATUS_FAILED

payments. payment_tx_id · string

The transaction id returned by the internal service which processes the payment requested.

payments. description · string

payments. metadata · string

Metadata associated with the payment, for client usage or future expansion.

payments. created_at · string<date-time>

Lifecycle field for tracking transfer status.

payments. processed_at · string<date-time>

Lifecycle field for tracking transfer status.

next_page_cursor · string