SX Digital Pay
    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

    PaymentLinkWithPayments

    {
        "id": "string",
        "externalReference": "string",
        "title": "string",
        "description": "string",
        "amount": 0,
        "currency": "string",
        "status": "ACTIVE",
        "isMultiUse": true,
        "isActive": true,
        "isExpired": true,
        "expiresAt": "2019-08-24T14:15:22Z",
        "url": "http://example.com",
        "shortUrl": "http://example.com",
        "metadata": {},
        "createdAt": "2019-08-24T14:15:22Z",
        "webhookUrl": "http://example.com",
        "paymentStatus": "NOT_STARTED",
        "paymentsSummary": {
            "total": 0,
            "byStatus": {
                "property1": 0,
                "property2": 0
            }
        },
        "payments": [
            {
                "id": "string",
                "status": "PENDING",
                "createdAt": "2019-08-24T14:15:22Z",
                "completedAt": "2019-08-24T14:15:22Z",
                "availableAt": "2019-08-24T14:15:22Z",
                "customer": {
                    "name": "string",
                    "email": "user@example.com"
                },
                "quote": {
                    "amount": 0,
                    "currency": "string",
                    "paymentMethod": "PIX",
                    "installments": 0,
                    "totalBRL": 0
                }
            }
        ]
    }
    Built with