Hosted checkout redirection

Base_Url：https://gateway.hyperauth.co

POST /gateway/v2/MultipleInterface

Headers

Name
Value

Content-Type

application/json

API Parameter List：

Parameter Name
Type
Length
Required
Description

merNo

String

5

Yes

【Merchant Number】

gatewayNo

String

8

Yes

【Gateway Number】

orderNo

String

50

Yes

【Merchant Order Number】

orderAmount

String

10

Yes

【Order Amount】 supports two decimal places

orderCurrency

String

3

Yes

【Transaction Currency 】 (e.g., USD)

signInfo

String

64

Yes

【Signature string】 Generated by concatenating parameters in the order: merNo + gatewayNo + orderNo + orderCurrency+ orderAmount + returnUrl+ signkey; and then applying SHA256 encryption.

notifyUrl

String

500

Yes

【Callback URL】 Callback URL for asynchronous notification (optional)👇 method: POST Content-Type:application/json

returnUrl

String

500

Yes

【Return URL】 Required if 3DS authentication is enabled. This is the return URL where the user will be redirected after 3DS verification is completed. The response parameters will be appended to the URL via a GET request.

firstName

String

100

Yes

【Cardholder’s First Name】

lastName

String

50

Yes

【Cardholder’s Last Name】

email

String

200

Yes

【Cardholder’s Email】

ip

String

50

Yes

【Cardholder’s IP Address】

phone

String

50

Yes

【Cardholder’s Phone Number】

country

String

100

Yes

【Cardholder’s Country Code】(e.g., US)

state

String

100

Yes

【Cardholder’s State/Province】

If not available, use the value of the city instead.

city

String

100

Yes

【Cardholder’s City】

address

String

500

Yes

【Cardholder’s Billing Address】

zip

String

100

Yes

【Cardholder’s Zip Code】

shipFee

String

100

No

【Shipping fee】

Shipping fee must be a numeric value with up to two decimal places only.

discount

String

100

No

【Discount Amount】 must be a numeric value with up to two decimal places only.

goodsInfoList

JSONArray

5000

Yes

【Detailed product information】

including gdNo (Product ID), gdName (Product Name), gdPrice (Unit Price), and gdQty (Quantity). Example: [{"gdNo":"19306717","gdName":"product1","gdPrice":"16.16","gdQty":"1"}, {"gdNo":"19306718","gdName":"product2","gdPrice":"15.16","gdQty":"1"}]

shipFirstName

String

100

Yes

【Recipient First Name】

shipLastName

String

100

Yes

【Recipient Last Name】

shipEmail

String

100

Yes

【Recipient Email】

shipPhone

String

100

Yes

【Recipient Phone Number】

shipCountry

String

100

Yes

【Recipient Country Code】(e.g., US)

shipState

String

100

Yes

【Recipient State/Province】 If not available, use the value of the shipCity instead.

shipCity

String

100

Yes

【Recipient City】

shipAddress

String

500

Yes

【Recipient Address】

shipZip

String

100

Yes

【Recipient Zip Code】

os

String

50

Yes

【Cardholder Device Operating System】

userAgent

String

500

Yes

【Cardholder User Agent】

browserLang

String

50

Yes

【Browser Language Code】 (e.g., en-US)

acceptHeader

String

500

Yes

【HTTP Accept Header】

colorDepth

String

10

Yes

【Screen Color Depth】 (e.g., 1, 4, 8, 15, 16, 24, 30, 32 , 48 bits)

timezone

String

50

Yes

【Time zone offset】 (in hours)

resolution

String

50

Yes

【Screen Resolution】 width x height

javascriptEnabled

Boolean

Yes

【Whether JavaScript is enabled】

webSite

String

200

Yes

【Website Domain Name】

remark

String

1000

No

【Remarks / Additional Notes】

Example：

Response：

Parameter Name
Type
Description

merNo

String

【Merchant Number】

gatewayNo

String

【Gateway Number】

tradeNo

String

【Transaction Serial Number】

orderNo

String

【Merchant Order Number】

orderCurrency

String

【Transaction Currency】

orderAmount

String

【Transaction Amount】

orderStatus

String

【Transaction Status Code】 Values: -2: Awaiting Confirmation, -1: Processing, 0: Failed, 1: Successful

orderInfo

String

【Transaction result information】Contains result Code and detailed message.

billAddress

String

【Billing Address】 Returned on successful payment; empty if payment failed.

signInfo

String

【Signature (uppercase)】 Format: sha256(merNo + gatewayNo + tradeNo + orderNo + orderCurrency + orderAmount + orderStatus + orderInfo + signkey)

orderErrorCode

String

Error code if the transaction failed

returnType

String

Return Type: 1: Browser-based synchronous return 2: Server-based real-time return 3: Server asynchronous return

remark

String

【Remarks】 The value sent will be echoed back as-is

redirectUrl

String

【3D Redirect URL】 If not empty, the client should complete the 3DS flow via redirection.

Response Example：

returnUrl Callback Parameter Example：

notifyUrl Callback Parameter Example：

Staging Gateway Test Credentials

44121 44121001 n6xr1255

Test cards

4111111111111111 12/27 123 Visa 5500000000000004 12/28 123 Mastercard

PrevioussubsequentRecurring

Last updated