Installment Link Listings

📊 Transaction Overview

Access and review your online installment transactions, including e-commerce orders, invoices, and remote payments. This endpoint offers insights into payment activities, aiding in business reporting, customer management, and financial analysis.

📘
API Reference
For detailed request/response schemas and interactive testing, visit List Installment Links.

🔗 Endpoint

POST /payment_links/{store_id}/

Path Parameters

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

Request Body

{
  "page": 1,
  "page_size": 25,
  "search": "invoice",
  "payment_mode": "online",
  "branch": "RIYADH-001",
  "status": "Paid",
  "date_from": "2024-01-01",
  "date_to": "2024-01-31",
  "sort_by": "created_at",
  "sort_order": "desc"
}

Request Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination (starts at 1)
`page_size`	integer	No	Number of items per page (1-100, default: 10)
`search`	string	No	Search term to filter links (searches title, description, customer info)
`payment_mode`	string	No	Filter by mode: `online`, `in_store`, or `all` (default: `all`)
`branch`	string	No	Filter by specific branch identifier
`status`	string	No	Filter by status: `Unpaid`, `Paid`, `Expired`, or `all` (default: `all`)
`date_from`	string	No	Filter from date (YYYY-MM-DD format)
`date_to`	string	No	Filter to date (YYYY-MM-DD format)
`sort_by`	string	No	Sort by: `created_at`, `amount`, `title`, or `status`
`sort_order`	string	No	Sort direction: `asc` or `desc` (default: `desc`)

Response Example

{
  "count": 150,
  "next": "https://backend.sa.amwal.tech/payment_links/store_123/?page=2",
  "previous": null,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "amount": "299.99000",
      "title": "Invoice #INV-2024-001",
      "description": "Web Development Services - January 2024",
      "single_use": true,
      "enabled": true,
      "expiry_date": "2024-02-28T23:59:59Z",
      "created_at": "2025-01-28T12:40:29.030109+03:00",
      "status": "Paid",
      "is_expired": false,
      "merchant_business_name": "Premium Electronics Store",
      "merchant_country_code": "SA",
      "branch": "RIYADH-001",
      "branch_name": "Riyadh Main Branch",
      "client_email": "[email protected]",
      "client_phone_number": "+966501234567",
      "client_first_name": "Ahmed",
      "client_last_name": "Al-Rashid",
      "url": "https://pay.sa.amwal.tech/payment-link/550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "summary": {
    "total_amount": "15678.50",
    "paid_amount": "12456.75",
    "unpaid_amount": "3221.75",
    "online_count": 45,
    "in_store_count": 105
  }
}

Features

Track and fulfill e-commerce orders
Manage invoices with installment status
Access customer installment history and preferences
Gain insights into revenue and financial reporting

Common Use Cases

{
  "payment_mode": "online",
  "status": "Paid",
  "date_from": "2024-01-01",
  "date_to": "2024-01-31",
  "page_size": 100,
  "sort_by": "created_at",
  "sort_order": "desc"
}