🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!
List payment links across your merchants (cursor pagination)
Sandbox
Sandbox
POST
/v1/payment-links/list
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/payment-links/list' \
--header 'api_key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"reseller_id": 0,
"cursor": "string",
"limit": 25,
"status": "active",
"merchant_id": 0,
"from_date": "2019-08-24T14:15:22.123Z",
"to_date": "2019-08-24T14:15:22.123Z",
"sale_type": "pay_by_link"
}'Response Response Example
200 - Example 1
{
"data": {
"items": [
{
"id": 0,
"order_ref": "string",
"short_code": "string",
"short_url": "string",
"amount": 0,
"currency_code": "string",
"description": "string",
"customer_email": "string",
"customer_name": "string",
"phone_number": "string",
"sale_type": "pay_by_link",
"status": "active",
"effective_status": "string",
"expires_at": "string",
"created_by_email": "string",
"deactivated_at": "string",
"created_at": "string",
"merchant_id": 0
}
],
"meta": {
"has_more": true,
"next_cursor": "string"
}
}
}