Online Payment Gateway (V:20250617)

Download OpenAPI specification:

License: Global Payment

Visa & Mastercard online interface document

Access Token

Request an access token

Your access token authorizes you to use the Payment REST API server

Authorizations:

Authorization

Request Body schema: application/json

appId required	string Merchant client id
secret required	string Merchant client secret

Responses

Request samples

Payload

Content type

application/json

{"appId": "086666075137001",
"secret": "184E52CF5365D2D7EE8EDA************"
}

Checkout Session

Checkout Sessions

Create a Payment Link

Checkout session

Authorizations:

Authorization

Request Body schema: application/json

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
	object metadata
notificationUrl	string 通知地址
orderNo required	string Order no [5..64] characters
paymentMethodType required	string 付款方式
	Array of objects (ProductInfo) Product information
	object (Shipping) Shipping
threeDsMode	string Three Ds Mode[no、auto、standard]

Responses

Request samples

Payload

Content type

application/json

{"amount": "100.99",
"captureMethod": "auto",
"currency": "USD",
"description": "string",
"expiryTime": "60",
"fraudMode": "N",
"frontUrl": "https://www.example.com",
"linkMode": "session",
"metadata": {"property1": "string",
"property2": "string"
},
"notificationUrl": "string",
"orderNo": "20220828000002",
"paymentMethodType": "card",
"productInfo": [{"imageUrl": "https://item.jd.com/100038004351.html?bbtf=1",
"price": "5.55",
"productName": "shirt",
"quantity": "1",
"sku": "00000000000001",
"url": "https://item.jd.com/100038004351.html?bbtf=1"
}
],
"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": "8520083"
},
"trackingNo": "202208290000001"
},
"threeDsMode": "no、auto、standard"
}

Payment Intents

Request a payment

Void a payment

Authorizations:

Authorization

Request Body schema: application/json

orderNo	string 订单编号(orderNo和tradeNo二选一)
tradeNo	string 平台流水号(orderNo和tradeNo二选一)

Responses

Request samples

Payload

Content type

application/json

{"orderNo": "string",
"tradeNo": "string"
}

Capture a payment

capture

Authorizations:

Authorization

Request Body schema: application/json

captureAmount required	string Capture Amount
orderNo	string Order no
tradeNo	string Transaction reference

Responses

Request samples

Payload

Content type

application/json

{"captureAmount": "100.55",
"orderNo": "202308161615130001",
"tradeNo": "202308161615130001"
}

Request a payment

使用任何可用的付款方式创建新付款

Authorizations:

Authorization

Request Body schema: application/json

	object (Alipay) Alipay
	object (AlipayPlus) AlipayPlus
amount required	string Amount #.##
	object (Billing) Billing
	object (Card) Card
currency required	string currency USD、SGD、HKD、ISO-4217
description	string description string[1..50] eg.buy a apple
required	object (DeviceInfo) DeviceInfo
expiryTime	string
fraudMode	string fraud detection eg.N
frontUrl	string Redirect url eg.https://api.xxx.com/callback;After the transaction is completed, a redirect will occur with the provided example parameters:{frontUrl}?tradeNo={tradeNo}&orderNo={orderNo}&status={orderStatus}&language=en-US&amount={amount}
	object (GrabPay) GrabPay
	object metadata
notificationUrl	string Webhook notify url eg.https://api.xxx.com/gateway/notify
orderNo required	string Order no string[5..64]
	object (PayNow) PayNow info
paymentMethodType required	string Payment methodType[card、payNow、paypal、wechat、upay、alipay、alipayPlus、shopeePay、applePay、googlePay,cashPay,zip,affirm]
	object (PayPal) PayPal
	Array of objects (ProductInfo) Product Info
	object (Shipping) Shipping
	object (ShopeePay) ShopeePay
	object (ThreeDsData) 3ds infomation
threeDsMode	string 3ds Mode [no、auto、standard] eg.no
	object (Upay) Upay
	object (Wechat) Wechat

Responses

Request samples

Payload

Content type

application/json

{"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",
"document": "diaodiaofly@gmail.com",
"email": "diaodiaofly@gmail.com",
"phone": {"countryCode": "852",
"number": "8520083"
},
"storedcredentials": "none/store,default is none"
},
"card": {"captureMethod": "auto",
"cardNo": "6212454545454690",
"cvc": "401",
"expiryMonth": "06",
"expiryYear": "2031",
"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",
"frontUrl": "https://www.xxx.com",
"grabPay": {"productType": "qr-code"
},
"metadata": {"property1": "string",
"property2": "string"
},
"notificationUrl": "https://api.xxx.com/gateway/notify",
"orderNo": "20220828000002",
"payNow": {"productType": "qr-code"
},
"paymentMethodType": "card、payNow、paypal、wechat、upay、alipay、alipayPlus、shopeePay、applePay、googlePay,cashPay,zip,affirm",
"paypal": {"metadata": "key-value",
"productType": "qr-code"
},
"productInfo": [{"imageUrl": "https://item.jd.com/100038004351.html?bbtf=1",
"price": "5.55",
"productName": "shirt",
"quantity": "1",
"sku": "00000000000001",
"url": "https://item.jd.com/100038004351.html?bbtf=1"
}
],
"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": "8520083"
},
"trackingNo": "202208290000001"
},
"shopeePay": {"productType": "qr-code"
},
"threeDsData": {"authenticationResultCode": "Y",
"cavv": "a772a34d-d58a-4896-bf22-40b2af96eabd",
"dsTransId": "020100006afa60729412446b96732f98b3ee98a2",
"dsVersion": "2.1.0",
"eci": "01",
"threeDsServerTransactionId": "string",
"xid": "6KFc3kiIW498wGWvQ7X0"
},
"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"
}
}

