Skip to content

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
Request URL
  • /v1/vexora/disbursements
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.
Request Body Parameters
Parameter name 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.
subMerchantNo No String Terminal merchant number. Please consult your operations personnel and submit terminal merchant information to obtain it.
tradeNo Yes String Merchant disbursement order number. This value must be unique for each request. Recommended format: yyyyMMddHHmmss plus random digits.
amount Yes String Disbursement amount. Integer only, unit: JPY. Minimum amount: 100.
bankCode Yes String Beneficiary bank code. Refer to the Disbursement Bank Codes appendix.
branchCode Yes String Beneficiary bank branch code used in the Japanese financial system. Fixed 3-digit numeric code, range: 001 - 999. If fewer than 3 digits, pad with leading zeros, for example 1 should be submitted as 001. Examples: 150, 002, 001.
branchName Yes String Official Japanese name of the beneficiary bank branch. Use Japanese characters such as Kanji, Hiragana, or Katakana. English letters or numbers are not recommended. This value must accurately match branchCode. Examples: 名古屋営業部, 東京営業部, 本店.
bankNumber Yes String Beneficiary bank account number.
userId Yes String Merchant-side beneficiary identifier.
mobile Yes String Beneficiary's actual mobile number. Use an 11-digit Japanese mobile number starting with 0, without country code, for example 09123456789.
email Yes String Beneficiary's email address.
username Yes String Beneficiary's actual name. Submit in Katakana. Note: The mobile number and beneficiary information in the request must match the actual beneficiary information.
notifyUrl Yes String HTTPS URL used to receive asynchronous disbursement status notifications.
remark No String Merchant remark. This value is returned unchanged in API responses and webhook notifications when available.
Request Parameter Example
{
  "amount": "100",
  "bankCode": "0004",
  "branchCode": "001",
  "branchName": "本店",
  "bankNumber": "3560123456789012",
  "userId": "jp_user_123456",
  "mobile": "09123456789",
  "email": "taro.yamada@example.com",
  "username": "ヤマダ タロウ",
  "tradeNo": "tn1740632538919",
  "notifyUrl": "https://merchant.example.com/api/vexora/disbursement/notify",
  "remark": "withdrawal-10001",
  "sign": "1e0131318d1834890807a48e17929ec0",
  "timestamp": "1740632538919"
}
Response Results
Parameter name Required Type Description
msg Yes String Request message. A value such as success only indicates that the API request was accepted, not the final disbursement 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 disbursement has completed successfully.
data Yes Object Disbursement response object.
data.tradeNo Yes String Merchant disbursement 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 Disbursement status. Use this field for transaction state handling. 0000 means successful, 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.remark No String Merchant remark returned unchanged when provided in the request.
Successful Response Example
{
    "msg": "success",
    "code": "0000",
    "timestamp": 1740632539408,
    "success": true,
    "data": {
        "tradeNo": "tn1740632538919",
        "platFormTradeNo": "b4z0uwlq2ci8quf0",
        "status": "0015",
        "message": "Paying",
        "remark": "withdrawal-10001"
    }
}