Pay

Use to create a simple payment request. Use for Merchant checkout and Merchant Hosted checkout.

APIOperation = PAY; require sourceOfFund when use Merchant Hosted checkout.

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/pay

Example:

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

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	apiVersion	Numeric(5) optional	Specify the api version. Current supported version is 2. If this field is omitted, the default value of apiVersion is 1
2	apiOperation	Alpha(20) mandatory	PAY
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	orderCurrency	Alpha(3) mandatory	Send the code in Currencies
2	orderDateTime	Numeric(14) mandatory	yyyyMMddHHmmss
2	orderDescription	Alphanumeric(250) mandatory	Transaction Description
2	paymentMethod	Alpha(20) mandatory	See Payment Method
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	isAutoCapture	Alpha(20) optional	true or false default: true Only apply for International Card Required call API Capture in case false to finish transaction See isAutoCapture for more detail
2	successURL	Alphanumeric(500) optional	Callback URL when Payment is success
2	failureURL	Alphanumeric(500) optional	Callback URL when Payment is failure
2	cancelURL	Alphanumeric(500) optional	Callback URL when Customer cancel payment
2	ipnURL	Alphanumeric(500) optional	IPN URL
2	subMerchant	JSON Object optional	Only use for master merchant scope
3	identifier	String(50) optional	Sub-merchant ID
2	sourceOfFund	Alpha(50) condition	CARD Required when use Merchant Hosted Checkout
2	cardNumber	Numeric(19) condition	Required when use Merchant Hosted Checkout
2	cardHolderName	Alphanumeric(19) condition	Required when use Merchant Hosted Checkout
2	cardExpireDate	Alphanumeric(5) condition	Required when use Merchant Hosted Checkout Format: MM/YY
2	cardVerificationValue	Numeric(3) condition	Required when use Merchant Hosted Checkout Only use for International Card
2	extraData	JSON Object optional	Extra data
3	customer	JSON Object optional	Customer information
4	firstName	Alphanumeric(50) optional	Customer first name
4	lastName	Alphanumeric(50) optional	Customer last name
4	identityNumber	Numeric(50) optional	Customer national ID
4	email	Alphanumeric(50) optional	Customer email
4	phoneNumber	Numeric(50) optional	Customer phone number
4	phoneType	Alpha(1) optional	Customer phone type F: Fixed-line or M: Mobile
4	gender	Alpha(1) optional	Customer gender M: Male, F: Female
4	dateOfBirth	Numeric(8) optional	Customer birth day Format: yyyyMMdd
4	title	Alphanumeric(50) optional	Customer title
3	device	JSON Object	Device information
4	browser	Alphanumeric(50) optional	Browser information
4	fingerprint	Alphanumeric(100) optional	Unique identifier for the device
4	hostName	Alphanumeric(50) optional	The name of merchant server
4	ipAddress	Alphanumeric(50) optional	The ip address of merchant server
4	deviceID	Alphanumeric(50) optional	Mobile device identifier
4	deviceModel	Alphanumeric(50) optional	Mobile device model
3	application	JSON Object	Application information
4	applicationID	Alphanumeric(50) optional	Application Identifier
4	applicationChannel	Alpha(50) optional	Application channel Mobile, Web, POS
3	billing	JSON Object	Billing address information
4	country	Alpha(2) optional	Billing country
4	state	Alphanumeric(50) optional	Billing state/province
4	city	Alphanumeric(50) optional	Billing city
4	postalCode	Alphanumeric(50) optional	Billing postal code
4	streetNumber	Alphanumeric(50) optional	Billing street number
4	address01	Alphanumeric(50) optional	Billing address line 1
4	address02	Alphanumeric(50) optional	Billing address line 2
3	shipping	JSON Object	Shipping address information
4	country	Alpha(2) optional	Shipping country
4	state	Alphanumeric(50) optional	Shipping state/province
4	city	Alphanumeric(50) optional	Shipping city
4	postalCode	Alphanumeric(50) optional	Shipping postal code
4	streetNumber	Alphanumeric(50) optional	Shipping street number
4	address01	Alphanumeric(50) optional	Shipping address line 1
4	address02	Alphanumeric(50) optional	Shipping address line 2

Sample request

{
  "requestID": "14653fa12f694f4f9d4b240e1bebbdf3",
  "requestDateTime": "20230726172307",
  "requestData": {
    "apiOperation": "PAY",
    "orderID": "2a43e4b9-c5df-49e6-8b18-42af9bcd150e",
    "orderNumber": 205249008064,
    "orderAmount": 100000,
    "orderCurrency": "VND",
    "orderDateTime": 20230726172307,
    "orderDescription": "DEMO TRANSACTION",
    "paymentMethod": "DOMESTIC",
    "sourceType": "",
    "language": "vi",
    "subMerchant": {
        "identifier": "10218"
    },
    "extraData": {
      "device": {
        "browser": "Safari",
        "fingerprint": "hA05iBWrRE",
        "hostName": "Galaxy Pay",
        "ipAddress": "10.192.168.10",
        "deviceID": "NzoBA2ys2y",
        "deviceModel": "IPhone"
      },
      "application": {
        "applicationID": "KbPCc8eSXH",
        "applicationChannel": "Mobile"
      },
      "billing": {
        "country": "vn",
        "state": "",
        "city": "Hồ Chí Minh",
        "postalCode": "70000",
        "streetNumber": "673",
        "address01": "Đường Nguyễn Hữu Thọ",
        "address02": ""
      },
      "shipping": {
        "country": "vn",
        "state": "",
        "city": "Hồ Chí Minh",
        "postalCode": "70000",
        "streetNumber": "673",
        "address01": "Đường Nguyễn Hữu Thọ",
        "address02": ""
      }
    }
  }
}

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(38) mandatory	GALAXY PAY transaction ID
2	endpoint	Alphanumeric mandatory	Secure Payment URL (Use for Redirect)

Sample response

{
    "requestID": "14653fa12f694f4f9d4b240e1bebbdf3",
    "responseDateTime": "20230726172307",
    "responseCode": "200",
    "responseMessage": "Success",
    "responseData": {
        "transactionID": "2307264944869814641620077",
        "endpoint": "https://uat-payment.galaxypay.vn/pay/2307264944869814641620077/20230726172332/993c33d5640b80c4b9ee5f7a0bc6169e6621d032c345b91babb5b2973b75158f"
    }
}