SubscriptionPayment

Token payment

Authorizations:

Authorization

Request Body schema: application/json

amount required	string Amount [100.58]
cardNo	string card Number [O,min13~max19]
customerInitiatedReason	string Plan Type [RECURRING、INSTALMENT、UNSCHEDULED]
description	string Payment description string[O..50]
	object (DeviceInfo) DeviceInfo
expiryMonth	string Two digit number representing the card's expiration month
expiryYear	string Four digit number representing the card's expiration year
orderNo required	string Merchant's unique order number [5~64]
threeDsMode	string three d secure [no、auto、standard]
transactionIdentifier	string Payment id [1,64]

Responses

Request samples

Payload

Content type

application/json

{"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": "2030",
"orderNo": "20220828000002",
"threeDsMode": "no、auto、standard",
"transactionIdentifier": "000000000000020005060720116005061"
}

Query

Order Query

Get Payment details

inquiry Requests

Authorizations:

Authorization

Request Body schema: application/json

orderNo	string Order no
paymentMethodType	string Payment method(O)
tradeNo	string Transaction reference

Responses

Request samples

Payload

Content type

application/json

{"orderNo": "202308161615130001",
"paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
"tradeNo": "202308161615130001"
}

Get refund details

inquiry Requests

Authorizations:

Authorization

Request Body schema: application/json

orderNo	string Order no
paymentMethodType	string Payment method(O)
tradeNo	string Transaction reference

Responses

Request samples

Payload

Content type

application/json

{"orderNo": "202308161615130001",
"paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
"tradeNo": "202308161615130001"
}

Refund

Refund Manage

Refund a payment

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.

Authorizations:

Authorization

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

{"amount": "100.99",
"clientIp": "10.1.1.1",
"notificationUrl": "string",
"orderNo": "string",
"reason": "The product does not match the description",
"refundNumber": "202208280000001",
"tradeNo": "string"
}

Tracking

Tracking Manage

Retrieve Tracking Details

Authorizations:

Authorization

Request Body schema: application/json

	object matedata
orderNo required	string Order no
trackingNo required	string Tracking No

Responses

Request samples

Payload

Content type

application/json

{"matedata": "K-V",
"orderNo": "202308161615130001",
"trackingNo": "202208290000001"
}

Add logistics information for a single order

Adds tracking information for an Order.

Authorizations:

Authorization

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

{"carrier": "2EBOX",
"orderNo": "202308161615130001",
"shipmentDate": "2025-06-09",
"shipmentDirection": "FORWARD",
"shippingStatus": "SHIPPED、CANCELLED、DELIVERED",
"trackingNo": "Fb202208290000001",
"trackingNumberType": "CARRIER_PROVIDED",
"trackingUrl": "https://t.17track.net/en#nums=76708433717662"
}

Batch add logistics information for orders

Add tracking information for multiple for Order.

Authorizations:

Authorization

Request Body schema: application/json

Array

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

Responses

Request samples

Payload

Content type

application/json

[{"carrier": "2EBOX",
"orderNo": "202308161615130001",
"shipmentDate": "2025-06-09",
"shipmentDirection": "FORWARD",
"shippingStatus": "SHIPPED、CANCELLED、DELIVERED",
"trackingNo": "Fb202208290000001",
"trackingNumberType": "CARRIER_PROVIDED",
"trackingUrl": "https://t.17track.net/en#nums=76708433717662"
}
]

Updates or cancels the tracking

Updates or cancels the tracking information for a order

Authorizations:

Authorization

Request Body schema: application/json

required	Array of objects (TrackingIterm)
	object matedata K-V
orderNo required	string Order no [5..64]
trackingNo required	string tracking no

Responses

Request samples

Payload

Content type

application/json

{"iterms": [{"op": "replace",
"path": "/status",
"value": "CANCELLED"
}
],
"matedata": "K-V",
"orderNo": "202308161615130001",
"trackingNo": "FB202208290000001"
}

Webhook

Webhook Manage

Webhook cancel

Cancel subscription

Authorizations:

Authorization

Responses

Webhook subscribe

You can use the subscription function to receive order results

Authorizations:

Authorization

Request Body schema: application/json

apiVersion required	string Version
signMethod required	string Sign method
subscribeUrl required	string Subscribe url char [3..156]

Responses

Request samples

Payload

Content type

application/json

{"apiVersion": "20250703",
"signMethod": "sha256",
"subscribeUrl": "https://exp.com/payment/notify"
}