APIs
Last updated
Last updated
Structure of Payment Request: https://neox- domain?[key1=value]&[key2=value]&... (Table below is the description of key and value, no ordering required)
Key | Require | Type | Description |
---|---|---|---|
Incase of POST(http method), system will response below data:
URL for test: https://sandbox-api.neopay.vn/pg/api/v1/paygate/neopay
Create payment link by GET method:
Request:
Response:
NeoX automatically redirects to payment page.
Create payment link by POST method
Request:
With the Secret Key "7EDB9708213543968555AD010C42C16C". neo_SecureHash is created by hashing the string below:
100000PAYVNDviXASUKU123123123030ORDER00001IFtestpostQRhttps://google.com17EDB9708213543968555AD010C42C16C *Note: If merchant use "neo_ExtData.orderData.payItems" for additional sub order info, the total price of each payItems must equal to neo_Amount.
Response:
Key | Type | Description |
---|---|---|
neo_MerchantCode
String
The merchant representative code that provided by NeoX
neo_Currency
String
Transaction currency, default is “VND”
neo_Locale
String
The language used on payment page, support: “vi”, “en”
neo_Version
String
Payment gateway version, default is “1”
neo_Command
String
Default is “PAY”
neo_Amount
Number
Order amount
neo_MerchantTxnID
String
Transaction id of merchant, unique on merchant’s system and on each request, accept only characters, numerics and list of symbols: “- ”, “_”. Max 36 characters
neo_OrderID
String
Order id of transaction, accept only characters, numerics and list of symbols: “-”, “_”. This field can be duplicate on requests. Max 36 characters
neo_OrderInfo
String
Order infomation, max length 256.
neo_ReturnURL
String
NeoX will redirect to this URL after transaction completed
neo_ExpiresIn
Number
Expiration time (in seconds) of Payment Request. Default is 86400 seconds.
neo_PaymentMethod
Array/ String
A list of below values: WALLET: pay with NeoX e-wallet ATM: pay with domestic card CC: pay with international card QR: pay with QR Code This param allows merchants to display one or more payment methods on the payment page. If not set, all methods will be shown.
Incase GET(http method), this field separeted by the commas
neo_CustomerPhone
String
Customer phone
neo_CustomerEmail
String
Customer email
neo_CustomerID
String
Merchant’s customer id
neo_CustomerIpAddress
String
Customer IP address
neo_TokenCreate
Boolean
Returning payment token after international card payment.Tokenization
neo_IframeCreate
Boolean
Returning redirect payment link as a simple payment for HTML <iFrame/> src
neo_SecureHash
String
A = all above parameters sorted in alphabetical order
B = merchant’s Secret Key(provided by NeoX)
This value = hashed string(using SHA256) of A + B
neo_ExtData
Object
Bill extra data, eg: sub order info, platform, webUrl..., with schema (view example for more details):
neo_ResponseCode
Number
0: Successful.
<>0: Failed, refer Table of errors
neo_ResponseData
Object
{
“redirect”: <Payment link>,
"qrData": A string that used to generate QR code,
"bankName": Beneficial bank name "bankAccount": Beneficial bank account,
"bankAccountName": Account name,
"amount": Order amount,
"remark: Payment description with format:
(50 characters of neo_OrderInfo removed vietnamese accent and special characters) + NEOxxx
*Return QR info if only QR method is chosen
}