Installments

Split a purchase into a down payment and scheduled payments that SADAD Pay tracks for you.

With installments, a customer pays for a purchase in parts: an optional down payment, then a series of scheduled payments. SADAD Pay creates the schedule, sends the customer a link to their plan, and records each payment as it comes in.

📘

Who carries the risk

SADAD Pay schedules and collects the payments. It does not lend money or guarantee payment: any unpaid balance stays between you and your customer.

How it works

  1. You create an installment plan for a customer: the total, the down payment, how many payments, and how often.
  2. SADAD Pay sends the customer a link to their plan by SMS or email.
  3. On the plan page, the customer sees the Due Amount and the full schedule, and taps Pay Now to pay what is due.
  4. Each payment creates an invoice. The plan tracks what has been paid and what is left.
1568

The customer's installment plan page

https://sadadpay.net/installment/payment/{plan_key}

In Sandbox, the domain is sandbox.sadadpay.net.

Create a plan in the portal

Go to Installments → Add Installment and fill in:

FieldDescription
Customer Name, Mobile, EmailWho the plan is for
TypeWithout Product: you enter the total. With Product: you choose products from your catalogue and the total is calculated.
Is FlexibleAllow flexible payment amounts instead of strictly the scheduled ones
Send Installment OptionSend the plan link by SMS or Email
Payment MethodsThe methods the customer can use
TotalThe full amount to be paid
ScheduleThe down payment and each payment, with its amount and due date
FilesDocuments to attach, such as a contract
More OptionLate fees, grace period and notes

After you save, open the plan from Installments to share it again with Copy link, Email, Messenger, SMS or WhatsApp.

1254

Installments → Add Installment: customer details, plan type, Is Flexible, products, schedule and files

Plan statuses

The plan status shows its progress. For example:

StatusMeaning
NewCreated, no payments yet
PartiallyCompletedSome payments have been made

Create a plan with the API

POST /api/InstallmentPlan/insert

FieldTypeRequiredDescriptionExample
vendor_IdintegerYesYour SADAD Pay vendor ID10204
customer_NamestringYesThe customer's name"Ahmed Ali"
customer_Mobile / customer_EmailstringYes, for the send methodWhere to send the plan link"[email protected]"
sendTypestringYesSMS or Email"Email"
typestringYesWithoutProduct or WithProduct"WithoutProduct"
total_AmountnumberYesThe full amount300.000
down_AmountnumberNoThe down payment, due on startDate60.000
installment_CountintegerYesNumber of payments after the down payment4
installment_AmountnumberYesAmount of each payment60.000
pay_PerstringYesHow often: for example Monthly or Daily"Monthly"
startDatestringYesFirst due date (yyyy-MM-dd)"2026-11-16"
schedulesarrayYesEvery payment, including the down payment. See below.
currency_CodestringYesKWD"KWD"
isFlexiblebooleanNoAllow other payment amountsfalse
plan_DescriptionstringNoWhat the plan is for"Laptop, 4 monthly payments"
langstringNoen or ar"en"

Each item in schedules has:

FieldDescriptionExample
typeDown for the down payment, Schedule for each scheduled payment"Schedule"
amountThe amount of that payment60.000
dueDateWhen it is due (yyyy-MM-dd)"2026-12-16"
notesOptional note"Down Amount"

🚧

Send the full schedule

The API does not build the schedule for you. Send one Down item (if there is a down payment) plus exactly installment_Count Schedule items, otherwise you get InstallmentScheduleRequired or InvalidInstallmentScheduleNumber.

