Skip to main content
GET
Get Payments
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get Payments Description: The /payment/ endpoint retrieves a list of payments with filtering and pagination options. Method: GET Authorization:
  • Required role: user or higher
Query Parameters:

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

q
string

Search query to filter payments

page
integer
default:1

Page number for pagination

size
integer
default:10

Number of payments per page

sort
string
default:updatedAt

Field to sort by

order
enum<string>
default:desc

Sort order ('asc' or 'desc')

Available options:
asc,
desc
user
string

Filter by user ID

startDate
string<date>

Filter payments from this date

endDate
string<date>

Filter payments to this date

include
string

Specify 'count' to include the total count of items

status
enum<string>

Filter payments by status

Available options:
completed,
processing,
failed
currency
string

Filter payments by currency code (e.g., USD, EUR, GBP)

Response

Success

message
string
payments
object[]
total
integer
page
integer
size
integer