SX Digital Pay
  1. Webhooks
SX Digital Pay
  • Getting started
  • Authentication/Webhook Validation
  • PaymentLinks
    • Create single-use payment link
      POST
    • List single-use payment links
      GET
    • Get link details
      GET
  • Webhooks
    • Link created
    • Link status changed
    • Link paymentStatus changed
  • Schemas
    • PaymentLinkStatus
    • PaymentLinkPaymentStatus
    • PaymentStatus
    • PaymentMethod
    • PaymentLinkBase
    • PaymentLinkSummary
    • PaymentLinkWithWebhook
    • PaymentLinkWithPayments
    • PaymentLinkCreated
    • PaymentsSummary
    • CreatePaymentLinkRequest
    • PaymentCustomer
    • PaymentQuote
    • Payment
    • Pagination
    • Error
    • WebhookLinkPayload
    • WebhookPaymentPayload
    • WebhookLinkEventData
    • WebhookLinkPaymentStatusEventData
    • WebhookEvent
  1. Webhooks

Link created

Webhook
POST
payment_link.created
Sent when an external link is created and webhookUrl is set.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Body

Request 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": "5e3d2c6a-1d40-4a54-9e1c-1a2b3c4d5e6f",
    "type": "payment_link.created",
    "createdAt": "2024-12-05T18:31:00.000Z",
    "data": {
        "id": "pl_123",
        "title": "Premium subscription",
        "description": "Annual plan invoice",
        "externalReference": "annual-plan-2025",
        "status": "ACTIVE",
        "previousStatus": null,
        "isMultiUse": false,
        "amount": 129.9,
        "currency": "USD",
        "url": "https://app.sxdigitalpay.com/quote/[merchantShortName]/[paymentLinkId]",
        "shortUrl": "https://sxpay.me/[paymentLinkShortId]",
        "metadata": {
            "plan": "premium"
        }
    }
}'
Response Response Example
{}
Modified at 2025-12-06 23:52:35
Previous
Get link details
Next
Link status changed
Built with