GET - इनवॉइस प्राप्त करें

trans_id द्वारा इनवॉइस की वर्तमान स्थिति और विवरण प्राप्त करें। भुगतान स्थिति, राशि, टोकन/नेटवर्क जानकारी (यदि चयनित), और लेनदेन विवरण (यदि पूर्ण) लौटाता है। केवल API Key से जुड़े स्टोर के इनवॉइस लौटाता है।

Endpoint

GET https://api.payerscan.com/invoice/:trans_id

उदाहरण: GET https://api.payerscan.com/invoice/TID-ABC123DEF4567890

Headers

Header	आवश्यक	विवरण
x-api-key	हाँ	स्टोर की API Key

Response

सफल (HTTP 200)

मूल response (हमेशा शामिल):

{
  "status": "success",
  "data": {
    "trans_id": "TID-ABC123DEF4567890",
    "request_id": "ORDER_123456",
    "status": "waiting",
    "amount": "100",
    "name": "Top-up balance",
    "description": "Top-up the balance for username: JohnDoe",
    "created_at": 1738742400,
    "expires_at": 1738746000
  }
}

जब ग्राहक चेकआउट पेज पर टोकन/नेटवर्क चुनता है, data में अतिरिक्त फ़ील्ड शामिल होते हैं:

{
  "token_symbol": "USDT",
  "network_symbol": "BSC",
  "token_amount": "100.0026",
  "token_price": "1",
  "to_address": "0xc221460115e2CfCa5bF089A7e647b11cb9631efE"
}

जब status = "completed", data में अतिरिक्त फ़ील्ड शामिल होते हैं:

{
  "transaction_hash": "0xd346b32b83b35376d42a2464598fbf565fffb39e...",
  "from_address": "0x8894e0a0c962cb723c1976a4421c95949be2d4e3",
  "fee_amount": "0.2",
  "callback_status": "success"
}

फ़ील्ड विवरण

फ़ील्ड	विवरण
trans_id	अद्वितीय इनवॉइस कोड।
request_id	आपका ऑर्डर ID (यदि बनाते समय दिया गया)।
status	waiting | processing | completed | expired।
amount	USD राशि (string)।
name	इनवॉइस का नाम/शीर्षक (यदि बनाते समय दिया गया)।
description	इनवॉइस का विवरण (यदि बनाते समय दिया गया)।
created_at	निर्माण समय (Unix timestamp, सेकंड)।
expires_at	समाप्ति समय (Unix timestamp, सेकंड)।
token_symbol	चयनित टोकन (जैसे USDT, BNB)। केवल ग्राहक चयन के बाद।
network_symbol	नेटवर्क (जैसे BSC, TRC20, ETH, BINANCE_PAY)। केवल ग्राहक चयन के बाद।
token_amount	ट्रांसफर करने के लिए क्रिप्टो राशि। केवल ग्राहक चयन के बाद।
token_price	चयन के समय विनिमय दर। केवल ग्राहक चयन के बाद।
to_address	प्राप्तकर्ता वॉलेट पता। केवल ग्राहक चयन के बाद।
transaction_hash	ब्लॉकचेन ट्रांज़ैक्शन हैश। केवल जब status = "completed"।
from_address	प्रेषक का वॉलेट पता। केवल जब status = "completed"।
fee_amount	कटौती शुल्क (USD)। केवल जब status = "completed"।
callback_status	Webhook डिलीवरी स्थिति: success | failed | null। केवल जब status = "completed"।

त्रुटियां (4xx / 5xx)

HTTP	error_code	विवरण
400	MISSING_TRANS_ID	URL में trans_id गायब है।
400	INVALID_TRANS_ID_FORMAT	trans_id प्रारूप अमान्य है। अपेक्षित: TID-XXXXXXXXXXXXXXXX (16 अपरकेस अल्फ़ान्यूमेरिक अक्षर)। details में trans_id और expected_format है।
401	MISSING_API_KEY	कोई x-api-key header प्रदान नहीं किया गया।
401	INVALID_API_KEY	API key अमान्य है या मौजूद नहीं है।
403	ACCOUNT_INACTIVE	इस API key से जुड़ा खाता अक्षम है।
403	STORE_INACTIVE	इस API key से जुड़ा स्टोर अक्षम है।
404	INVOICE_NOT_FOUND	इनवॉइस नहीं मिला या इस स्टोर की API Key से संबंधित नहीं है। details.trans_id में भेजा गया मान है।
429	RATE_LIMIT_EXCEEDED	अनुरोध सीमा पार।
500	INTERNAL_ERROR	सर्वर त्रुटि।

त्रुटि body प्रारूप:

{
  "status": "error",
  "message": "Invoice not found.",
  "error_code": "INVOICE_NOT_FOUND",
  "details": { "trans_id": "TID-ABC123DEF4567890" }
}

Rate Limit

• Burst: 20 अनुरोध/सेकंड (प्रति API Key या IP)।
• Sustained: 200 अनुरोध/मिनट (प्रति API Key या IP)।

उपयोग के मामले

• Polling: UI स्थिति अपडेट करने के लिए समय-समय पर GET https://api.payerscan.com/invoice/:trans_id कॉल करें (जब webhook प्राथमिक स्रोत के रूप में उपयोग न कर रहे हों)।
• सामंजस्य: ईमेल, टिकट आदि से trans_id द्वारा इनवॉइस खोजें।
• स्थिति प्रदर्शन पेज: ग्राहक भुगतान के बाद, इस API से जानकारी प्रदर्शित करें।