Checkout¶

Tip

All requests are Post requests, and the data format is json

Brief Description¶

This section introduces the API endpoint for creating a payment link.

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, unit: yuan)
mobile	Yes	String	Payer's actual mobile number (10‑digit number starting with 0, without country code, e.g., 09XXXXXXXX). Note: The mobile number and payer information in the request must match the actual payer information.
firstname	Yes	String	Payer's actual first name. Note: The mobile number and payer information in the request must match the actual payer information.
lastname	Yes	String	Payer's actual last name. Note: The mobile number and payer information in the request must match the actual payer information.
email	Yes	String	Payer's email address
idCardNumber	yes	string	Payer ID card number
channelCode	Yes	String	Payment method(see WayCode appendix for details)
wayCode	Yes	String	Payment channel (see WayCode appendix for details)
notifyUrl	Yes	String	Asynchronous callback URL
returnUrl	Yes	String	URL to redirect the customer after successful authorization
remark	No	String	Remarks (this field will be returned as‑is)

Request Body Example¶

{
  "sign": "9d5ed678fe57bcca610140957afab571",
  "timestamp": "1719876543210",
  "tradeNo": "VX20260331002345",
  "amount": "300.00",
  "mobile": "081234567890",
  "firstname": "Rizky",
  "lastname": "Pratama",
  "email": "rizky.pratama@example.com",
  "channelCode": "NET_BANKING",
  "wayCode": "BANK_TRANSFER",
  "notifyUrl": "https://api.merchant.com/vexora/payment/notify",
  "returnUrl": "https://merchant.com/payment/result",
  "remark": "order_vx_02345"
}

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	Cashier URL

Successful Response Example¶

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1719876543210,
  "success": true,
  "data": {
    "tradeNo": "VX20260331005678",
    "platFormTradeNo": "vx7k2m9d3pl0q8f1a",
    "status": "0015",
    "desc": "Processing",
    "remark": "order_vx_05678",
    "paymentLink": "https://checkout.vexora.com/pay?token=vx7k2m9d3pl0q8f1a9bc45de7812fg90"
  }
}