Payment Link — XPay docs

A Payment Link is a shareable URL you can send to a customer to collect a single payment or set up a subscription, without writing any checkout code. Open the URL in any browser and we render the hosted checkout, collect payment details, and process the payment. Use Payment Links for one-off invoices, social-media checkout, in-person QR codes, or anywhere you need a checkout page without integrating the SDK.

id*string

Unique identifier for this Payment Link. Always prefixed with plink_.

object*string

String identifying the object type. Always payment_link for this resource.

merchantId*string

Merchant ID

active*boolean

Whether the payment link is active

expiresAt?string

Expiration timestamp (ISO 8601)

currency*string

Currency

computedAmount*number

Computed total amount from line items

nameCollection*boolean

Whether to collect customer name

billingAddressCollection*boolean

Whether to collect billing address

shippingAddressCollection*boolean

Whether to collect shipping address

phoneNumberCollection*boolean

Whether to collect phone number

allowPromotionCodes*boolean

Whether to allow promotion codes

submitType*string

Submit type

customerCreation?string

When to create customer

afterCompletion?

After completion settings

lineItems*array<>

Line items

customFields?array<>

Custom fields

feeConfig?

Fee configuration

metadata?

Custom metadata

brandingSettings?

Branding settings

paymentMethodConfigurationId?string

Payment method configuration ID

createdAt*string

Creation timestamp (ISO 8601)

updatedAt*string

Last update timestamp (ISO 8601)

{
  "id": "plink_abc123",
  "object": "payment_link",
  "merchantId": "mer_xyz789",
  "active": true,
  "expiresAt": "string",
  "currency": "EGP",
  "computedAmount": 100000,
  "nameCollection": false,
  "billingAddressCollection": false,
  "shippingAddressCollection": false,
  "phoneNumberCollection": false,
  "allowPromotionCodes": false,
  "submitType": "PAY",
  "customerCreation": "always",
  "afterCompletion": {
    "type": "redirect",
    "redirect": {
      "url": "string"
    },
    "hostedConfirmation": {
      "customMessage": "string",
      "returnUrl": "string"
    }
  },
  "lineItems": [
    {
      "id": "li_abc123",
      "quantity": 1,
      "price": {},
      "adjustableQuantity": {},
      "amountSubtotal": 200000,
      "amountTotal": 200000,
      "amountDiscount": 0,
      "amountTax": 0,
      "currency": "EGP",
      "description": "Premium Plan - Monthly",
      "presentmentDetails": {}
    }
  ],
  "customFields": [
    {
      "label": "Company Name",
      "type": "TEXT",
      "isOptional": false,
      "hasLimits": false,
      "limitType": "BETWEEN",
      "minCharacters": 5,
      "maxCharacters": 100,
      "dropdownOptions": [
        {}
      ]
    }
  ],
  "feeConfig": {
    "feesPassThrough": false,
    "vatCollectionEnabled": false,
    "vatCollectionRate": 1400,
    "source": "merchant"
  },
  "metadata": {},
  "brandingSettings": {
    "colorMode": "light",
    "borderStyle": "rounded",
    "spacing": "condensed",
    "inputSize": "small",
    "inputStyle": "flat",
    "formLayout": "compact",
    "colors": {
      "primary": "string",
      "primaryForeground": "string",
      "background": "string",
      "foreground": "string",
      "border": "string",
      "input": "string",
      "ring": "string",
      "muted": "string",
      "mutedForeground": "string",
      "accent": "string",
      "accentForeground": "string",
      "destructive": "string"
    },
    "fontFamily": "string"
  },
  "paymentMethodConfigurationId": "string",
  "createdAt": "string",
  "updatedAt": "string"
}