GET Installment Details

After creating a payment link, ensure you securely store the payment_link_id. This ID is essential for retrieving the payment status.

To access detailed information about a specific installment payment link, including customer details, order data, payment history, and transaction insights, use the following endpoint. It offers comprehensive transaction reporting for both online and in-store installment payments.

📘
API Reference
For full request/response schemas and interactive testing, visit Get Installment details.

🔗 Endpoint

POST /payment_links/{payment_link_id}/details

Retrieve complete information about a payment link, including all related transactions, customer data, payment status, and transaction history, with pagination support.

Request Parameters

Parameter	Type	Required	Description
`payment_link_id`	string (UUID)	✅	The ID of the payment link to retrieve details for
`page`	integer	No	Page number for transaction pagination (default: 1)
`page_size`	integer	No	Number of transactions per page (1-100, default: 10)

curl -X POST "https://backend.sa.amwal.tech/payment_links/{payment_link_id}/details" \
  -H "Authorization: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Response Example

{
  "payment_link": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "amount": "299.99000",
    "title": "In-Store Purchase",
    "description": "Electronics - Premium Headphones",
    "single_use": true,
    "enabled": true,
    "expiry_date": "2024-12-31T23:59:59Z",
    "created_at": "2025-01-28T12:40:29.030109+03:00",
    "status": "Paid",
    "is_expired": false,
    "merchant_business_name": "Premium Electronics Store",
    "merchant_english_business_name": "string",
    "merchant_country_code": "SA",
    "merchant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_by_username": "cashier01",
    "created_by_email": "[email protected]",
    "branch": "RIYADH-001",
    "branch_name": "Riyadh Main Branch",
    "terminal_id": "POS-001",
    "cashier_id": "CASH-123",
    "pos_session_id": "SESSION-20240123-001",
    "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"
  },
  "transactions": [
    {
      "id": "c037cf31-0402-4706-a3be-973f8bc2e64c",
      "amount": "299.99000",
      "total_amount": "299.99",
      "payment_amount": "299.99",
      "refunded_amount": "0.00",
      "fees": "8.99",
      "convenience_fee": "2.99",
      "status": "pending",
      "transaction_status": "string",
      "failure_reason": "string",
      "payment_method": "CREDIT_CARD",
      "payment_submethod": "TAP_TO_PAY",
      "card_last_4_digits": "1234",
      "card_holder": "AHMED AL-RASHID",
      "card_payment_brand": "VISA",
      "card_type": "CREDIT",
      "card_bank_issuer": "Al Rajhi Bank",
      "client_email": "[email protected]",
      "client_first_name": "Ahmed",
      "client_last_name": "Al-Rashid",
      "client_phone_number": "+966501234567",
      "client_registered": false,
      "address_details": "string",
      "created_at": "2025-01-28T12:42:43.538320+03:00",
      "completed_at": "2025-01-28T12:43:15.721000+03:00",
      "merchant_business_name": "Premium Electronics Store",
      "merchant_country_code": "SA",
      "is_refundable": true,
      "installment_fee": "15.00",
      "installment_duration": "6",
      "gateway": 1,
      "gateway_type": 1,
      "payment_session_id": "274045cd-3604-4fcf-88b7-a22793c87506",
      "receipt_number": "RCP-001234",
      "transaction_duration_seconds": 32
    }
  ],
  "pagination": {
    "count": 1,
    "next": false,
    "previous": false,
    "page": 1,
    "page_size": 10,
    "total_pages": 1
  }
}