Download OpenAPI specification:
Visa & Mastercard online interface document
Your access token authorizes you to use the Payment REST API server
| appId required | string Merchant client id |
| secret required | string Merchant client secret |
{- "appId": "086666075137001",
- "secret": "184E52CF5365D2D7EE8EDA************"
}Checkout session
| amount required | string Amount |
| captureMethod | string auto、manual |
| currency required | string Currency ISO 4217 code |
| description | string Description [1..25] characters |
| expiryTime | string Expire time [30-120]minutes |
| fraudMode | string Fraud Mode |
| frontUrl | string Redirect url [3..128] characters |
| linkMode | string Cashier mode - please contact the operations personnel |
| notificationUrl | string 通知地址 |
| orderNo required | string Order no [5..64] characters |
Array of objects (ProductInfo) Product information | |
object (Shipping) Shipping | |
| threeDsMode | string Three Ds Mode[no、auto、standard] |
{- "amount": "100.99",
- "captureMethod": "auto",
- "currency": "USD",
- "description": "string",
- "expiryTime": "60",
- "fraudMode": "N",
- "linkMode": "session",
- "notificationUrl": "string",
- "orderNo": "20220828000002",
- "productInfo": [
- {
- "price": "5.55",
- "productName": "shirt",
- "quantity": "1",
- "sku": "00000000000001",
}
], - "shipping": {
- "address": {
- "city": "Seattle",
- "country": "HK",
- "line1": "Test 109 line",
- "line2": "line2",
- "line3": "line3",
- "postcode": "98102",
- "state": "WA"
}, - "carrier": "Fedex",
- "email": "diaodiaofly@gmail.com",
- "firstName": "zhong",
- "lastName": "yang",
- "phone": {
- "countryCode": "852",
- "number": "18510775231"
}, - "trackingNo": "202208290000001"
}, - "threeDsMode": "no、auto、standard"
}capture
| captureAmount required | string Capture Amount |
| orderNo | string Order no |
| tradeNo | string Transaction reference |
{- "captureAmount": "100.55",
- "orderNo": "202308161615130001",
- "tradeNo": "202308161615130001"
}使用任何可用的付款方式创建新付款
object (Alipay) Alipay | |
object (AlipayPlus) AlipayPlus | |
| amount required | string Amount |
object (Billing) Billing | |
| billingDesc | string billing Desc |
object (Card) Card | |
| currency required | string currency |
| description | string description string[1..50] |
required | object (DeviceInfo) DeviceInfo |
| expiryTime | string |
| fraudMode | string fraud detection |
| frontUrl | string Redirect web url |
object (GrabPay) GrabPay | |
| notificationUrl | string 通知地址 |
| orderNo required | string Order no string[5..64] |
object (PayNow) PayNow info | |
| paymentMethodType required | string Payment methodType[1, 20] |
object (PayPal) PayPal | |
Array of objects (ProductInfo) Product Info | |
object (Shipping) Shipping | |
object (ShopeePay) ShopeePay | |
object (ThreeDsData) 3ds eci信息 | |
| threeDsMode | string 3ds Mode |
object (Upay) Upay | |
object (Wechat) |
{- "alipay": {
- "authCode": "120061098828009406",
- "limitPayMethod": "no_credit",
- "openId": "string",
- "productType": "qr-code",
- "storeId": "P000001",
- "subAppId": "string"
}, - "alipayPlus": {
- "authCode": "120061098828009406",
- "limitPayMethod": "no_credit",
- "openId": "string",
- "productType": "qr-code",
- "storeId": "P000001",
- "subAppId": "string"
}, - "amount": "199.68",
- "billing": {
- "address": {
- "city": "Seattle",
- "country": "HK",
- "line1": "Test 109 line",
- "line2": "line2",
- "line3": "line3",
- "postcode": "98102",
- "state": "WA"
}, - "birthday": "2022-08-01",
- "customerInitiatedReason": "UNSCHEDULED",
- "email": "diaodiaofly@gmail.com",
- "phone": {
- "countryCode": "852",
- "number": "18510775231"
}, - "storedcredentials": "none/store,default is none"
}, - "billingDesc": "If you need to activate, please contact the account manager",
- "card": {
- "captureMethod": "auto",
- "cardNo": "6212454545454690",
- "cvc": "401",
- "expiryMonth": "06",
- "expiryYear": "2027",
- "firstName": "zhong",
- "lastName": "yang"
}, - "currency": "USD、SGD、HKD、ISO-4217",
- "description": "buy a apple",
- "deviceInfo": {
- "browser": {
- "acceptHeader": "text/html",
- "colorDepth": "48",
- "javaEnable": false,
- "javascriptEnable": true,
- "screenHeight": "800",
- "screenWidth": "1200",
- "sessionId": "0",
- "timeZone": "0",
- "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
}, - "clientIp": "10.1.1.1",
- "deviceId": "10000000000",
- "language": "en-US",
- "location": {
- "lat": "-37.81892",
- "lon": "144.95913"
}, - "mobile": {
- "deviceModel": "apple iphone7",
- "osType": "IOS",
- "osVersion": "ios14.5"
}
}, - "expiryTime": "60",
- "fraudMode": "N、Y",
- "grabPay": {
- "productType": "qr-code"
}, - "notificationUrl": "string",
- "orderNo": "20220828000002",
- "payNow": {
- "productType": "qr-code"
}, - "paymentMethodType": "card、payNow、paypal、wechat、upay、alipay、alipayPlus、shopeePay、applePay、googlePay",
- "paypal": {
- "metadata": "key-value",
- "productType": "qr-code"
}, - "productInfo": [
- {
- "price": "5.55",
- "productName": "shirt",
- "quantity": "1",
- "sku": "00000000000001",
}
], - "shipping": {
- "address": {
- "city": "Seattle",
- "country": "HK",
- "line1": "Test 109 line",
- "line2": "line2",
- "line3": "line3",
- "postcode": "98102",
- "state": "WA"
}, - "carrier": "Fedex",
- "email": "diaodiaofly@gmail.com",
- "firstName": "zhong",
- "lastName": "yang",
- "phone": {
- "countryCode": "852",
- "number": "18510775231"
}, - "trackingNo": "202208290000001"
}, - "shopeePay": {
- "productType": "qr-code"
}, - "threeDsData": {
- "authenticationResultCode": "Y",
- "cavv": "a772a34d-d58a-4896-bf22-40b2af96eabd",
- "dsTransId": "020100006afa60729412446b96732f98b3ee98a2",
- "dsVersion": "2.1.0",
- "eci": "01",
- "xid": "05"
}, - "threeDsMode": "no、auto、standard",
- "upay": {
- "authCode": "120061098828009406",
- "productType": "qr-code",
- "storeId": "P000001"
}, - "wechat": {
- "attach": "string",
- "authCode": "120061098828009406",
- "limitPayMethod": "no_credit",
- "openId": "string",
- "productType": "qr-code、pay、in-app、mini-program、h5",
- "storeId": "P000001",
- "subAppId": "string"
}
}Token payment
| amount required | string 金额 [M,100.58] |
| cardNo | string card Number [O,min13~max19] |
| customerInitiatedReason | string 计划类型:RECURRING/INSTALMENT/UNSCHEDULED |
| description | string 附言 string[O 1..50] |
object (DeviceInfo) DeviceInfo | |
| expiryMonth required | string 月份 [O,11] |
| expiryYear required | string expiry year [O,2026] |
| orderNo required | string 订单编号 [O,min5~max64] |
| threeDsMode | string 3ds模式取值[no、auto、standard] |
| transactionIdentifier | string 凭证串 [O,min5~max64] |
{- "amount": "100.99",
- "cardNo": "4444333322221111",
- "customerInitiatedReason": "RECURRING",
- "description": "string",
- "deviceInfo": {
- "browser": {
- "acceptHeader": "text/html",
- "colorDepth": "48",
- "javaEnable": false,
- "javascriptEnable": true,
- "screenHeight": "800",
- "screenWidth": "1200",
- "sessionId": "0",
- "timeZone": "0",
- "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
}, - "clientIp": "10.1.1.1",
- "deviceId": "10000000000",
- "language": "en-US",
- "location": {
- "lat": "-37.81892",
- "lon": "144.95913"
}, - "mobile": {
- "deviceModel": "apple iphone7",
- "osType": "IOS",
- "osVersion": "ios14.5"
}
}, - "expiryMonth": "12",
- "expiryYear": "2027",
- "orderNo": "20220828000002",
- "threeDsMode": "no、auto、standard",
- "transactionIdentifier": "000000000000020005060720116005061"
}inquiry Requests
| orderNo | string Order no |
| paymentMethodType | string Payment method(O) |
| tradeNo | string Transaction reference |
{- "orderNo": "202308161615130001",
- "paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
- "tradeNo": "202308161615130001"
}inquiry Requests
| orderNo | string Order no |
| paymentMethodType | string Payment method(O) |
| tradeNo | string Transaction reference |
{- "orderNo": "202308161615130001",
- "paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
- "tradeNo": "202308161615130001"
}Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.
| amount required | string amount |
| clientIp required | string Client ip |
| notificationUrl | string 通知地址 |
| orderNo | string Transaction order no |
| reason required | string reason |
| refundNumber required | string Refund order no |
| tradeNo | string Transaction reference |
{- "amount": "100.99",
- "clientIp": "10.1.1.1",
- "notificationUrl": "string",
- "orderNo": "string",
- "reason": "The product does not match the description",
- "refundNumber": "202208280000001",
- "tradeNo": "string"
}Retrieve Tracking Details
object matedata | |
| orderNo required | string Order no |
| trackingNo required | string Tracking No |
{- "matedata": "K-V",
- "orderNo": "202308161615130001",
- "trackingNo": "202208290000001"
}Adds tracking information for an Order.
| carrier required | string carrier |
| orderNo required | string Order no [5..64] |
| shipmentDate required | string Shipment date |
| shipmentDirection required | string Shipment direction |
| shippingStatus required | string Status |
| trackingNo required | string Tracking no |
| trackingNumberType required | string Tracking number type |
| trackingUrl | string tracking url |
{- "carrier": "2EBOX",
- "orderNo": "202308161615130001",
- "shipmentDate": "2025-06-09",
- "shipmentDirection": "FORWARD",
- "shippingStatus": "SHIPPED、CANCELLED、DELIVERED",
- "trackingNo": "Fb202208290000001",
- "trackingNumberType": "CARRIER_PROVIDED",
}Add tracking information for multiple for Order.
| carrier required | string carrier |
| orderNo required | string Order no [5..64] |
| shipmentDate required | string Shipment date |
| shipmentDirection required | string Shipment direction |
| shippingStatus required | string Status |
| trackingNo required | string Tracking no |
| trackingNumberType required | string Tracking number type |
| trackingUrl | string tracking url |
[- {
- "carrier": "2EBOX",
- "orderNo": "202308161615130001",
- "shipmentDate": "2025-06-09",
- "shipmentDirection": "FORWARD",
- "shippingStatus": "SHIPPED、CANCELLED、DELIVERED",
- "trackingNo": "Fb202208290000001",
- "trackingNumberType": "CARRIER_PROVIDED",
}
]Updates or cancels the tracking information for a order
required | Array of objects (TrackingIterm) |
object matedata K-V | |
| orderNo required | string Order no [5..64] |
| trackingNo required | string tracking no |
{- "iterms": [
- {
- "op": "replace",
- "path": "/status",
- "value": "CANCELLED"
}
], - "matedata": "K-V",
- "orderNo": "202308161615130001",
- "trackingNo": "FB202208290000001"
}You can use the subscription function to receive order results
| apiVersion required | string Version |
| signMethod required | string Sign method |
| subscribeUrl required | string Subscribe url char [3..156] |
{- "apiVersion": "20250703",
- "signMethod": "sha256",
}