Skip to main content
POST
/
omr
/
collect
/
apply
OMR Collection Application
curl --request POST \
  --url https://uat-interface.haipay.asia/omr/collect/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": 123,
  "orderId": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "amount": "<string>",
  "payType": "<string>",
  "inBankCode": "<string>",
  "callBackUrl": "<string>",
  "callBackFailUrl": "<string>",
  "goodsName": "<string>",
  "goodsQuantity": "<string>",
  "goodsPrice": "<string>",
  "goodsSku": "<string>",
  "goodsAvatar": "<string>",
  "platform": "<string>",
  "partnerUserId": "<string>",
  "sign": "<string>",
  "currency": "<string>",
  "notifyUrl": "<string>",
  "subject": "<string>",
  "body": "<string>"
}
'
{
  "status": "<string>",
  "error": "<string>",
  "msg": "<string>",
  "data": {
    "orderId": "<string>",
    "orderNo": "<string>",
    "payUrl": "<string>",
    "sign": "<string>"
  }
}

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer
required

Business ID (obtained from backend, must match the currency in the URL)

orderId
string
required

Merchant Order Number

Maximum string length: 48
name
string
required

Recipient name, used for risk control

phone
string
required

Real mobile number

email
string<email>
required

Real email address

amount
string
required

Transaction amount (unit: local currency, accurate to two decimal places; punctuation marks such as "," are prohibited), test environment please use amount below 10SAR

Pattern: ^\d+\.\d{2}$
payType
string
required

Transaction type

inBankCode
string
required
callBackUrl
string<uri>
required

Redirect URL after successful payment

callBackFailUrl
string<uri>
required

Redirect URL after failed payment

goodsName
string
required

Product name

goodsQuantity
string
required

Product quantity

goodsPrice
string
required

Product price

Pattern: ^\d+\.\d{2}$
goodsSku
string
required

Product unique identifier

goodsAvatar
string<uri>
required

Product image (https://)

platform
string
required

Platform name

partnerUserId
string
required

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 -~!@#$%&*()_.

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
sign
string
required

Signature

currency
string

Currency (USD, local currency)

notifyUrl
string<uri>

Callback URL

subject
string

Payment note

body
string

Additional description

Response

200 - application/json
status
string

1: Normal, 0: Exception

error
string

Error code

msg
string

Error description

data
object
Last modified on April 10, 2026