Direct Deposit¶

Tip

All requests use POST
Content type is application/json

Brief Description¶

Use this API to create a Tanzania deposit order and obtain the payment instructions required for the payer to complete the transfer.

Payment Methods¶

channelCode	wayCode
EWALLET	YAS
EWALLET	VODACOM
EWALLET	HALOTEL
EWALLET	AIRTEL

Request URL¶

/v1/vexora/deposits

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 final `sign` must be lowercase.
timestamp	Yes	String	Timestamp (for example `1715941383720`)
tradeNo	Yes	String	Unique transaction number (recommended format: `yyyymmddhhmmss` + random number)
amount	Yes	String	Transaction amount (integers only, unit: TZS)
name	Yes	String	Payer's full name
mobile	Yes	String	Payer's actual 10-digit mobile number, including the leading `0` and excluding the country code (for example, `0741234567`).
email	Yes	String	Payer's email address
channelCode	Yes	String	Payment product code. Use `EWALLET` for mobile money deposits.
wayCode	Yes	String	Payment route code. Supported values: `YAS`, `VODACOM`, `HALOTEL`, `AIRTEL`
notifyUrl	Yes	String	Asynchronous callback URL
remark	Yes	String	Remarks (this field will be returned as-is)

Request Body Example¶

{
  "sign": "a8f5f167f44f4964e6c998dee827110c",
  "timestamp": "1719876543210",
  "tradeNo": "VX20260331000125",
  "amount": "300",
  "name": "Ahmed Hassan",
  "mobile": "0741234567",
  "email": "ahmed.hassan@example.com",
  "channelCode": "EWALLET",
  "wayCode": "YAS",
  "notifyUrl": "https://merchant-api.com/vexora/payment/notify",
  "remark": "order_vx_000125"
}

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	Boolean	Transaction result
data	Yes	Object	Response object
data.tradeNo	Yes	String	Merchant transaction number
data.platFormTradeNo	Yes	String	Unique platform transaction number
data.status	Yes	String	Transaction result status. Merchants should continue follow-up processing based on this value.
data.message	Yes	String	Error description
data.remark	Yes	String	Merchant remark returned as submitted

Successful Response Example¶

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1728609277476,
  "success": true,
  "data": {
    "tradeNo": "VX20260331000125",
    "platFormTradeNo": "gh7o1itir0fypid9",
    "status": "0015",
    "message": "Paying",
    "remark": "order_vx_000125"
  }
}