Skip to main content

​
List payments

Returns a paginated list of payments for the merchant tied to your secret key. You can filter by type (payment or deposit), status, free-text search, and control sort order. 
  curl -X GET \
  "https://api.spacepay.co.uk/v1/external/secretkey-auth/payments?type=payment&status=completed&limit=50&offset=0"
  \ -H "X-SpacePay-Secret-Key: sk_test_your_secret_key"

{
  "data": [
    {
      "id": "4291f98b-d68c-4eb0-883e-6bc790a41c96",
      "merchantId": "4e29f55d-d6a8-42d7-8230-cb8efeded39e",
      "merchantShortName": "Copycat Creations",
      "type": "payment",
      "amountInCents": 250,
      "currency": "USD",
      "status": "completed",
      "depositAddress": {
        "id": "6c1c95e1-04f1-4881-b7cc-c2a529fbde76",
        "paymentId": "4291f98b-d68c-4eb0-883e-6bc790a41c96",
        "type": "EVM",
        "address": "0xa35e74109b7040d0ee74cb7cb71bae35a2981254",
        "createdAt": "2025-10-10T21:44:06.749Z"
      },
      "quotes": [
        {
          "id": "eb0e59b9-14d5-4324-a056-e87b74aa954f",
          "paymentId": "4291f98b-d68c-4eb0-883e-6bc790a41c96",
          "token": {
            "id": "f9d14525-367d-4e16-b247-8d4ed23f1413",
            "symbol": "ETH",
            "decimals": 18,
            "contractAddress": "0x0000000000000000000000000000000000000000",
            "type": "volatile",
            "assetType": "native",
            "status": "active"
          },
          "chainId": 84532,
          "expectedAmountAsset": "668082370801162",
          "rateUsdAsset": "3742.05353900",
          "expiresAt": "2025-10-10T21:54:06.796Z",
          "status": "active",
          "createdAt": "2025-10-10T21:44:06.794Z"
        }
      ],
      "receipt": {
        "transactionHash": "0x1234567890abcdef1234567890abcdef12345678",
        "blockNumber": 18500000,
        "confirmations": 12,
        "requiredConfirmations": 12,
        "completedAt": "2025-10-10T21:45:00.000Z"
      },
      "orderId": "order_123",
      "redirectUrl": "https://merchant.example.com/checkout/success",
      "createdAt": "2025-10-10T21:44:06.733Z"
    }
  ],
  "pagination": {
    "total": 84,
    "limit": 50,
    "offset": 0,
    "hasMore": true,
    "totalPages": 2,
    "currentPage": 1
  }
}

​
Query Parameters

​
type
string
Filter by payment type. Possible values: payment, deposit.
​
status
string
Filter by payment status. Possible values: pending, processing, completed, failed, expired, cancelled.
​
search
string
Free-text search across payment ID, deposit wallet address, merchant short name, receipt transaction hash, and receipt sender address.
​
sortBy
string
default:"createdAt"
Field to sort results by. Possible values: createdAt, amountInCents.
​
sortOrder
string
default:"DESC"
Sort direction. Possible values: ASC, DESC.
​
limit
number
default:"100"
Number of payments to return. Minimum: 1, maximum: 1000.
​
offset
number
default:"0"
Number of payments to skip for pagination.

​
Response Fields

​
data
array
required
Array of payment objects.
​
pagination
object
required
Pagination metadata.

​
Error Responses

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid or missing X-SpacePay-Secret-Key header",
    "code": "invalid_api_key"
  }
}