Payout

POST

api/v2/payout



API Error Code

Status code Description
10002 Invalid Bank Code.


Parameters that need to be pass for the request.

Parameters Type Required Description
client_transaction string yes Client transaction ID
project_id string yes Project ID
currency_code string yes currency_code can get from Currency List
amount decimal yes Payout amount
bank_code string no Required if payout by bank type. Bank Code details view Payout Bank List
bank_account_name string no Required if payout by bank type. User bank account name
bank_account_number string no Required if payout by bank type. User bank account number
wallet_network_id String No Required if payout by crypto type. wallet_network_id can get from Wallet Network
wallet_address string no Required if payout by crypto type. User wallet address
remark string no Remark
callback_url string no Callback URL
redirect_url string no Redirect URL
token string yes Token details view Encryption & Decryption


Parameters

  • client_transaction: 20221007001 (string, required) - Client transaction ID
  • project_id: GAT62f22822858df (string, required) - Project ID
  • currency_code: USDT (string, required) - Payout currency code
  • amount: 100 (string, required) - Payout amount
  • bank_code: null (string, optional) - Bank code
  • bank_account_name: null (string, optional) - Bank account name
  • bank_account_number: null (string, optional) - Bank account number
  • wallet_network_id: WN62427228725da (string, optional) - Wallet network id
  • wallet_address: XXXXXXXXXXXXXXXXXXXXXXXXX (string, optional) - Wallet address
  • remark: Testing remark (string, optional) - Remark
  • callback_url: null (string, optional) - Callback URL
  • redirect_url: null (string, optional) - Redirect URL
  • token: 92370335D0E4258C8CAF758FBECB8569 (string, required) - Token


Response 200 (application/json)

  
            {
                "status": 0,
                "ret_msg": "Success",
                "data": [
                    "transaction_id": "XXXXXX",
                    "client_transaction_id": "20221007001",
                    "token": "259680784193BA14739EBABE0B683AEE",
                ]
            }

Callback for payout


    {
        "return_type" => "status-response",
        "type" => "payout",
        "transaction_id" => "PY2021104000001",
        "amount" => "1000",
        "client_transaction" => "testing",
        "currency" => 'VND',
        "return_status" => "approve",
        "remark" => 'test remark',
        "created_at" => '2021-05-05 21:21:21',
        "token": "259680784193BA14739EBABE0B683AEE",
    }

Transaction is approved

return_status : "approve"

Transaction is rejected

return_status : "reject"

Requirement response by merchant


        {
            "status" : "successful"
        }

If didn't get this message, then it will failed, VNPAY only send 3 time for a single callback.