API Explanation
Request Type
POST
Request URI
/api/v1/pay/alipay/inapp-pay
Request
| Parameter | Type | Required | Description | Remark |
|---|---|---|---|---|
| userId | String | Yes | Alipay users ID | |
| amount | String | Yes | Transaction Amount | cent is the unit, “100” means a dollar |
| callbackURL | String | Yes | Callback URL | Send notifications to this URL when an order is complete (Maximum length 255 English characters) |
| saleNumber | String | No | ||
| remark | String | No | Remark | Maximum length with 128 English characters |
Request Example：
{
"userId": "2088222545687337",
"amount": "1000",
"callbackURL": "https://your.callback.url",
"saleNumber": "01",
"remark": "this is remark"
}
Response
| Parameter | Type | Description | Remark |
|---|---|---|---|
| paySign | String | ||
| amount | String | Transaction Amount | |
| paymentId | String | Payment Id |
Response Example：
{
"status": "SUCCESS",
"result": {
"paySign": "{\"secondary_merchant_industry\":\"5944\",\"_input_charset\":\"UTF-8\",\"subject\":\"(OTTITTT Test)GCwebappONLY\",\"body\":\"(OTTITTT Test)GCwebappONLY\",\"notify_url\":\"https://uat-scanpay.ottpay.com/online/notify/\",\"product_code\":\"NEW_WAP_OVERSEAS_SELLER\",\"secondary_merchant_id\":\"ON00000185\",\"payment_type\":\"1\",\"out_trade_no\":\"AL4091001475212557\",\"partner\":\"2088721516278382\",\"service\":\"mobile.securitypay.pay\",\"total_fee\":\"10.00\",\"currency\":\"CAD\",\"sign_type\":\"MD5\",\"forex_biz\":\"FP\",\"seller_id\":\"2088721516278382\"}",
"amount": "10.00",
"paymentId": "1677689674209894"
}
}
Payment Result
After the OTT Pay API server obtains the payment result from the payment channel, it will immediately send the payment result to the specified callbackURL. Of course, the merchant system can also actively query through Payment Status Query API.