Skip to content
ZytePedevelopersDashboard
DocsAPI reference
API reference

Checkout Link Details

Loads a saved payment link by short id for dashboard-side review and support workflows.

GET/api/v1/collections/checkout/{short_id}Public read
Use your enabled merchant account. Examples run on your server, never in this documentation.

Authentication

No authorization header is documented. Do not attach merchant credentials.

See authentication.

Workflow notes

  • This public endpoint is used by hosted checkout and support flows to load safe link metadata.
  • Customers should use the hosted checkout URL returned by the create intent call.

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.

const short_id = process.env.ZYTEPE_SHORT_ID;
if (!short_id) throw new Error('Set ZYTEPE_SHORT_ID to the returned identifier');
const path = `/api/v1/collections/checkout/${encodeURIComponent(short_id)}`;
const query = '';
const body = ''; // GET requests have no body
const headers = {};
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

short_idRequiredpath

Use the identifier returned by the corresponding creation operation.

Request body

No request body for GET.

Example response

JSON · response
{
  "success": true,
  "data": {
    "id": "49c2ebf2-f651-473e-ab78-6c154665df92",
    "short_id": "s0oJRkuT6OY",
    "title": "Invoice INV-2042",
    "fixed_amount": "2500.0000",
    "currency": "INR",
    "status": "active"
  }
}