API Reference

List Payment Requests

get
https://api.clik2pay.com/open/v1/payment-requests

Fetch a list of Payment Requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
≥ 0
Defaults to 0

For pagination, this is the 0-based index at which to start displaying results.

integer
≥ 1
Defaults to 10

For pagination, this is the number of results to display per page.

uuid

The unique identifier of the merchant for the payment requests. If not provided, all merchants the user has permission to access will be listed.

string

Filter results by short code.

string

Filter results by the user that created the payment request.

string
enum

Filter results by status.

string
enum

Filter results by payment type.

Allowed:
string
enum

Column to sort the results by.

Allowed:
string
enum

Order to sort results by

Allowed:
string
length ≤ 64

Filters payment requests to those with the provided terms in the shortCode, email, mobileNumber or merchantAccountId properties.

boolean
Defaults to false

Include payment requests that have been refunded along with provided status values.

date

Limit results to have a created date after or on this date.

date

Limit results to have a created date before or on this date.

Responses

401

Unauthorized

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago