NEOPAY SDK Example

# Web SDK ## Javascript SDK for NeoX Payment Gateway **Tutorial & Code sample**: [NeoX SDK(javascript)](https://github.com/neopayvn/neopay-pg-js-sdk) **Use** ``` NEOPAY SDK Example

``` ``` NEOPAY SDK Example Checkout Checkout ``` #### Methods

Method	Description
init	Initialize the necessary configurations for the SDK and UI
pay	Payment
close	Close payment popup

**neopaySDK.init (neo\_PaymmentBaseUrl, configUI, callbacks)**
**neo\_PaymmentBaseUrl** Sandbox environment testing URL: ** #### configUI

Parammetter	Data Type	Default Value	Description
neo_HiddenHeader	boolean	false	Hide header
neo_HiddenFooter	boolean	false	Hide footer
neo_HiddenPaymentMethod	boolean	false	Hide payment method
neo_HiddenOrderInfo	boolean	false	Hide order information

#### neopaySDK.pay (config, hashKey)

Parameter	Data Type	Default Value	Required	Description
neo_MerchantCode	string		Y	Merchant code is provided by NeoX
neo_Currency	string	VND	Y	Transaction currency, VND as default
neo_Locale	string	vi	Y	Language will display on the checkout page. Support: “vi”, “en”.

#### neopaySDK.pay (config, hashKey)

Parameter	Data Type	Default Value	Required	Descript
neo_MerchantCode	string		Y	Merchant code is provided by NeoX
neo_Currency	string	VND	Y	Transaction currency, VND as default
neo_Locale	string	vi	Y	Language will display on the checkout page. Support: “vi”, “en”.
neo_Version	string	1	Y	Payment gateway version, “1” as default
neo_Command	string	PAY	Y	“PAY” as default
neo_Amount	number		Y	Payment amount
neo_MerchantTxnID	string		Y	Unique - Transaction ID is provided by merchant
neo_OrderID	string		Y	Oder ID
neo_OrderInfo	string		Y	Oder information
neo_Title	string		Y	Thông tin tiêu đề sẽ hiển thị trên trang thanh toán
neo_ReturnURL	string		Y	The website URL of the merchant
neo_ViewType	string	"POPUP" / "REDIRECT"	Y	Choose to open payment gateway as popup or redirect
neo_PaymentMethod	string	["WALLET", "ATM", "CC", "QR"]	N	Allows to choose to display direct or list payment channels. If this field is not transmitted, all channels will be displayed.

#### Request sample ``` { neo_MerchantCode: "RZRGNY", neo_PaymentMethod: ["WALLET", "ATM", "CC", "QR"], neo_Currency: "VND", neo_Locale: "vi", neo_Version: "1", neo_Command: "PAY", neo_Amount: Math.floor(Math.random() * 600000) + 100000, neo_MerchantTxnID: `T${`${Date.now()}`.slice(-8)}`, neo_OrderID: `DH${`${Date.now()}`.slice(-8)}`, neo_OrderInfo: `Payment for Test Order`, neo_Title: "Payment", neo_ReturnURL: "https://sandbox-api.neopay.vn/pg/paygate/tryitnow", neo_ViewType: "POPUP", } ``` #### callback

Event	Description
onSuccess	The event occurs when payment is successful.
onFailure	The event occurs when payment fails.
onClose	The event occurs when the popup is closed.

**Callback data from onSuccess and onFailure**

Parameter	Data Type	Description
neo_MerchantCode	string	Merchant code is provided by NeoX
neo_Currency	string	Transaction currency, VND as default
neo_Locale	string	Language will display on the checkout page. Support: “vi”, “en”.
neo_Version	string	Payment gateway version, “1” as default
neo_Command	string	“PAY” as default
neo_Amount	string	Payment amount
neo_MerchantTxnID	string	Unique - Transaction ID is provided by merchant
neo_OrderID	string	Oder ID
neo_OrderInfo	string	Oder Information
neo_TransactionID	string	Unique - Transaction ID is generated by the NeoX system, for reconciling.
neo_ResponseCode	number	The error code is returned by NeoX, indicates the transaction result.
neo_ResponseMsg	string	Error description.
neo_CustomerID	string	The customer ID on the merchant system.
neo_ResponseData	string	The data response of customer's payment.
neo_SecureHash	string	Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (will be provided by NeoX after actual integration)

#### Response sample ``` { "neo_Amount": "112214", "neo_Command": "PAY", "neo_Currency": "VND", "neo_Locale": "vi", "neo_MerchantCode": "RZRGNY", "neo_MerchantTxnID": "T23343243", "neo_OrderID": "DH28900084", "neo_OrderInfo": "Thanh toán ĐH Test", "neo_ResponseCode": "0", "neo_ResponseData": "", "neo_ResponseMsg": "Success", "neo_SecureHash": "80A669689BEE56D02211F8C762D828194C5B3AD121420433D280696B952F3A19", "neo_TransactionID": "5226", "neo_Version": "1" } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.neox.vn/docs/global/payment-gateway/integrations/hosted-checkout/web-sdk.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.