Resolve Installment Link

⚙️ Online Resolution Features

Web-optimized installment interface with mobile-responsive design
Email/SMS confirmation and digital receipt generation
Customer account creation and seamless redirect

📘
API Reference
For complete request/response schemas and interactive testing Resolve Installment link.

Request

POST /payment_links/{payment_link_id}/resolve

Parameters

Parameter	Type	Required	Description
`payment_link_id`	string (UUID)	✅	Online payment link ID to resolve

Request Body (Optional)

{
  "device_type": "desktop",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
  "referrer": "email_link",
  "customer_context": {
    "return_url": "https://mystore.com/order-complete",
    "language_preference": "en"
  }
}

Request Properties

Property	Type	Description
`device_type`	string	Device type accessing the payment link (`desktop`, `mobile`, `tablet`)
`user_agent`	string	Browser user agent for analytics
`referrer`	string	Source that referred the customer
`customer_context.return_url`	string	URL to redirect customer after payment
`customer_context.language_preference`	string	Customer's preferred language

Response

Success Response (200)

{
  "transaction": {
    "id": "c037cf31-0402-4706-a3be-973f8bc2e64c",
    "amount": "299.99000",
    "status": "pending",
    "payment_method": "CREDIT_CARD",
    "created_at": "2025-01-28T12:42:43.538320+03:00",
    "client_email": "[email protected]",
    "client_first_name": "Ahmed",
    "client_phone_number": "+966501234567"
  },
  "payment_interface": "web"
}

Error Response (400)

{
  "error": "Payment link expired",
  "error_code": "LINK_EXPIRED",
  "message": "This payment link has expired. Please contact the merchant to request a new payment link."
}

Response Properties

Property	Type	Description
`transaction`	object	Complete transaction details
`transaction.id`	string (UUID)	Unique transaction identifier
`transaction.amount`	string	Transaction amount with 5 decimal precision
`transaction.status`	string	Transaction status (`pending`, `completed`, `failed`)
`transaction.payment_method`	string	Payment method used by customer
`payment_interface`	string	Recommended interface (`web`, `qr_display`, `terminal_native`)