initialRecurring
initialRecurring
Base_Url：https://gateway.hyperauth.co
POST /gateway/initialRecurring
Headers
Content-Type
application/json
API Parameter List：
merNo
String
5
Yes
【Merchant Number】
gatewayNo
String
8
Yes
【Gateway Number】
orderNo
String
50
Yes
【Transaction Serial Number】
orderAmount
String
10
Yes
【Transaction Amount】
orderCurrency
String
3
Yes
【Transaction Currency】
signInfo
String
64
Yes
【Signature (uppercase)】
Generated by concatenating parameters in the order: merNo + gatewayNo +orderNo+orderCurrency +orderAmount +firstName+lastName+cardNo+ cardExpireYear + cardExpireMonth+cardSecurityCode +email+ signKey and then applying SHA256 encryption.
notifyUrl
String
500
No
【Callback URL】 Callback URL for asynchronous notification (optional)👇 method: POST Content-Type:application/json
returnUrl
String
500
No
【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.
cardInfo
Object
2000
Yes
【Card Info】
cardInfo.cardNo
String
200
Yes
【Card Number】(e.g.,4111111111111111)
cardInfo.cardExpireMonth
String
20
Yes
【Card Expiry Month】 (e.g., 08)
cardInfo.cardExpireYear
String
20
Yes
【Card Expiry Year】 (e.g., 2026)
cardInfo.cardSecurityCode
String
100
Yes
【CVV】 (usually 3 digits on back of card)
cardInfo.cardHolderName
String
100
YES
【Cardholder’s Full Name】
billAddress
Object
1000
YES
【billAddress info】
billAddress.firstName
String
100
Yes
【Cardholder’s First Name】
billAddress.lastName
String
50
Yes
【Cardholder’s Last Name】
billAddress.email
String
200
Yes
【Cardholder’s Email】
billAddress.ip
String
50
Yes
【Cardholder’s IP Address】
billAddress.phone
String
50
Yes
【Cardholder’s Phone Number】
billAddress.country
String
100
Yes
【Cardholder’s Country Code】(e.g., US)
billAddress.state
String
100
Yes
【Cardholder’s State/Province】
If not available, use the value of the city instead.
billAddress.city
String
100
Yes
【Cardholder’s City】
billAddress.address
String
500
Yes
【Cardholder’s Billing Address】
billAddress.zip
String
100
Yes
【Cardholder’s Zip Code】
recurringData
Object
5000
Yes
【Subscription Information】
recurringData.eventStartDate
String
50
Yes
【Event Start Date】
Format: yyyy-MM-dd
The date when the event begins.
recurringData.eventEndDate
String
50
Yes
【Event End Date】
Format: yyyy-MM-dd
The date when the event ends.
recurringData.eventId
String
50
Yes
【Event ID】
A unique identifier for the event.
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"}]
shipAddress
Object
1000
Yes
【ship Address】
shipAddress.firstName
String
100
Yes
【Recipient First Name】
shipAddress.lastName
String
100
Yes
【Recipient Last Name】
shipAddress.email
String
100
Yes
【Recipient Email】
shipAddress.phone
String
100
Yes
【Recipient Phone Number】
shipAddress.country
String
100
Yes
【Recipient Country Code】
(e.g., US)
shipAddress.state
String
100
Yes
【Recipient State/Province】 If not available, use the value of the shipCity instead.
shipAddress.city
String
100
Yes
【Recipient City】
shipAddress.address
String
500
Yes
【Recipient Address】
shipAddress.zip
String
100
Yes
【Recipient Zip Code】
os
String
50
Yes
【Cardholder Device Operating System】
browser
Object
3000
Yes
【browser info】
browser.userAgent
String
500
Yes
【Cardholder User Agent】
browser.lang
String
50
Yes
【Browser Language Code】 (e.g., en-US)
browser.acceptHeader
String
500
Yes
【HTTP Accept Header】
browser.colorDepth
String
10
Yes
【Screen Color Depth】 (e.g., 1, 4, 8, 15, 16, 24, 30, 32 , 48 bits)
browser.javascriptEnabled
Boolean
Yes
【Whether JavaScript is enabled】
timezone
String
50
Yes
【Time zone offset】 (in hours)
resolution
String
50
Yes
【Screen Resolution】 width x height
webSite
String
200
Yes
【Website Domain Name】
remark
String
1000
No
【Remarks / Additional Notes】
Request Example (for reference only)：
Response Parameter List：
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)】signInfo=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.
redirectMethod
String
【3D Redirect Method】
2D Response Example
3D Response Example
returnUrl Callback Parameter Example：
notifyUrl Callback Parameter Example：
Last updated