List Payments
GET
/v0/payments
Retrieves a list of payments. Results can be filtered by status, date range, and other parameters.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| status optional | string | Filter by payment status. Options: pending, confirming, completed, expired, failed. |
| blockchain optional | string | Filter by blockchain. Options: ETH, BSC, BTC, TRX. |
| custom_id optional | string | Filter by custom ID. |
| created_from optional | string | Filter by creation date (from). ISO 8601 format. |
| created_to optional | string | Filter by creation date (to). ISO 8601 format. |
| page optional | integer | Page number for pagination. Default: 1. |
| per_page optional | integer | Number of results per page. Default: 10. Maximum: 50. |
Example Request
GET /v0/payments?status=completed&blockchain=ETH&page=1&per_page=10
X-API-Key: your_api_key_here
Response Parameters
Root
| Parameter | Type | Description |
|---|---|---|
| data | array | Array of payment objects. |
| meta | object | Pagination metadata. |
Payment Object
| Parameter | Type | Description |
|---|---|---|
| payment_id | string | Unique identifier for the payment. |
| status | string | Current status of the payment. |
| crypto_amount | number | The amount of cryptocurrency to be paid. |
| address | string | The cryptocurrency address for the payment. |
| token | string | The cryptocurrency token (USDT for ETH/BSC/TRX, BTC for Bitcoin). |
| blockchain | string | The blockchain network used. |
| custom_id | string | Your custom identifier for the payment, if provided. |
| created_at | string | ISO 8601 timestamp indicating when the payment was created. |
| updated_at | string | ISO 8601 timestamp indicating when the payment was last updated. |
Meta Object
| Parameter | Type | Description |
|---|---|---|
| current_page | integer | Current page number. |
| total_pages | integer | Total number of pages. |
| total_count | integer | Total number of payments matching the filter criteria. |
| per_page | integer | Number of results per page. |
Example Response
{
"error": "deprecated_endpoint",
"message": "This API endpoint is deprecated in v0.9 and no longer functional. Please use the v1.0 API endpoints instead.",
"request_id": "req_v09_list_deprecated"
}
Error Codes
| Status Code | Error Code | Description |
|---|---|---|
| 400 | invalid_parameters | One or more of the provided parameters are invalid. |
| 401 | authentication_failed | Authentication failed. Check your API key. |
| 410 | deprecated_endpoint | This endpoint is deprecated in v0.9 and no longer functional. Please use the v1.0 API. |
| 429 | rate_limit_exceeded | You have exceeded the rate limit. |
| 500 | internal_error | An internal server error occurred. Contact support if this persists. |
Notes
Important: This API endpoint is deprecated in v0.9 and will always return an error response. Please upgrade to the v1.0 API for current functionality.
- This endpoint is no longer functional in v0.9 as the API has been deprecated.
- All requests to this endpoint will receive the error response shown above.
- To continue using the Cryptofuse API, please upgrade to the v1.0 API endpoints.