The
/payment/ endpoint retrieves a list of payments with filtering and pagination options.
Method:GET
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
| q (Optional) | string | Search query to filter payments |
| page (Optional) | integer | Page number for pagination. Default: 1 |
| size (Optional) | integer | Number of payments per page. Default: 10 |
| sort (Optional) | string | Field to sort by. Default: ‘updatedAt’ |
| order (Optional) | string | Sort order (‘asc’ or ‘desc’). Default: ‘desc’ |
| user (Optional) | string | Filter by user ID |
| currency (Optional) | string | Filter by currency |
| dateFrom (Optional) | string | Filter payments from this date |
| dateTo (Optional) | string | Filter payments to this date |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Query Parameters
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
q | string | query | ❌ | Search query to filter payments |
page | integer | query | ❌ | Page number for pagination |
size | integer | query | ❌ | Number of payments per page |
sort | string | query | ❌ | Field to sort by |
order | string | query | ❌ | Sort order (‘asc’ or ‘desc’) |
user | string | query | ❌ | Filter by user ID |
currency | string | query | ❌ | Filter by currency |
dateFrom | string | query | ❌ | Filter payments from this date |
dateTo | string | query | ❌ | Filter payments to this date |
Responses
✅ 200 - Success
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
PaymentAuthorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Search query to filter payments
Page number for pagination
Number of payments per page
Field to sort by
Sort order ('asc' or 'desc')
Available options:
asc, desc Filter by user ID
Filter by currency
Filter payments from this date
Filter payments to this date