Skip to content
ZytePedevelopersDashboard
DocsAPI reference
API reference

Verify Payee UPI ID

Verifies a saved UPI payee before a UPI payout.

POST/api/v1/payees/external/{payee_id}/verify/vpaMerchant 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

  • Required when the payout method is UPI.

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 payee_id = process.env.ZYTEPE_PAYEE_ID;
if (!payee_id) throw new Error('Set ZYTEPE_PAYEE_ID to the returned identifier');
const path = `/api/v1/payees/external/${encodeURIComponent(payee_id)}/verify/vpa`;
const query = '';
const payload = {};
const body = JSON.stringify(payload);
const headers = signedHeaders({
  method: 'POST', path, query, body,
  keyId: process.env.ZYTEPE_API_KEY_ID,
  secret: process.env.ZYTEPE_API_SECRET,
});
headers['Content-Type'] = 'application/json';
const url = 'https://api.zytepe.com' + path + (query ? '?' + query : '');
const response = await fetch(url, { method: 'POST', headers, body });
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

payee_idRequiredpath

Use the identifier returned by the corresponding creation operation.

Request body

JSON · request.json
{}

Example response

JSON · response
{
  "success": true,
  "message": "UPI payee verification processed.",
  "data": {
    "status": "verified",
    "name_at_vpa": "Aditi Traders",
    "vpa": "aditi.traders@okhdfcbank"
  }
}