Link paymentStatus changed

Webhook

POST

payment_link.payment_status_changed

Sent when the aggregated paymentStatus of a link changes: NOT_STARTED → PENDING (first payment created) or PENDING → COMPLETED (first payment completed).

Payload includes:

paymentStatus and previousPaymentStatus

summary with totalPayments and completedPayments

paymentLink payload (id, URLs, metadata, paymentStatus)

latestPayment when a payment triggered the change (id, status, timestamps, quote)

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": "1f2e3d4c-5b6a-7d8c-9e0f-1a2b3c4d5e6f",
    "type": "payment_link.payment_status_changed",
    "createdAt": "2024-12-05T18:35:00.000Z",
    "data": {
        "previousPaymentStatus": "PENDING",
        "paymentStatus": "COMPLETED",
        "summary": {
            "totalPayments": 2,
            "completedPayments": 1
        },
        "paymentLink": {
            "id": "pl_123",
            "title": "Premium subscription",
            "status": "INACTIVE",
            "paymentStatus": "COMPLETED",
            "url": "https://app.sxdigitalpay.com/quote/[merchantShortName]/[paymentLinkId]",
            "shortUrl": "https://sxpay.me/[paymentLinkShortId]"
        },
        "latestPayment": {
            "id": "pay_123",
            "status": "COMPLETED",
            "createdAt": "2024-12-05T18:20:00.000Z",
            "completedAt": "2024-12-05T18:35:00.000Z",
            "availableAt": "2024-12-07T12:00:00.000Z",
            "paymentLinkId": "pl_123",
            "paymentLinkExternalReference": "annual-plan-2025",
            "quote": {
                "amount": 129.9,
                "currency": "USD",
                "paymentMethod": "CREDIT_CARD",
                "installments": 1,
                "totalBRL": 658.35
            }
        }
    }
}'

Response Example

{}

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

Link status changed

PaymentLinkStatus