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*"payment_link"

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

Value in

"payment_link"

merchantId*string

Merchant ID

active*boolean

Whether the payment link is active

expiresAt?string

Expiration timestamp (ISO 8601)

currency*string

Currency

Value in

"EGP"
"USD"
"EUR"
"GBP"
"SAR"
"AED"
"QAR"
"KWD"
"JOD"
"OMR"
"BHD"
"LYD"
"AUD"
"CAD"
"CNY"

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

Value in

"PAY"
"SUBSCRIBE"
"BOOK"
"DONATE"

customerCreation?string

When to create customer

Value in

"always"
"if_required"

afterCompletion?

After completion settings

lineItems*array<>

Line items

customFields?array<>|

Custom fields

feeConfig?|

Fee configuration

metadata?

Custom metadata

brandingSettings?|

Branding settings

paymentMethodConfigurationId?|

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": "string",      "quantity": 0,      "price": {},      "adjustableQuantity": {},      "amountSubtotal": 0,      "amountTotal": 0,      "amountDiscount": 0,      "amountTax": 0,      "currency": "EGP",      "description": "string",      "presentmentDetails": {}    }  ],  "customFields": [    {      "key": "string",      "label": "string",      "type": "TEXT",      "isOptional": true,      "hasLimits": true,      "limitType": "AT_MOST",      "minCharacters": 0,      "maxCharacters": 0,      "dropdownOptions": [        null      ],      "text": {},      "numeric": {},      "dropdown": {}    }  ],  "feeConfig": {    "feesPassThrough": true,    "vatCollectionEnabled": true,    "vatCollectionRate": 0  },  "metadata": {    "property1": null,    "property2": null  },  "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"}