Skip to main content
POST
List received payments

Headers

X-Api-Key
string
required

Your API Key (UUID format). Required to identify and authorize each request

X-Api-Secret
string
required

Secret associated with your API Key. Used for authenticating requests. Keep this secure.

Body

application/json
rows_per_page
enum<integer>
required

Number of records to return per page. Accepted values are 10, 20, 50, or 100.

Available options:
10,
20,
50,
100
Example:

50

page_no
integer
required

Page number to retrieve, starting from 1. For example, page_no=1 returns the first page of results.

Required range: x >= 1
Example:

1

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

status_code
integer | null
default:200

HTTP status code representing the result of the request.

message
string | null
default:Success

Short, human-readable message describing the outcome of the request.

records
UserApiPaymentRead · object[] | null

List of result items returned for the current page.

totalRecords
integer | null
default:0

Total number of matching records in the database, useful for paginating the full dataset.

queryGeneratedTime
integer | null
default:1778161546

Unix timestamp (in seconds) indicating when this response was generated.