Skip to content
ZytePedevelopersDashboard
DocsAPI reference
API reference

List Payees

Fetches payees already stored for the merchant backend.

GET/api/v1/payees/external/listMerchant HMAC
Use your enabled merchant account. Examples run on your server, never in this documentation.

Authentication

Use merchant HMAC headers and sign the exact path, query and raw body.

See authentication.

Workflow notes

  • Use this to map your own beneficiary identifiers to ZytePe payee ids before a payout call. Path/query rule: The portion after ? is a query string, not part of the URL path. When generating OpenAPI, represent limit and offset as query parameters.

Before you send

Check the field labels and use your enabled merchant account. Examples illustrate the API contract; confirm deployment-specific limits and error handling before launch. This page never sends a request.

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.

import { signedHeaders } from './signing.mjs';
const path = `/api/v1/payees/external/list`;
const query = 'limit=50&offset=0';
const body = ''; // GET requests have no body
const headers = signedHeaders({
  method: 'GET', path, query, 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.

Path, query and headers

limitOptionalquery

Optional pagination value. Defaults to 50; supported range 1–200.

offsetOptionalquery

Optional pagination value. Defaults to 0; must be non-negative.

Request body

No request body for GET.

Example response

JSON · response
{
  "success": true,
  "data": {
    "payees": [
      {
        "id": "d965aa45-1952-4749-aa52-2bed21470ffd",
        "legal_name": "Aditi Traders",
        "email_address": "ops@example.com",
        "phone_number": "9876543210",
        "bank_account_no": "123456789012",
        "routing_id": "HDFC0001234",
        "vpa_address": "aditi.traders@okhdfcbank",
        "status": "active",
        "compliance_status": "verified",
        "created_at": "2026-05-03T10:30:00Z"
      }
    ],
    "total_count": 1
  }
}