Checkout(for modal checkout)

Use to create a simple pre-order payment request

Integration

See integration detail in General integration steps

Refer to the Code Samples and API Playground for detailed sample code and API testing.

Endpoint URL	Route
Base URL	api/v1/transaction/checkout

Example:

https://uat-secure.galaxypay.vn/api/v1/transaction/checkout

Request Message

Header

Level	Field Name	Data Type	Description
1	apiKey	Alphanumeric mandatory	Request authenticate
1	signature	Alphanumeric mandatory	Request signature

Body

Level	Field Name	Data Type	Description
1	requestID	Alphanumeric(50) mandatory	Unique ID for each transaction request Recommend: GUID
1	requestDateTime	Numeric(14) mandatory	yyyyMMddHHmmss
1	requestData	JSON Object
2	orderID	Alphanumeric(50) mandatory	Transaction ID at Merchant
2	orderNumber	Alphanumeric(20) optional	Order Number or Bill Number
2	orderAmount	Numeric(16) mandatory	Transaction Amount
2	orderNetAmount	Numeric(16) mandatory	Subtotal Amount
2	orderFeeAmount	Numeric(16) mandatory	Fee Amount
2	orderDiscountAmount	Numeric(16) mandatory	Discount Amount
2	orderCurrency	Alpha(3) mandatory	Send the code in Currencies
2	orderDateTime	Numeric(14) mandatory	yyyyMMddHHmmss
2	orderDescription	Alphanumeric(250) mandatory	Transaction Description
2	paymentMethod	Alphanumeric mandatory	DOMESTIC or INTERNATIONAL or WALLET or HUB or QRPAY or BNPL DOMESTIC: VietNam Local Cards or Accounts INTERNATIONAL: International Card WALLET: MoMo, ZaloPay, Viettel… HUB: Payment Hub QRPAY: QR Payment BNPL: Buy Now Pay Later
2	sourceType	Alphanumeric(20) condition	NOT Required when paymentMethod = DOMESTIC or INTERNATIONAL See Payment Method for more detail
2	language	Alpha(2) optional	vi or en vi: Vietnamese en: English
2	customerToken	Alphanumeric optional	Customer identify information that is use for management the linked payment tokens.
2	extraData	JSON Object	Extra data. Same as API Pay

{
  "requestID": "aaa04cf8d97f4c6ebede69135d1bce35",
  "requestDateTime": "20230726175152",
  "requestData": {
    "orderID": "2a43e4b9-c5df-49e6-8b18-42af9bcd150e",
    "orderNumber": 205249008064,
    "orderDateTime": 20230726175152,
    "orderAmount": 100000,
    "orderNetAmount": 100000,
    "orderFeeAmount": 0,
    "orderDiscountAmount": 0,
    "orderCurrency": "VND",
    "orderDescription": "DEMO TRANSACTION",
    "paymentMethod": "DOMESTIC",
    "sourceType": "",
    "customerToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5NXU2MzRKYkZ4VnlBOTVwLVA3ZnpiS3NzcEFhaUFHYmdpcVBmbGktcG9RIn0",
    "language": "vi",
    "extraData": {
    }
  }
}

Response Message

Header

Level	Field name	Data Type	Description
1	signature	Alphanumeric mandatory	Response signature

Body

Level	Field name	Data type	Description
1	requestID	Alphanumeric(50) mandatory	Original Request ID
1	responseDateTime	Numeric(14) mandatory	yyyyMMddHHmmss
1	responseCode	Numeric(3) mandatory	See Response Codes for more detail
1	responseMessage	Alphanumeric(250) mandatory	Response message
1	responseData	JSON Object mandatory	Response data
2	transactionID	Alphanumeric mandatory	GALAXY PAY transaction ID
2	endpoint	Alphanumeric mandatory	Checkout URL

{
    "requestID": "aaa04cf8d97f4c6ebede69135d1bce35",
    "responseDateTime": "20230726175152",
    "responseCode": "200",
    "responseMessage": "Success",
    "responseData": {
        "transactionID": "2307264957979741566492040",
        "endpoint": "https://uat-payment.galaxypay.vn/checkout/2307264957979741566492040/20230726175152/88170618c769f6af5e599403de5722cb1d1b775b62a8714435d3c4dfba51fed5"
    }
}