Skip to content
ZytePedevelopersDashboard
DocsAccept payments
Accept payments

Public checkout reads

Read link metadata and checkout status without exposing merchant credentials.

Public payment link status accepts the returned short_id in the path. Its example includes status, transaction_id, usage counters and is_active. No merchant HMAC or dashboard authorization is documented.

Checkout link details returns the documented narrow metadata: ID, short ID, title, amount, currency and link status. Customers should still use the checkout_url supplied when creating the intent.

Keep credentials private

Do not attach merchant secrets to these customer-facing reads. GET requests have no body. Numeric rate limits and a full public-field schema are not established by the supplied contract.

Keep backend records authoritative

Use callbacks for asynchronous transaction updates and signed transaction status for recovery. Do not mark an order paid from a browser redirect alone.

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/intents/${encodeURIComponent(short_id)}/status`;
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,
  "message": "Payment link status retrieved.",
  "data": {
    "status": "SUCCESS",
    "short_id": "s0oJRkuT6OY",
    "transaction_id": "ca9a58aa-d578-4fc2-a9f4-fb8d090d4b5f",
    "current_usage_count": 1,
    "usage_limit": 1,
    "is_active": false
  }
}