Create Installment Link

Create Installment links for online transactions including e-commerce orders, invoices, and remote payments. Ideal for businesses collecting payments via email, SMS, or web sharing.

Online Flow

Generate Installment link via API or merchant portal
Share link with customer (email/SMS/messaging)
Customer completes payment online
Payment processes with confirmations sent
Digital receipt delivered automatically
Webhook notification sent to your system

📘
API Reference
For complete request/response schemas and interactive testing Create Installment Link.

🔗 Endpoint

POST /payment_links/{store_id}/create

Path Parameters

Parameter	Type	Required	Description
`store_id`	string	✅	Your unique store identifier from the Merchant Portal

Request Parameters

Parameter	Type	Required	Default	Description
`amount`	number	✅	-	Payment amount in your store's currency
`title`	string	❌	-	Payment link title customers will see
`description`	string	❌	-	Detailed description of the payment
`singleUse`	boolean	❌	`true`	If true, link can only be used once
`selectedDate`	string	❌	-	Expiry date in ISO 8601 format
`client_phone_number`	string	❌	-	Customer phone in international format
`client_email`	string	❌	-	Customer email address
`client_first_name`	string	❌	-	Customer first name
`client_last_name`	string	❌	-	Customer last name
`address_required`	boolean	❌	`false`	Require customer address
`language`	string	❌	`"ar"`	Payment page language: "en" or "ar"
`send_sms`	boolean	❌	`true`	Send SMS notifications
`callback_url`	string	❌	-	Webhook URL for payment updates
`metadata`	object	❌	-	Custom data for tracking

Request Example

{
  "amount": 299.99,
  "title": "Order #12345 - Premium Headphones",
  "description": "Wireless Noise-Cancelling Headphones - Black",
  "singleUse": true,
  "selectedDate": "2024-12-31T23:59:59Z",
  "client_phone_number": "+966501234567",
  "client_email": "[email protected]",
  "client_first_name": "Ahmed",
  "language": "en",
  "send_sms": true,
  "callback_url": "https://mystore.com/webhook/payment-complete"
}

Response Example

{
  "payment_link_id": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://pay.sa.amwal.tech/payment-link/550e8400-e29b-41d4-a716-446655440000"
}

{
  "error": "Validation Error",
  "error_code": "INVALID_AMOUNT",
  "message": "Amount must be greater than zero",
  "details": {
    "amount": ["This field must be a positive number"]
  }
}

Best Practices

Use longer expiry times for customer convenience
Include detailed descriptions and customer information
Enable email/SMS notifications
Use single-use links for invoices and orders
Collect customer address for shipping when needed