curl -X POST "https://apisandbox.sadadpay.net/api/InstallmentPlan/insert" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_Id": 10204,
    "customer_Name": "Ahmed Ali",
    "customer_Email": "[email protected]",
    "sendType": "Email",
    "lang": "en",
    "type": "WithoutProduct",
    "total_Amount": 300.000,
    "down_Amount": 60.000,
    "installment_Count": 4,
    "installment_Amount": 60.000,
    "pay_Per": "Monthly",
    "startDate": "2026-11-16",
    "isFlexible": false,
    "currency_Code": "KWD",
    "plan_Description": "Laptop, 4 monthly payments",
    "schedules": [
      { "type": "Down",     "amount": 60.000, "dueDate": "2026-11-16", "notes": "Down Amount" },
      { "type": "Schedule", "amount": 60.000, "dueDate": "2026-12-16" },
      { "type": "Schedule", "amount": 60.000, "dueDate": "2027-01-16" },
      { "type": "Schedule", "amount": 60.000, "dueDate": "2027-02-16" },
      { "type": "Schedule", "amount": 60.000, "dueDate": "2027-03-16" }
    ]
  }'
{
  "isValid": true,
  "errorKey": null,
  "response": {
    "id": "56273240118"
  }
}

The id in the response is the plan key. The customer's plan page is https://sandbox.sadadpay.net/installment/payment/56273240118.

Other plan endpoints

TaskEndpoint
List plans, with filters such as status, customerName and datesGET /api/InstallmentPlan/getall
Get one plan with its full scheduleGET /api/InstallmentPlan/getbyid?id={id}
Get a plan by its key, with the amount dueGET /api/InstallmentPlan/getforpayment?key={key}
Change a planPUT /api/InstallmentPlan/update
Delete a planDELETE /api/InstallmentPlan/delete?id={id}

In getbyid, each schedule item shows its status (Paid or Unpaid), dueDate, received_Amount and paymentDate. The plan shows paid_Amount and remaining_Amount.

Create a payment for a plan with the API

To let the customer pay from your own app, create the invoice for the amount they want to pay now.

POST /api/Invoice/createinstallmentplanlinkinvoice

FieldTypeRequiredDescriptionExample
installmentPlanLink_KeyintegerYesThe plan key56273240118
installmentPlan_TypestringYesThe plan type"WithoutProduct"
customer_NamestringYesThe customer's name"Ahmed Ali"
customer_MobilestringYesThe customer's mobile"99999999"
customer_EmailstringYesThe customer's email"[email protected]"
totalAmountnumberYesThe amount to pay now. No more than the amount due.60.000
currency_CodestringYesKWD"KWD"
langstringNoen or ar"en"
curl -X POST "https://apisandbox.sadadpay.net/api/Invoice/createinstallmentplanlinkinvoice" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "installmentPlanLink_Key": 56273240118,
    "installmentPlan_Type": "WithoutProduct",
    "customer_Name": "Ahmed Ali",
    "customer_Mobile": "99999999",
    "customer_Email": "[email protected]",
    "lang": "en",
    "totalAmount": 60.000,
    "currency_Code": "KWD"
  }'
{
  "isValid": true,
  "errorKey": null,
  "response": {
    "invoice_Key": 3891579192959
  }
}

Send the customer to https://sandbox.sadadpay.net/pay/{invoice_Key} (Live: https://sadadpay.net/pay/{invoice_Key}), then confirm the payment with Verify Payment Status.

Common errors

errorKeyEndpointCauseHow to fix
VendorIdRequiredInstallmentPlan/insertvendor_Id is missingSend your vendor ID. Ask [email protected] if you do not know it.
CustomerNameRequiredInstallmentPlan/insertcustomer_Name is missingSend the customer's name
TotalAmountRequiredInstallmentPlan/inserttotal_Amount is missing or 0Send the total
InstallmentScheduleRequiredInstallmentPlan/insertschedules is missingSend the full schedule
InvalidInstallmentScheduleNumberInstallmentPlan/insertThe number of Schedule items is not installment_CountSend one item per payment
CustomerEmailRequiredcreateinstallmentplanlinkinvoicecustomer_Email is missingSend the customer's email
AmountCannotBeGreaterThanDueAmountcreateinstallmentplanlinkinvoicetotalAmount is more than the amount duePay no more than the amount due
InvalidAccessToken (HTTP 401)AllThe Access Token is missing, wrong or expiredGenerate a new Access Token

Next steps