Wallet Balance
curl --request GET \
--url https://api.payvessel.com/pms/api/external/request/wallet/balance/ \
--header 'api-key: <api-key>' \
--header 'api-secret: <api-secret>'import requests
url = "https://api.payvessel.com/pms/api/external/request/wallet/balance/"
headers = {
"api-key": "<api-key>",
"api-secret": "<api-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>', 'api-secret': '<api-secret>'}};
fetch('https://api.payvessel.com/pms/api/external/request/wallet/balance/', 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.payvessel.com/pms/api/external/request/wallet/balance/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>",
"api-secret: <api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.payvessel.com/pms/api/external/request/wallet/balance/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("api-secret", "<api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payvessel.com/pms/api/external/request/wallet/balance/")
.header("api-key", "<api-key>")
.header("api-secret", "<api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payvessel.com/pms/api/external/request/wallet/balance/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
request["api-secret"] = '<api-secret>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "<string>",
"data": {
"available_balance": "<string>",
"ledger_balance": "<string>",
"currency": "<string>"
}
}Wallets
Wallet Balance
Retrieve the current balance for a managed wallet
GET
/
pms
/
api
/
external
/
request
/
wallet
/
balance
/
Wallet Balance
curl --request GET \
--url https://api.payvessel.com/pms/api/external/request/wallet/balance/ \
--header 'api-key: <api-key>' \
--header 'api-secret: <api-secret>'import requests
url = "https://api.payvessel.com/pms/api/external/request/wallet/balance/"
headers = {
"api-key": "<api-key>",
"api-secret": "<api-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>', 'api-secret': '<api-secret>'}};
fetch('https://api.payvessel.com/pms/api/external/request/wallet/balance/', 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.payvessel.com/pms/api/external/request/wallet/balance/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>",
"api-secret: <api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.payvessel.com/pms/api/external/request/wallet/balance/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("api-secret", "<api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payvessel.com/pms/api/external/request/wallet/balance/")
.header("api-key", "<api-key>")
.header("api-secret", "<api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payvessel.com/pms/api/external/request/wallet/balance/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
request["api-secret"] = '<api-secret>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "<string>",
"data": {
"available_balance": "<string>",
"ledger_balance": "<string>",
"currency": "<string>"
}
}Retrieve the current balance for a managed wallet. Always verify the available balance before initiating transfers to avoid transaction failures.
Endpoint
GET/pms/api/external/request/wallet/balance/
Response
string
Request status -
"success" or "error".string
Description of the result.
object
Example Request
curl -X GET https://api.payvessel.com/pms/api/external/request/wallet/balance/ \
-H "api-key: YOUR_API_KEY" \
-H "api-secret: YOUR_SECRET"
Example Response
{
"status": true,
"message": "string",
"data": {
"available_balance": "1.78",
"ledger_balance": "-9390113420548.59",
"currency": "NGN"
}
}
⌘I
