Disbursement¶

Tip

Payout API is used to initiate transfer requests to e-wallets or bank accounts.

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

Short Description¶

For specific bank enumeration values, please go to the bank list.

Request URL¶

/v1/vexora/disbursements

Request method¶

Method: POST
Content-Type: application/json

Account Types¶

Value	Length	Description
`DebitCard`	16 digits	`bankNumber` must contain a 16-digit debit card number.
`CLABE`	18 digits	`bankNumber` must contain an 18-digit CLABE number.

Request Headers¶

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

Request Body Parameters¶

Parameter	Required	Type	Description
`tradeNo`	Yes	String	Unique merchant transaction number. Recommended format: `YYYYMMDDHHMMSS` followed by a random suffix.
`amount`	Yes	String	Payout amount in MXN. Decimal values are not supported.
`bankCode`	Yes	String	Recipient bank code. See the Mexico bank list.
`accountType`	Yes	String	Recipient account type. Supported values: `DebitCard` and `CLABE`.
`bankNumber`	Yes	String	Recipient debit card or CLABE number. The required length depends on `accountType`.
`name`	Yes	String	Recipient's full name, up to 64 characters.
`mobile`	No	String	Recipient's mobile phone number.
`email`	No	String	Recipient's email address.
`identity`	No	String	Recipient's identification number.
`notifyUrl`	Yes	String	URL that receives asynchronous transaction status notifications.
`message`	No	String	Merchant-defined message associated with the payout.
`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_00000001",
  "amount": "200",
  "bankCode": "BANXICO",
  "accountType": "DebitCard",
  "bankNumber": "1234567890123456",
  "name": "kevin zhang",
  "mobile": "18956325478",
  "email": "kevin_zhang@163.com",
  "identity": "58452586558",
  "notifyUrl": "https://google.com",
  "message": "test",
  "timestamp": "1728611780130",
  "sign": "b39f64dc1586867b1966a569ba06e3a2"
}

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.

Response Example¶

{
    "code": "0000",
    "msg": "success",
    "success": true,
    "timestamp": 1728611805322,
    "data": {
        "tradeNo": "test_111",
        "platFormTradeNo": "2tjba3vz6wm6hx3l",
        "status": "0015",
        "message": "Paying"
    }
}