Link status changed

Webhook

POST

payment_link.status_changed

Sent when a link status changes (e.g., ACTIVE -> INACTIVE or EXPIRED).

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://your-api-server.com' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "7b1e3e7f-1a23-4c55-8ef1-b12cd3fae7c1",
    "type": "payment_link.status_changed",
    "createdAt": "2024-12-05T18:32:12.000Z",
    "data": {
        "id": "pl_123",
        "externalReference": "annual-plan-2025",
        "status": "INACTIVE",
        "previousStatus": "ACTIVE",
        "isMultiUse": false,
        "amount": 129.9,
        "currency": "USD",
        "url": "https://app.sxdigitalpay.com/quote/[merchantShortName]/[paymentLinkId]",
        "shortUrl": "https://sxpay.me/[paymentLinkShortId]"
    }
}'

Response Example

{}

Modified at 2025-12-06 23:52:32

Link created

Link paymentStatus changed