Skip to content

Checkout

Tip

  • All requests are Post requests, and the data format is json
Brief Description
  • For USD, the supported card schemes are Visa and Mastercard.
  • For JPY, the supported card scheme is JCB.
Currency-Specific Domain
  • Card pay-in requests use different API base URLs for different currencies.
  • For USD, use https://sandbox-api.vexora.com/card.
  • For JPY, use https://sandbox-api.vexora.com/cardJpy.
  • The currency field in the request body must match the API base URL you use.
  • The merchantNo header and sign must use the MID and secret key assigned for the selected currency.
Request URL
  • /v1/vexora/checkout
Request Method
  • Method: POST
  • Content-Type: application/json
Parameter Required Type Description
merchantNo Yes String Merchant number. Use the MID assigned for the selected currency.
Request Body Parameters
Name Required Type Description
sign Yes String Use all fields except sign, sort them alphabetically, and concatenate as key1=value1key2=value2.... Then use the app secret as a salt for MD5 encryption. The sign should be in lowercase.
timestamp Yes long Timestamp of the transaction.
tradeNo Yes String Merchant transaction number. Must be unique.
amount Yes String Transaction amount ๏ผˆUSD: Supports up to 2 decimal places JPY: Integer only ๏ผ‰
name Yes String Cardholder name.
mobile Yes String Cardholder's mobile number (supports country code + local mobile number).
email Yes String Email address (used to notify the user by email after the transaction is completed)
userId Yes String Merchant user ID
currency Yes String Currency code. Supported values: USD, JPY. Use the matching API base URL for the selected currency.
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 Example (USD / Visa / Mastercard)
{
  "sign": "f53ee692f15d0329a1461373b67ff25a",
  "timestamp": "1724142041682",
  "tradeNo": "order_card_usd_000007",
  "amount": "300.00",
  "name": "John Smith",
  "mobile": "12025550123",
  "email": "john.smith@example.com",
  "userId": "customer_10001",
  "currency": "USD",
  "notifyUrl": "https://merchant.example.com/api/v1/payments/card/notify",
  "returnUrl": "https://merchant.example.com/payments/result",
  "remark": "order_card_usd_000007"
}
Request Example (JPY / JCB)
{
  "sign": "9b8f4a631c2d7e0f8a6c1d2b3e4f5a67",
  "timestamp": "1724142042682",
  "tradeNo": "order_card_jpy_000008",
  "amount": "45000",
  "name": "Taro Yamada",
  "mobile": "819012345678",
  "email": "taro.yamada@example.com",
  "userId": "customer_10002",
  "currency": "JPY",
  "notifyUrl": "https://merchant.example.com/api/v1/payments/card/notify",
  "returnUrl": "https://merchant.example.com/payments/result",
  "remark": "order_card_jpy_000008"
}
Response Parameters
Parameter Name Required Type Description
msg Yes String Request result (only indicates the success of the current request, not for merchant-side logic).
code Yes String Response code (only indicates the success of the current request, not for merchant-side logic). For specific error codes, refer to the business error code enumeration.
timestamp Yes String Transaction timestamp.
success Yes Boolean Transaction result.
data Yes Object Returned object.
data.platFormTradeNo Yes String Unique platform 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 Request content returned (as is).
data.paymentUrl Yes String Payment link, i.e., cashier link.
Successful Response Example
{
  "msg": "success",
  "code": "0000",
  "timestamp": "1729153481590",
  "success": true,
  "data": {
    "platFormTradeNo": "ccusd20260603000001",
    "status": "0015",
    "message": "Payment link created successfully",
    "remark": "order_card_usd_000007",
    "paymentUrl": "https://ccutest.dj70000.com/pay?token=ccusd20260603000001"
  }
}