/hyax-api/v1/crypto-paymentsList crypto payments
Your USDC orders with their on-chain details, for keeping your own payment ledger. Each row is the `order.created` body plus `paymentStatus`, `paymentDate`, `createdAt` and `updatedAt`, so one handler can process a pulled payment and a delivered one, and an order whose webhook failed can be recovered from here. Results run oldest change first: pass `pagination.nextCursor` back as `cursor` until `hasMore` is false, and store the last `updatedAt` to resume from with `updatedSince`. Dedupe on `data.id` for orders and `crypto.txHash` for transactions. `FAILED` rows are attempts that paid nothing, and one can share its hash with the `PAID` order that followed it, so count `PAID` rows only.
Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.
Query parameters
| Name | Required | Description |
|---|---|---|
limit | No | Default 50, max 100 |
cursor | No | `pagination.nextCursor` from the previous page |
updatedSince | No | ISO 8601. Only orders changed at or after this time. |
isTest | No | `true` | `false`. Filter by live or test orders. Omit to return all. |
Request
curl -X GET 'https://platform.hyax.com/hyax-api/v1/crypto-payments?limit=10' \
-H 'Authorization: Bearer YOUR_API_KEY'Response
{
"success": true,
"data": [
{
"id": "clx…",
"orderNumber": "ORD-abc12345",
"amount": 50,
"currency": "USD",
"peopleId": "clx…",
"email": "[email protected]",
"name": null,
"paymentPlatform": "USDC_BASE",
"isTest": false,
"unitsGranted": 5000,
"items": [
{ "productId": "clx…", "skuId": "clx…", "name": "5k", "quantity": 1, "price": 50, "units": 5000 }
],
"externalUserId": "user_123",
"checkoutSessionId": "clx…",
"metadata": null,
"crypto": {
"txHash": "0xabc…",
"txHashes": ["0xabc…"],
"chainId": 8453,
"network": "Base",
"tokenAddress": "0x8335…",
"fromWallets": ["0x1234…"],
"toWallet": "0x5678…",
"depositAddress": "0x5678…",
"receivedBaseUnits": "50000000",
"failureReason": null,
"sentOnNetwork": null
},
"paymentStatus": "PAID",
"paymentDate": "2025-01-15T12:00:00.000Z",
"createdAt": "2025-01-15T12:00:00.000Z",
"updatedAt": "2025-01-15T12:00:00.000Z"
}
],
"pagination": { "limit": 50, "hasMore": false, "nextCursor": "MjAyNS0wMS0xNVQxMjowMDowMC4wMDBafGNseOKApg" }
}