Merchant balances
Read the balances returned for the signed merchant account.
Read account balances
Merchant balance uses plugin authentication. The merchant is resolved from the signed API key; do not send merchant_id or a GET body.
Preserve returned fields
The example contains available_balance, locked_balance, collection_balance, collection_locked_balance, payout_deposit_balance, payout_deposit_locked_balance, pending_settlements and currency.
These labels do not establish a funds-custody model or a settlement guarantee. Confirm definitions, funding permissions and how locked amounts are handled for your account before using them in financial calculations.
Keep balances private
Expose only the information your authorized users need. Do not put merchant balances or signed API credentials into public client-side pages.
Request example
Choose Node.js, Python, PHP, Ruby, Java or cURL. Run signed requests on your backend. PHP, Ruby and Java include signing directly. Java requires JDK 17 or newer.
Signing helpers: Node.js · Python. cURL shows the request shape; generate its signature first.
import { pluginSignedHeaders } from './plugin-signing.mjs';
const path = `/payments/balance`;
const query = '';
const body = ''; // GET requests have no body
const headers = pluginSignedHeaders({
method: 'GET', path, body,
keyId: process.env.ZYTEPE_API_KEY_ID,
secret: process.env.ZYTEPE_API_SECRET,
});
const url = 'https://api.zytepe.com' + path + (query ? '?' + query : '');
const response = await fetch(url, { method: 'GET', headers });
if (!response.ok) throw new Error('Request failed: HTTP ' + response.status);
const result = await response.json();
// Store the returned identifiers securely. Do not log customer data.import json, os
from urllib.parse import quote
from urllib.request import Request, urlopen
from zytepe_signing import plugin_signed_headers
path = f'/payments/balance'
query = ''
body = '' # GET requests have no body
headers = plugin_signed_headers(
method='GET', path=path, body=body,
key_id=os.environ['ZYTEPE_API_KEY_ID'],
secret=os.environ['ZYTEPE_API_SECRET'],
)
url = 'https://api.zytepe.com' + path + ('?' + query if query else '')
request = Request(url, method='GET', headers=headers)
with urlopen(request, timeout=30) as response:
result = json.load(response)
# Store identifiers securely; handle HTTPError/URLError in your application.<?php
// PHP 8+ with the cURL extension. Run on your server.
function envRequired(string $name): string {
$value = getenv($name);
if ($value === false || $value === '') throw new RuntimeException('Set ' . $name);
return $value;
}
$path = '/payments/balance';
$query = '';
$body = ''; // No body for GET
$headers = [];
$key = envRequired('ZYTEPE_API_KEY_ID');
$secret = envRequired('ZYTEPE_API_SECRET');
$timestamp = (string) time();
$canonical = $timestamp . '.GET.' . $path . '.' . $body;
$signature = hash_hmac('sha256', $canonical, $secret);
$headers = ["X-ZytePe-Api-Key: $key", "X-ZytePe-Timestamp: $timestamp", "X-ZytePe-Signature: $signature"];
$url = 'https://api.zytepe.com' . $path . ($query !== '' ? '?' . $query : '');
$ch = curl_init($url);
curl_setopt_array($ch, [CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => $headers,
CURLOPT_TIMEOUT => 30]);
$response = curl_exec($ch);
if ($response === false) throw new RuntimeException(curl_error($ch));
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) throw new RuntimeException('HTTP ' . $status);
$result = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
// Store returned identifiers securely. Recover uncertain payments before retrying.require 'net/http'
require 'uri'
require 'json'
require 'openssl'
require 'securerandom'
path = '/payments/balance'
query = ''
body = '' # No body for GET
headers = {}
key = ENV.fetch('ZYTEPE_API_KEY_ID')
secret = ENV.fetch('ZYTEPE_API_SECRET')
timestamp = Time.now.to_i.to_s
canonical = [timestamp, 'GET', path, body].join('.')
signature = OpenSSL::HMAC.hexdigest('SHA256', secret, canonical)
headers = { 'X-ZytePe-Api-Key' => key, 'X-ZytePe-Timestamp' => timestamp,
'X-ZytePe-Signature' => signature }
uri = URI('https://api.zytepe.com' + path + (query.empty? ? '' : '?' + query))
request = Net::HTTP::Get.new(uri, headers)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, open_timeout: 10, read_timeout: 30) do |http|
http.request(request)
end
raise 'HTTP ' + response.code unless response.is_a?(Net::HTTPSuccess)
result = JSON.parse(response.body)
# Store returned identifiers securely. Recover uncertain payments before retrying.// Java 17+. Save as ZytePeExample.java and run on your server.
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.*;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.time.Instant;
import java.security.MessageDigest;
import java.util.HexFormat;
import java.util.UUID;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
public class ZytePeExample {
private static String env(String name) {
String value = System.getenv(name);
if (value == null || value.isBlank()) throw new IllegalArgumentException("Set " + name);
return value;
}
public static void main(String[] args) throws Exception {
String path = "/payments/balance";
String query = "";
String body = ""; // GET requests have no body
var request = HttpRequest.newBuilder(URI.create(
"https://api.zytepe.com" + path + (query.isEmpty() ? "" : "?" + query)))
.timeout(Duration.ofSeconds(30));
String key = env("ZYTEPE_API_KEY_ID");
String secret = env("ZYTEPE_API_SECRET");
String timestamp = Long.toString(Instant.now().getEpochSecond());
String canonical = timestamp + ".GET." + path + "." + body;
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
String signature = HexFormat.of().formatHex(mac.doFinal(canonical.getBytes(StandardCharsets.UTF_8)));
request.header("X-ZytePe-Api-Key", key).header("X-ZytePe-Timestamp", timestamp)
.header("X-ZytePe-Signature", signature);
request.method("GET", HttpRequest.BodyPublishers.noBody());
var client = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(10)).build();
var response = client.send(request.build(), HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
if (response.statusCode() < 200 || response.statusCode() >= 300)
throw new IllegalStateException("HTTP " + response.statusCode());
String result = response.body(); // Parse JSON using your application's JSON library.
// Store identifiers securely. Recover uncertain payments before retrying.
}
}curl --request GET \
--url 'https://api.zytepe.com/payments/balance' \
--header 'X-ZytePe-Api-Key: <key-id>' \
--header 'X-ZytePe-Timestamp: <unix-seconds>' \
--header 'X-ZytePe-Signature: <signature>'Request body
No request body for GET.
Example response
{
"account_id": "merchant-account-uuid",
"available_balance": 1000,
"locked_balance": 100,
"collection_balance": 5000,
"collection_locked_balance": 500,
"payout_deposit_balance": 2000,
"payout_deposit_locked_balance": 200,
"pending_settlements": 500,
"currency": "INR"
}