Jump to Content

Authorization

This document provides technical specifications for Authorization workflow APIs: /authorize, /authorize/{order_id}/capture (for capture), and /authorize/{order_id}/void. These APIs support a two-step payment process, allowing merchants to reserve funds first (Authorization) and then confirm the final amount (Capture) or release the reserved funds (Void).

Shared Request Data Models

The following objects are used across one or more API requests.

Product Model

Input Parameter	Type	Max Length	Description
name	String	100	Name of the product or service.
description	String	255	Detailed description of the product/item.
price	Decimal	-	Unit price of the product.
quantity	Integer	-	Number of units purchased.

Order Model

Input Parameter	Type	Max Length	Description
id	String	50	Merchant's unique ID for the order (used to track the overall payment lifecycle).
reference	String	50	Secondary internal reference number for the order.
description	String	255	A brief description of the transaction's purpose.
currency	String	3	The 3-letter currency code (e.g., "KWD").
amount	Decimal	-	The total amount for the current transaction (authorization amount, capture amount, or void amount).

Payment Gateway Model

Input Parameter	Type	Max Length	Description
src	String	10	Specifies the payment source (Note: currently accepting only "cc" for credit card).

Customer Model

Input Parameter	Type	Max Length	Description
uniqueId	String	100	Unique identifier for the customer.
name	String	100	Customer's full name.
email	String	100	Customer's email address.
mobile	String	20	Customer's mobile number, including the country code.