curl --request POST \
--url https://api.tradevu.co/v1/api/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "500",
"narration": "Vendor payment",
"sessionId": "payout-9931",
"rateKey": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"address": "<string>",
"network": "<string>",
"fromNetwork": "<string>",
"toNetwork": "<string>",
"transitNumber": "<string>",
"institutionNumber": "<string>",
"sortCode": "<string>",
"swiftCode": "<string>",
"recipientName": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/payout"
payload = {
"amount": "500",
"narration": "Vendor payment",
"sessionId": "payout-9931",
"rateKey": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"address": "<string>",
"network": "<string>",
"fromNetwork": "<string>",
"toNetwork": "<string>",
"transitNumber": "<string>",
"institutionNumber": "<string>",
"sortCode": "<string>",
"swiftCode": "<string>",
"recipientName": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '500',
narration: 'Vendor payment',
sessionId: 'payout-9931',
rateKey: '<string>',
accountNumber: '<string>',
accountName: '<string>',
bankName: '<string>',
bankCode: '<string>',
address: '<string>',
network: '<string>',
fromNetwork: '<string>',
toNetwork: '<string>',
transitNumber: '<string>',
institutionNumber: '<string>',
sortCode: '<string>',
swiftCode: '<string>',
recipientName: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tradevu.co/v1/api/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '500',
'narration' => 'Vendor payment',
'sessionId' => 'payout-9931',
'rateKey' => '<string>',
'accountNumber' => '<string>',
'accountName' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'address' => '<string>',
'network' => '<string>',
'fromNetwork' => '<string>',
'toNetwork' => '<string>',
'transitNumber' => '<string>',
'institutionNumber' => '<string>',
'sortCode' => '<string>',
'swiftCode' => '<string>',
'recipientName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tradevu.co/v1/api/payout"
payload := strings.NewReader("{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tradevu.co/v1/api/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Payout successful",
"sessionId": "payout-9931"
}{
"statusCode": 400,
"message": "Invalid currency: XYZ",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/api/balance/XYZ",
"request": {
"method": "GET",
"url": "/v1/api/balance/XYZ"
}
}Send a payout
Routes to a same-currency, cross-currency, or crypto payout based on fromCurrency/toCurrency. See the Payouts guide for the full field matrix per destination type.
curl --request POST \
--url https://api.tradevu.co/v1/api/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "500",
"narration": "Vendor payment",
"sessionId": "payout-9931",
"rateKey": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"address": "<string>",
"network": "<string>",
"fromNetwork": "<string>",
"toNetwork": "<string>",
"transitNumber": "<string>",
"institutionNumber": "<string>",
"sortCode": "<string>",
"swiftCode": "<string>",
"recipientName": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/payout"
payload = {
"amount": "500",
"narration": "Vendor payment",
"sessionId": "payout-9931",
"rateKey": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"address": "<string>",
"network": "<string>",
"fromNetwork": "<string>",
"toNetwork": "<string>",
"transitNumber": "<string>",
"institutionNumber": "<string>",
"sortCode": "<string>",
"swiftCode": "<string>",
"recipientName": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '500',
narration: 'Vendor payment',
sessionId: 'payout-9931',
rateKey: '<string>',
accountNumber: '<string>',
accountName: '<string>',
bankName: '<string>',
bankCode: '<string>',
address: '<string>',
network: '<string>',
fromNetwork: '<string>',
toNetwork: '<string>',
transitNumber: '<string>',
institutionNumber: '<string>',
sortCode: '<string>',
swiftCode: '<string>',
recipientName: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tradevu.co/v1/api/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '500',
'narration' => 'Vendor payment',
'sessionId' => 'payout-9931',
'rateKey' => '<string>',
'accountNumber' => '<string>',
'accountName' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'address' => '<string>',
'network' => '<string>',
'fromNetwork' => '<string>',
'toNetwork' => '<string>',
'transitNumber' => '<string>',
'institutionNumber' => '<string>',
'sortCode' => '<string>',
'swiftCode' => '<string>',
'recipientName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tradevu.co/v1/api/payout"
payload := strings.NewReader("{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tradevu.co/v1/api/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"500\",\n \"narration\": \"Vendor payment\",\n \"sessionId\": \"payout-9931\",\n \"rateKey\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"fromNetwork\": \"<string>\",\n \"toNetwork\": \"<string>\",\n \"transitNumber\": \"<string>\",\n \"institutionNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"swiftCode\": \"<string>\",\n \"recipientName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Payout successful",
"sessionId": "payout-9931"
}{
"statusCode": 400,
"message": "Invalid currency: XYZ",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/api/balance/XYZ",
"request": {
"method": "GET",
"url": "/v1/api/balance/XYZ"
}
}Authorizations
Your business API key, generated from the dashboard. Required on every business-facing endpoint.
Body
"500"
Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.
NGN, EUR, GBP, USD, USDT, USDC, KES, UGX, GHS, CAD, XOF, XAF Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.
NGN, EUR, GBP, USD, USDT, USDC, KES, UGX, GHS, CAD, XOF, XAF "Vendor payment"
A unique ID you generate for this payout attempt.
"payout-9931"
Required whenever fromCurrency differs from toCurrency.
Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).
Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).
Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).
Required when toCurrency is NGN, KES, or UGX.
Wallet address. Required when toCurrency is crypto (USDT/USDC).
Network for a same-currency crypto payout.
Source network for crypto-to-crypto or crypto-to-fiat payouts.
Destination network for crypto-to-crypto payouts.
Required when toCurrency is CAD.
Required when toCurrency is CAD.
Required when toCurrency is GBP.
Required when toCurrency is EUR or GBP.