SettleFlow API
API ReferencePayment links

List payment links

GET
/payment-links

Returns a paginated list of your payment links.

X-Api-Key<token>

Merchant API key for authentication

In: header

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 300
Default20
sortBy?string
order?string
Default"desc"

Value in

  • "asc"
  • "desc"
status?string

Filter by link status.

Value in

  • "active"
  • "disabled"
  • "expired"
  • "completed"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payment-links"
{  "data": [    {      "id": "string",      "url": "string",      "amount": 0,      "currency": "str",      "description": "string",      "reference": "string",      "customer": {        "first_name": "string",        "last_name": "string",        "email": "string",        "country": "string"      },      "capture_mode": "automatic",      "reusable": true,      "status": "active",      "expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}