SX Digital Pay
  1. PaymentLinks
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. PaymentLinks

Get link details

GET
/payment-links/{id}
Returns a single-use payment link, its payments, and an aggregated paymentStatus field that tells whether the link has any completed payment.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Path Params

Responses

🟢200
application/json
Link found.
Body

🟠401Unauthorized
🟠403Forbidden
🟠404NotFound
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sxdigitalpay.com/api/external/payment-links/' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - default
{
    "success": true,
    "paymentLink": {
        "id": "pl_123",
        "externalReference": "annual-plan-2025",
        "title": "Premium subscription",
        "description": "Annual plan invoice",
        "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"
        },
        "webhookUrl": "https://merchant.com/webhooks/sxpay",
        "paymentStatus": "PENDING",
        "paymentsSummary": {
            "total": 2,
            "byStatus": {
                "PENDING": 1,
                "COMPLETED": 1
            }
        },
        "payments": [
            {
                "id": "pay_001",
                "status": "PENDING",
                "createdAt": "2024-12-05T18:25:00.000Z",
                "completedAt": null,
                "availableAt": null,
                "customer": {
                    "name": "Jane Doe",
                    "email": "jane@example.com"
                },
                "quote": {
                    "amount": 129.9,
                    "currency": "USD",
                    "paymentMethod": "CREDIT_CARD",
                    "installments": 1,
                    "totalBRL": 658.35
                }
            },
            {
                "id": "pay_000",
                "status": "COMPLETED",
                "createdAt": "2024-12-05T18:15:00.000Z",
                "completedAt": "2024-12-05T18:18:00.000Z",
                "availableAt": "2024-12-07T12:00:00.000Z",
                "customer": null,
                "quote": {
                    "amount": 129.9,
                    "currency": "USD",
                    "paymentMethod": "PIX",
                    "installments": 1,
                    "totalBRL": 658.35
                }
            }
        ],
        "createdAt": "2024-12-05T18:20:00.000Z"
    }
}
Modified at 2025-12-06 23:42:40
Previous
List single-use payment links
Next
Link created
Built with