Skip to content

API Deposit (For VA)

Tip

  • All requests are Post requests, and the data format is json
Brief Description

Use this API to initiate a VA deposit transaction and return payment information.

Request URL
  • /v1/vexora/deposits
Request Method
  • Method: POST
  • Content-Type: application/json
header Required Type Description
merchantNo Yes String Merchant number assigned by Vexora. This value must be submitted in the request header.
Body
Parameter Required Type Description
sign Yes String Request signature. Sort all non-empty request body parameters except sign by parameter name in ascending alphabetical order, concatenate them as key1=value1key2=value2, append the app secret, and generate a lowercase MD5 hash.
timestamp Yes String Request timestamp in milliseconds, for example 1715941383720.
userId Yes String Merchant-side payer identifier. This value is used to associate the payer with the returned VA information.
tradeNo Yes String Merchant deposit order number. This value must be unique for each request. Recommended format: yyyyMMddHHmmss plus random digits.
amount Yes String Deposit amount. Integer only, unit: JPY.
mobile Yes String Payer's actual mobile number. Use an 11-digit Japanese mobile number starting with 0, without country code, for example 09012345678. The submitted payer information must match the actual payer information.
email Yes String Payer's email address.
firstname Yes String Payer's legal first name. The submitted payer information must match the actual payer information.
lastname Yes String Payer's legal last name. The submitted payer information must match the actual payer information.
channelCode Yes String Payment channel code. For VA deposits, use NET_BANKING.
wayCode Yes String Payment method code. For VA deposits, use VA. Refer to the Deposit WayCode appendix.
ipAddress Yes String Payer's real client IP address. Each IP can initiate up to 10 transactions per day, with a maximum of 3 successful transactions.
notifyUrl Yes String HTTPS URL used to receive asynchronous deposit status notifications.
remark No String Merchant remark. This value is returned unchanged in API responses and webhook notifications when available.
Request Parameter Example
{
  "timestamp": "1732988442913",
  "userId": "jp_payer_123456",
  "tradeNo": "dp1732988442913",
  "amount": "10000",
  "mobile": "09012345678",
  "email": "taro.yamada@example.com",
  "firstname": "Taro",
  "lastname": "Yamada",
  "channelCode": "NET_BANKING",
  "wayCode": "VA",
  "ipAddress": "203.0.113.10",
  "notifyUrl": "https://merchant.example.com/api/vexora/deposit/notify",
  "remark": "deposit-10001",
  "sign": "363b4674a1c1772e8a50295dc19d6727"
}
Response Result
Parameter Required Type Description
msg Yes String Request message. A value such as success only indicates that the API request was accepted, not the final deposit result.
code Yes String API request status code. 0000 means the request was processed successfully by the API layer. The final transaction result must be determined by data.status.
timestamp Yes String Response timestamp in milliseconds.
success Yes Boolean API request result. This field indicates whether the API request succeeded, not whether the deposit has completed successfully.
data Yes Object Deposit response object.
data.tradeNo Yes String Merchant deposit order number submitted in the request.
data.platFormTradeNo Yes String Vexora platform transaction number. This value is unique in the Vexora system.
data.status Yes String Deposit status. Use this field for transaction state handling. 0000 means successful, 0001 means partially paid, 0015 means processing, and other status values should be handled according to the response code table.
data.message Yes String Status description or error message returned by the platform.
data.payInfo Yes Object Payment instruction object returned for the payer.
data.payInfo.userId Yes String Merchant-side payer identifier associated with the VA information.
data.payInfo.virtualNumber Yes String Virtual account number for the payer to transfer funds to.
data.payInfo.bankName Yes String Beneficiary bank name for the virtual account.
data.payInfo.branchName Yes String Beneficiary branch name for the virtual account.
data.remark No String Merchant remark returned unchanged when provided in the request.
Successful Response Example
{
    "msg": "success",
    "code": "0000",
    "timestamp": 1732988443500,
    "success": true,
    "data": {
        "tradeNo": "dp1732988442913",
        "platFormTradeNo": "c167o1itir0fypid",
        "status": "0015",
        "message": "Paying",
        "payInfo": {
            "userId": "jp_payer_123456",
            "virtualNumber": "199109764457252454",
            "bankName": "秋田銀行",
            "branchName": "渋谷支店"
        },
        "remark": "deposit-10001"
    }
}