Skip to main content

Create Deposit Order (Saudi Arabia)

API for creating Saudi Riyal (SAR) deposit orders.

Request Information​

  • Request URL: /gateway/api/v2/payments
  • Method: POST
  • Content-Type: application/json;charset=utf-8

Request Parameters​

ParameterRequiredTypeDescription
platform_idYesString(6)Merchant ID
service_idYesString(7)Service ID
payment_cl_idYesString(64)Merchant Order ID
amountYesInteger(10)Amount (in halalas)
notify_urlYesString(256)Callback URL for transaction results
user_idNoString(32)Merchant-side user identifier, used for channel risk control and limits; falls back to the merchant order ID when omitted
request_timeYesInteger(10)Request time (seconds)
sign_typeNoString(16)Signature type, fixed value HMAC-SHA256
signYesString(32|64)Order Signature

Service ID​

  • SVC0099 Bank Card Payment
  • SVC0100 MADA Payment
  • SVC0101 Apple Pay

Response Example​

Successful Response​

{
"error_code": "0000",
"data": {
"link": "https://pay.example.com/cashier/DEMOPM0123456",
"payment_id": "DEMOPM0123456",
"payment_cl_id": "order_20260112001",
"amount": 50000
}
}

Remarks​

  • Transaction amount is in Saudi Riyal (halalas), please multiply by 100 before sending
  • Redirect the payer to the link returned to complete the payment
  • No bank code is required for this channel; the payment method is determined by service_id
  • Request time uses Unix timestamp in seconds
  • Transaction results will be sent to notify_url, see Deposit Notification for parameter details
  • The final order status must be taken from Query Deposit Order or the transaction notification