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 Type Description

accountType	Description
AHORRO	Savings Account (For Colombia payout wallet account type, use AHORRO)
CORRIENTE	Checking Account

---

ID Type Description

idType	Description
CC	6-10 digits; Citizen ID Card
CE	6-10 digits; Foreigner ID Card
NIT	9 digits; Tax ID
PA	9 digits; Passport

Header

header	required	type	description
merchantNo	Yes	String	No

Request Body Parameters

parameter name	required	type	description
sign	Yes	String	In addition to sign, initialise the remaining fields to form key1=value1key2=value2, use app secrect to do salt for md5 encryption, sign ends up being a lowercase letter
timestamp	Yes	integer	Request timestamp (milliseconds)
tradeNo	Yes	String	uniqueness (suggested year, month, day, hour, minute, second + random number)
amount	Yes	String	Payment Amount (decimal point not supported)
bankCode	Yes	String	Bank Code (Refer to the bank list)
accountType	Yes	String	Account Type (Refer to the account type description)
bankNumber	Yes	String	Recipient's Account Number (Bank card number or wallet account)
name	Yes	String	Recipient's Name
mobile	Yes	String	Recipient's Mobile Number (10 digits, starting with 3)
email	Yes	String	Recipient's Email Address
idType	Yes	String	ID Type (Refer to the ID type description)
idCardNumber	Yes	String	Recipient's ID Number, must match the idType
notifyUrl	Yes	String	asynchronous callback address (not passed as configured in merchant backend)
remark	No	String	Remarks, this field will be brought back in its original form

Example of request parameters

{
    "timestamp": 1750649949476,
    "tradeNo": "XDfKV3nX6sMnDVitqTUIO",
    "amount": "100",
    "name": "Test",
    "bankCode": "0001",
    "accountType": "AHORRO",
    "bankNumber": "09361961511",
    "idType": "CC",
    "idCardNumber": "0122223310",
    "mobile": "1234567890",
    "email": "aaa@gmail.com",
    "notifyUrl": "https://www.google.com/",
    "remark": "Test remark",
    "sign": "2fc96846f313661bd088227ea06bd517"
}

Response Result

parameter name	required	type	description
msg	Yes	String	Request Result (when return success only means this request is successful, can't do merchant side logic judgement)
code	Yes	String	Request Response Code (when return 0000 only means this request is successful, can not do merchant side logic judgement), specific error code, please go to the business error code enumeration view
timestamp	Yes	String	Transaction timestamp
success	Yes	String	transaction result
data	Yes	Object	return object
data.tradeNo	Yes	String	Merchant Trade Number Return
data.platFormTradeNo	Yes	String	Vexora's trade order number, unique
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.desc	Yes	String	Error Description
data.remark	Yes	String	remark

Successful return example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728611805322,
    "success": true,
    "data": {
          "tradeNo": "test_111",
      "platFormTradeNo": "2tjba3vz6wm6hx3l",
      "status": "0015",
      "desc": "CREATED",
        "remark":"test"
    }
}