List single-use payment links

GET

/payment-links

Returns the authenticated merchant's non-reusable payment links, ordered by creation (newest first).

Supported filters:

status: ACTIVE, INACTIVE, or EXPIRED (invalid values are ignored).

externalReference: exact match on the merchant's external id.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

List returned successfully.

Body

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sxdigitalpay.com/api/external/payment-links?page&pageSize&status&externalReference' \
--header 'x-api-key: <api-key>'

Response Example

200 - default

{
    "success": true,
    "paymentLinks": [
        {
            "id": "pl_123",
            "externalReference": "invoice-784",
            "title": "December invoice",
            "description": "Annual subscription",
            "amount": 129.9,
            "currency": "USD",
            "status": "ACTIVE",
            "isMultiUse": false,
            "isActive": true,
            "isExpired": false,
            "expiresAt": "2025-01-31T23:59:59.000Z",
            "url": "https://app.sxdigitalpay.com/quote/[merchantShortName]/[paymentLinkId]",
            "shortUrl": "https://sxpay.me/[paymentLinkShortId]",
            "metadata": {
                "plan": "premium"
            },
            "createdAt": "2024-12-05T18:20:00.000Z"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 20,
        "total": 1,
        "totalPages": 1
    }
}

Modified at 2025-12-06 23:42:40

Create single-use payment link

Get link details