API Reference
Start typing to search…

Create Installment link

post
https://backend.sa.amwal.tech/payment_links//create
Path Params
string
required

Your store ID from the Merchant Portal

Body Params
double
required
≥ 0.01

Payment amount in your store's currency. Must be greater than 0. Will be rounded to 5 decimal places.

string
length ≤ 200

Payment link title that customers will see. For in-store: keep it short for terminal displays. For online: make it descriptive and professional.

string
length ≤ 500

Detailed description of what the payment is for. This helps customers understand the charge. For in-store: include item details or receipt reference.

string
length ≤ 50

External identifier like the e-commerce order ID.

boolean
Defaults to true

If true, the payment link can only be used once. If false, multiple payments can be made until manually disabled or expired. Recommended: true for invoices and in-store transactions, false for donation links.

date-time

Expiry date for the payment link in ISO 8601 format. For in-store: typically short duration (15-30 minutes). For online: longer periods (days/weeks). Leave empty for no expiration.

string

Customer's phone number in international format (E.164). Used for SMS notifications and customer identification. For in-store: can be collected at terminal.

string

Customer's email address. For in-store: optional for digital receipts.

string
length ≤ 50

Customer's first name. Personalizes the payment experience and appears on receipts.

string
length ≤ 50

Customer's last name. Used together with first name for complete customer identification.

boolean
Defaults to false

Set to true if you need the customer to provide their address during payment. For in-store: rarely needed unless for delivery orders.

string
length ≤ 100

Customer's primary street address. Only used if you want to pre-fill address information.

string
length ≤ 100

Secondary address line (apartment, suite, etc.). Optional address information.

string

Customer's country code in ISO 3166-1 alpha-2 format (2 letters). Examples: SA, AE, EG, US, GB

string
length ≤ 50

Customer's city name. Used for billing and shipping address if required.

string
length ≤ 50

Customer's state or province. Required for some countries like US, Canada.

string
length ≤ 20

Customer's postal or ZIP code. Format varies by country.

string
enum
Defaults to ar

Language for the payment page and communications. 'en' for English, 'ar' for Arabic.

Allowed:
boolean
Defaults to true

Whether to send SMS notifications to the customer. For in-store: can notify customer of successful payment. Requires valid phone number.

string
enum
Defaults to ar

Language for SMS notifications. Independent of payment page language.

Allowed:
boolean
Defaults to false

Send digital receipt via SMS after successful payment. Particularly useful for in-store transactions.

boolean
Defaults to false

If true, only bank installment payment options will be shown to customers. Useful for high-value purchases.

boolean
Defaults to false

If true, only full payment options will be shown (no installments). Cannot be true if only_show_bank_installments is true.

boolean
Defaults to false

Enable passkey authentication for enhanced security. Customers can use biometric authentication or security keys.

uri

Your webhook URL that will receive payment status updates. Must be HTTPS. Essential for automated payment processing and real-time POS integration.

metadata
object

Custom data that you want to associate with this payment link. Will be returned in webhooks and API responses. For in-store: include terminal info, cashier details, transaction context.

string
length ≤ 50

Branch identifier if your business has multiple locations. Essential for in-store transactions to track location-based sales.

Responses

Updated about 2 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago