Direct Deposit¶

Payment API utilizes JSON data and does not provide a payment page, requiring merchants to create and manage their own payment page.

Tip

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

Brief description¶

Request URL¶

/v1/vexora/deposits

Request method¶

Method: POST
Content-Type: application/json

Collection Method Codes¶

Value	Description
`STORE`	Convenience store payment
`VA`	Virtual account (CLABE) payment

Request Headers¶

Parameter	Required	Type	Description
`merchantNo`	Yes	String	Merchant number assigned by Vexora.

Request Parameters¶

Parameter	Required	Type	Description
`tradeNo`	Yes	String	Unique merchant transaction number. Recommended format: `YYYYMMDDHHMMSS` followed by a random suffix.
`amount`	Yes	String	Payment amount in MXN. Decimal values are not supported.
`wayCode`	Yes	String	Collection method code. See Collection Method Codes.
`name`	No	String	Payer's full name.
`mobile`	No	String	Payer's mobile phone number.
`email`	No	String	Payer's email address.
`notifyUrl`	Yes	String	URL that receives asynchronous transaction status notifications.
`returnUrl`	No	String	URL to which the payer is redirected after checkout. If omitted, the system default result page is used.
`remark`	No	String	Merchant-defined information returned unchanged in the response and callback.
`timestamp`	Yes	String	Current Unix timestamp in milliseconds, represented as a string.
`sign`	Yes	String	Lowercase MD5 request signature. Exclude `sign`, sort all non-empty request parameters by name, concatenate them as `key1=value1key2=value2`, append the app secret, and calculate the MD5 hash.

Request Example¶

{
  "tradeNo": "test_00000008",
  "amount": "300",
  "wayCode": "va",
  "name": "kevin zhang",
  "mobile": "15745896325",
  "email": "kevin_zhang@163.com",
  "notifyUrl": "https://google.com",
  "returnUrl": "http://abc.com/callback_page",
  "remark": "test",
  "timestamp": "1728609257212",
  "sign": "0be92a962072b1786a01a2cab4891a1d"
}

Response Parameters¶

Parameter	Required	Type	Description
`code`	Yes	String	API response code. `0000` indicates that the request was accepted; use `data.status` to determine the transaction status.
`msg`	Yes	String	Description of the API request result.
`success`	Yes	Boolean	Whether the API request was processed successfully.
`timestamp`	Yes	Long	Server timestamp in milliseconds.
`data`	Yes	Object	Transaction response object.
`data.tradeNo`	Yes	String	Merchant transaction number.
`data.platFormTradeNo`	Yes	String	Unique Vexora transaction number.
`data.status`	Yes	String	Transaction status code. Use this field for merchant-side transaction processing.
`data.message`	Yes	String	Transaction status description.
`data.paymentInfo`	Yes	String	Payment information required to complete the collection.
`data.remark`	Yes	String	Merchant-defined information returned unchanged from the request.

Response Example¶

{
    "code": "0000",
    "msg": "success",
    "success": true,
    "timestamp": 1728609277476,
    "data": {
        "tradeNo": "test_00000008",
        "platFormTradeNo": "68o0uwogz7mnzutt",
        "status": "0015",
        "message": "Paying",
        "paymentInfo": "6841800930023213210",
        "remark": "test"
    }
}