Saudi Arabia Payment Integration

Before reading this API documentation, be sure to review API Description Guide

Transaction Limits

Transaction Type	Limit
Collection	SAR: 2-10000, USD: 0.5-2500

Amount Decimal Places: SAR — 2 decimal places | USD — 2 decimal places

Collection API

Collection Request

Brief Description:

Create a collection order

URL: Saudi Arabia: /sar/collect/apply
Note: appId needs to use SAR corresponding, user payment success will increase SAR balance USD: /usd/collect/apply Note: appId needs to use USD corresponding, user payment success will increase USD balance Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must pass the corresponding business ID based on the currency in the URL)
orderId	Yes	String	Merchant order number (must be unique, max length 48)
name	Yes	String	Recipient name, used for risk control
phone	Yes	String	Real mobile number (format reference: Phone Number Format)
email	Yes	String	Real email address
amount	Yes	String	Transaction amount (unit: local currency, accurate to two decimal places; punctuation marks such as ”,” are prohibited), test environment please use amount below 10SAR
currency	No	String	Currency (USD, local currency)
payType	Yes	String	Transaction type
inBankCode	Yes	String	Payment Method
callBackUrl	Yes	String	Redirect URL after successful payment
callBackFailUrl	Yes	String	Redirect URL after failed payment
cancelUrl	No	String	If provided, the payment page displays a Back button that redirects the user to this URL when clicked.
notifyUrl	No	String	Callback URL
goodsName	Yes	String	Product name
goodsQuantity	Yes	String	Product quantity
goodsPrice	Yes	String	Product price
goodsSku	Yes	String	Product unique identifier
goodsAvatar	Yes	String	Product image (https://)
platform	Yes	String	Platform name
subject	No	String	Payment note
body	No	String	Additional description
partnerUserId	Yes	String	Unique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, letters, or symbols -~!@#$%&*()_.
sign	Yes	String	Signature

request

{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "500.00",
  "phone": "0512345678",
  "email": "abdullah.qahtani@gmail.com",
  "name": "Abdullah Al-Qahtani",
  "inBankCode": "STCPay",
  "payType": "PAYMENT_GATEWAY",
  "partnerUserId": "149597870",
  "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M233323000059",
    "orderNo": "6023071013539074",
    "payUrl": "",
    "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
  }
}

Return Data Parameters Description

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
payUrl	String	Payment URL
sign	String	Signature

Collection Query

Brief Description:

Query collection order

URL: Saudi Arabia: /sar/collect/query USD: /usd/collect/query Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from backend, must match the currency in the URL)
orderId	Yes	String	Merchant Order Number
orderNo	No	String	Platform Order Number (faster response)
sign	Yes	String	Signature

request

{
  "appId": 1054,
  "orderId": "M22222000028",
  "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M22222000028",
    "orderNo": "6023042811314347",
    "amount": "500.00",
    "actualAmount": "0.00",
    "fee": "0.00",
    "status": 1,
    "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
  }
}

Return Data Parameters Description

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
amount	String	Transaction Amount
actualAmount	String	Received Amount
fee	String	Fee
status	Integer	Status (0 Not Started, 1 In Progress, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation)
payTime	String	Payment Success Time (available when status=2) (Saudi Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure Reason (available when status=3)
sign	String	Signature

Payment Methods

Saudi Arabia

Currency	Payment Type (payType)	Payment Code (inBankCode)	Limit	Status	Description
SAR	PAYMENT_GATEWAY	CARD	2-10000	Available	support VISA, MasterCard, Mada
SAR	PAYMENT_GATEWAY	STCPAY	2-10000	Available	STCPay Wallet
SAR	EWALLET	APPLE_PAY	2-10000	Available	Apple Pay
USD	PAYMENT_GATEWAY	SA_CARD_USD	0.5-2500	Available	support VISA, MasterCard, Mada
USD	PAYMENT_GATEWAY	SA_STCPAY_USD	0.5-2500	Available	STCPay Wallet
USD	EWALLET	SA_APPLEPAY_USD	0.5-2500	Available	Apple Pay

Cashier & Unified API

Cards & Components

Subscriptions

Local Payments

Saudi Arabia Payment Integration

Transaction Limits

Collection API

Collection Request

Collection Query

Payment Methods

Saudi Arabia

​Transaction Limits

​Collection API

​Collection Request

​Collection Query

​Payment Methods

​Saudi Arabia

​Related Topics

Transaction Limits

Collection API

Collection Request

Collection Query

Payment Methods

Saudi Arabia

Related Topics