Support and Debugging Guide

Overview

Every API response from the Jeel Pay platform includes a unique Transaction ID (tx_id) in the response headers. This identifier is essential for debugging and support purposes.

What is the tx_id?

The tx_id is a unique UUID (Universally Unique Identifier) that is generated for every request processed by our system. It serves as a permanent reference to the specific transaction that occurred between your system and ours.

Example tx_id:

tx_id: b7734ba3-d2a0-476d-87fe-9ba49b64ef6c

Why Store the tx_id?

Faster Support Resolution

When you encounter issues or need assistance with API operations, providing the tx_id allows our support team to:

• Instantly locate the exact request in our logs

• Trace the complete request lifecycle through our systems

• Identify any errors, validations, or processing delays

• Provide accurate resolution without requiring extensive back-and-forth communication

Audit Trail

Storing the tx_id creates a permanent audit trail linking your internal records to our processing logs, ensuring you can always verify and reconcile transactions between our systems.

Where to Find the tx_id

The tx_id is included in the HTTP response headers of every API response, regardless of the response status code (success or error).

Example Response Headers

content-length: 109
content-type: application/json;charset=UTF-8
date: Fri, 27 Mar 2026 02:10:27 GMT
tx_id: b7734ba3-d2a0-476d-87fe-9ba49b64ef6c
vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers
...

Implementation Best Practices

1. Extract and Store the tx_id

Always extract the tx_id from the response headers and store it alongside your transaction records.

Example in Java:

import java.net.http.HttpResponse;

HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
String txId = response.headers().firstValue("tx_id").orElse(null);

// Store txId with your transaction record
order.setJeelTxId(txId);
orderRepository.save(order);

Example in Python:

import requests

response = requests.post(url, json=payload, headers=headers)
tx_id = response.headers.get('tx_id')

# Store tx_id with your transaction record
order.jeel_tx_id = tx_id
order.save()

Example in Node.js:

const response = await fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(payload)
});

const txId = response.headers.get('tx_id');

// Store txId with your transaction record
order.jeelTxId = txId;
await order.save();

2. Store Regardless of Response Status

Important: Store the tx_id for both successful and failed requests. Even error responses include a tx_id, which is critical for debugging issues.

3. Include in Error Handling

When logging errors or exceptions, always include the tx_id:

try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
except requests.exceptions.HTTPError as e:
    tx_id = response.headers.get('tx_id')
    logger.error(f"API request failed. tx_id: {tx_id}, Error: {e}")
    # Include tx_id in your error notifications/alerts

4. Expose in Admin Interfaces

Consider displaying the tx_id in your internal admin panels or dashboards. This allows your support team to quickly reference it when communicating with us.

5. Include in Customer Communications

If you're communicating with customers about payment or order issues, include the tx_id in any support tickets you escalate to us.

Using tx_id for Support

When contacting Jeel Pay support about API issues, always provide:

1. The tx_id from the relevant request

2. The timestamp when the request was made

3. The API endpoint that was called

4. A brief description of the issue or expected vs. actual behavior

Example Support Request

Subject: Payment initiation failed for order #12345

tx_id: b7734ba3-d2a0-476d-87fe-9ba49b64ef6c Timestamp: 2026-03-27 02:10:27 UTC Endpoint: POST /v3/checkout Issue: Received HTTP 500 error when attempting to create checkout session. The request included a valid bearer token and proper payload. Please investigate.

Response Codes and tx_id

The tx_id is present in all response types:

Response Type	HTTP Status	tx_id Present
Success	2xx	Yes
Client Error	4xx	Yes
Server Error	5xx	Yes
Redirect	3xx	Yes

FAQ

Q: Is the tx_id unique? A: Yes, each tx_id is a unique UUID generated for every single request.

Q: How long is the tx_id valid for support purposes? A: tx_ids are permanently stored in our logs and can be used for support indefinitely.

Q: What if I don't receive a tx_id? A: If a response doesn't include a tx_id, it likely indicates a network-level issue or the request never reached our servers. In this case, provide the timestamp and endpoint details instead.

Q: Can I use the tx_id to query the API? A: No, the tx_id is for support and debugging purposes only. It cannot be used as a parameter in API calls.

---

By following these practices, you'll enable our support team to assist you faster and more effectively, minimizing downtime and ensuring smooth operations for your business.