Checkout¶

Tip

All requests use POST
Content type is application/json

Brief Description¶

Use this API to create a hosted checkout order and obtain the cashier page URL for the payer.

Request URL¶

/v1/vexora/checkout

Request Method¶

Method: POST
Content-Type: application/json

Headers¶

Header	Required	Type	Description
merchantNo	Yes	String	Merchant number

Body¶

Parameter	Required	Type	Description
sign	Yes	String	The sign field is generated by sorting all fields except sign in alphabetical order and concatenating them as key1=value1key2=value2. Use app secret as salt for MD5 encryption. The sign field should be in lowercase.
timestamp	Yes	String	Timestamp (e.g. 1715941383720)
tradeNo	Yes	String	Unique transaction number (recommended format: yyyymmddhhmmss + random number)
amount	Yes	String	Transaction amount (integer only)
name	Yes	String	Payer's name
channelCode	Yes	String	Payment method: QR
wayCode	Yes	String	Payment route code: `QR`
notifyUrl	Yes	String	Asynchronous callback URL
returnUrl	Yes	String	URL to redirect the customer after successful authorization
remark	Yes	String	Remarks (this field will be returned as‑is)

Request Body Example¶

{
  "sign": "a8f5f167f44f4964e6c998dee827110c",
  "timestamp": "1719876543210",
  "tradeNo": "VX20260331000125",
  "amount": "300",
  "name": "Rizky Pratama",
  "channelCode":"QR",
  "wayCode":"QR",
  "notifyUrl": "https://merchant-api.com/vexora/payment/notify",
  "returnUrl": "https://merchant.com/payment/result",
  "remark": "order_vx_000125"
}

Response¶

Parameter	Required	Type	Description
msg	Yes	String	Request result (success only indicates successful request, not for merchant logic judgment)
code	Yes	String	Request response code (0000 indicates successful request, not for merchant logic judgment). For specific error codes, refer to the business error code enumeration
timestamp	Yes	String	Transaction time
success	Yes	String	Transaction result
data	Yes	Object	Response object
data.tradeNo	Yes	String	Merchant transaction number
data.platFormTradeNo	Yes	String	Unique transaction number
data.status	Yes	String	Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table.
data.message	Yes	String	Error description
data.remark	Yes	String	Returned content of the request (as is)
data.paymentLink	Yes	String	Hosted cashier URL

Successful Response Example¶

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1719876543210,
  "success": true,
  "data": {
    "tradeNo": "VX20260331000125",
    "platFormTradeNo": "vx8f3k29d0qplm7x2",
    "status": "0015",
    "message": "Processing",
    "remark": "order_vx_000125",
    "paymentLink": "https://checkout.vexora.com/pay?token=8f3k29d0qplm7x2a9bc45de7812fg90"
  }
}