docs

Create a payment link

Creates a new payment link — a shareable URL you can send to customers. Features: - Supports multiple line items with adjustable quantities - Custom fields for collecting additional customer information - After-completion settings (redirect or hosted confirmation) - Automatic amount calculation from line items - Validates currency consistency across line items

POST
/payment-links

Creates a new payment link — a shareable URL you can send to customers.

Features:

  • Supports multiple line items with adjustable quantities
  • Custom fields for collecting additional customer information
  • After-completion settings (redirect or hosted confirmation)
  • Automatic amount calculation from line items
  • Validates currency consistency across line items

Authorization

api-key
AuthorizationBearer <token>

API key for merchant integrations. Send as Authorization: Bearer <your key>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payment-links" \  -H "Content-Type: application/json" \  -d '{    "lineItems": [      {        "priceId": "string",        "quantity": 0      }    ],    "afterCompletion": {      "type": "redirect",      "redirect": {        "url": "https://example.com/success"      }    }  }'
{  "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"}

List payment links GET

Lists payment links with filtering, pagination, and search. Features: - Filter by active status - Search by product name, description, or unit label - Filter by amount (equal, between, greater, less) - Filter by date (last period, equal, between, after, before) - Pagination support

Get a payment link by ID GET

Retrieves a payment link with all related data including: - Line items with prices and products - Custom fields with dropdown options - After-completion settings