SOsolana
Payments

List payment requests

Changed on

Lists the caller's project's payment requests, newest first. Requires payment_requests.read. An open request past its expiresAt reads as expired. Records never carry publicToken.

get/v1/payments/requests

Request

  • Base URL
    http://localhost:8787
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, starting at 1.

Example:1
pageSizeinteger

Results per page, 1 to 100.

Example:20
status'awaiting_payment' | 'paid' | 'canceled' | 'expired'

Payment request status. awaiting_payment is open; paid was settled by an on-chain payment; canceled and expired closed without one.

Example:canceled

Headers

x-project-idstring

Required for dashboard sessions. API keys use their assigned project.

Example:prj_example

Response

Payment request list

Example response

{
  "data": {
    "paymentRequests": [
      {
        "id": "preq_example",
        "destinationAddress": "So11111111111111111111111111111111111111112",
        "amount": "100.00",
        "reference": "So11111111111111111111111111111111111111112",
        "status": "canceled",
        "expiresAt": "2025-01-01T00:00:00.000Z",
        "lastCheckedAt": "2025-01-01T00:00:00.000Z",
        "canceledAt": "2025-01-01T00:00:00.000Z",
        "lifecycle": [
          {
            "status": "canceled",
            "at": "2025-01-01T00:00:00.000Z"
          }
        ],
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ]
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes