AxtonPay API

सामान्य जानकारी

एपीआई एंडपॉइंट

https://mp.axtonpay.com/api/v1/private/checkout

Content-type

एपीआई 2 सामग्री प्रकारों के साथ HTTP अनुरोध स्वीकार करता है: 'application/x-www-form-urlencoded', 'application/json'।

HTTP हेडर को POST बॉडी की सामग्री के अनुसार फिट होना चाहिए।

संक्षिप्त रूप और परिभाषाएँ

• {PID} - चालान का आईडी, आमतौर पर यह एक अद्वितीय 8-अक्षर अंकीय क्रम होता है।
• Shop - आपकी वेबसाइट जो AxtonPay सेवा के माध्यम से भुगतान स्वीकार करती है

एपीआई के साथ काम करने का एल्गोरिद्म

भुगतान प्राप्त करने के लिए सामान्य क्रियाओं का क्रम:

• एक इनवॉइस बनाएं ('/api/v1/private/checkout/payment/create'), एपीआई प्रतिक्रिया इनवॉइस URL लौटाएगी ('invoice_url'),
• भुगतान करने के लिए खरीदार को इस चालान पर भेजें,
• AxtonPay सर्वर सूचनाओं का इंतजार करें, जो 'server_notification_url' पर आ रही होंगी,
• AxtonPay से किसी भी सूचना प्राप्त होने पर, इसकी हस्ताक्षर की वैधता जांचें और желательно AxtonPay ('/api/v1/private/checkout/payment/confirm/{PID}') को प्राप्ति की पुष्टि भेजें।
• यदि किसी चालान की स्थिति बदलती है, तो इस स्थिति के अनुसार क्रियाएं करें (जैसे, चालान के बारे में पूरी जानकारी का अनुरोध करना, सामान भेजना, सपोर्ट टीम के लिए टिकट बनाना, आदि)।

यदि आप इनवॉइस बनाते समय एक खाली या अमान्य 'server_notification_url' सेट करते हैं, तो सेवा स्थिति परिवर्तनों के बारे में सूचनाएं भेजने में असमर्थ होती है; ऐसे मामलों में, आपको कुछ अंतराल पर खुद इनवॉइस की जाँच करनी चाहिए ('/api/v1/private/checkout/payment/get/{PID}')।

अनुरोधों का प्राधिकरण

किसी अनुरोध को अधिकृत करने के लिए यह आवश्यक है कि किसी विशेष तरीके से बने स्ट्रिंग से एक हैश की गणना की जाए। स्ट्रिंग URL तर्कों (QUERY_STRING) और POST अनुरोध (REQUEST_BODY) के बॉडी को जोड़कर (जोड़कर) बनाई जाती है। यह महत्वपूर्ण है कि सभी घटकों को उसी रूप में लिया जाए जिस रूप में वे सर्वर को भेजे जाएंगे। URL तर्कों (QUERY_STRING) को URL से एक ही लाइन में लेना चाहिए, तर्कों के क्रम को बदले बिना और किसी भी तत्व को हटाए बिना। POST अनुरोध बॉडी (REQUEST_BODY) का भी बिना किसी संशोधन के उपयोग किया जाना चाहिए, जिसमें उद्धरण, स्पेस, कोष्ठक, लाइन ब्रेक हटाना शामिल नहीं है।

खाली POST अनुरोध बॉडी के मामलों में, और खाली URL तर्कों के मामले में, वह घटक बस खाली स्ट्रिंग होगा।

साइनिंग रिक्वेस्ट में डेटा का क्रम: QUERY_STRING सबसे पहले, फिर POST डेटा। आपको उनके बीच कोई कनेक्टिंग साइन नहीं डालना चाहिए, बस दो टेक्स्ट स्ट्रिंग्स को जोड़ दें।

एक बार फिर, हर प्रतीक महत्वपूर्ण है। आपको किसी भी प्रकार का व्हाइटस्पेस या नई पंक्ति का प्रतीक जोड़ना या हटाना नहीं चाहिए। केवल सर्वर द्वारा प्राप्त कच्चे डेटा का उपयोग करें।

परिणामी स्ट्रिंग से कुंजी 'Secret key' के साथ एक SHA-256 हैश लिया जाता है और फ़ंक्शन hash_hmac() के दूसरे तर्क के रूप में उपयोग किया जाता है।

वर्तमान POSIX timestamp (Unix time) सहित 'time' पैरामीटर पास करना अनिवार्य है।

यह सिग्नेचर 24 घंटे के लिए मान्य है। यदि 'time' पैरामीटर का मान वर्तमान सर्वर समय से 24 घंटे से अधिक अंतर रखता है (चाहे आगे हो या पीछे), तो अनुरोध विफल हो जाएगा भले ही सिग्नेचर बिना किसी त्रुटि के गणना किया गया हो।

अगर व्यापारी पैनल ने किसी अनुरोध को किसी हस्ताक्षर के साथ स्वीकार कर लिया है तो उस हस्ताक्षर का फिर से उपयोग नहीं किया जा सकता, यहाँ तक कि वही अनुरोध वही पैरामीटर के साथ भेजने के लिए भी (इसमें पैरामीटर 'time' शामिल है)।

प्राप्त किए गए हैश को HTTP हेडर 'Sign' में भेजा जाता है।

गणना किए गए सिग्नेचर के अलावा, अनुरोध में उपयोग किए गए API कुंजी वाला 'Api-Key' हेडर भी शामिल होना चाहिए। उदाहरण:

$headers = [
      'Api-Key: ' . $the_api_key,
      'Sign: ' . $signature_sha256
    ];

आप इस चेकआउट से संबंधित किसी भी वैध कुंजी के साथ AxtonPay को भेजी गई अनुरोध पर साइन कर सकते हैं। हालांकि AxtonPay हमेशा उस कुंजी का उपयोग करता है जिसे आपने मर्चेंट पैनल में चुना है।

हस्ताक्षर गणना का उदाहरण:

/* 
Imagine there is the POST request:
URI: '/api/v1/private/checkout/payment/create?time=1735084500.3561'
POST body: '[email protected]&shop_payment_id=INVOICE-1746&pms=all&amount=19.95&currency=USD'
So there are HTTP query string and request body:
*/ 
$the_query_string = 'time=1735084500.3561';
$the_request_body = '[email protected]&shop_payment_id=INVOICE-1746&pms=all&amount=19.95&currency=USD';

// • A pair of 'API key' and 'Secret key' gathered from the admin panel
$the_api_key = 'key1';
$the_api_secret = 'secret1';

// • Concatenation:
$string_for_sha = $the_query_string . $the_request_body;
// Value: '[email protected]&shop_payment_id=INVOICE-1746&pms=all&amount=19.95&currency=USD'

// • Calculating the HTTP header 'Sign'
// hash method is SHA-256
$signature_sha256 = hash_hmac("sha256", $string_for_sha, $the_api_secret); 
// '31ca271a15e45802e07b7559a5f520656c050dda79e6fa46d52a15fc51d193cd'

/* • Signed HTTP request:
  Method: POST
  URI: '/api/v1/private/checkout/payment/create?time=1735084500.3561'
  HTTP header 'Api-Key': 'key1'
  HTTP header 'Sign': '31ca271a15e45802e07b7559a5f520656c050dda79e6fa46d52a15fc51d193cd'
  POST body: '[email protected]&shop_payment_id=INVOICE-1746&pms=all&amount=19.95&currency=USD'
*/

दूसरे उदाहरण में व्हाइटस्पेस और लाइन ब्रेक पर ध्यान दें:

/* 
Imagine there is the POST request:
URI: '/api/v1/private/checkout/payment/create?shop_name=Very%20useful%20service'
POST body: '{
  "shop_user_id": "[email protected]",
  "shop_payment_id": "INVOICE-1746",
  "shop_payment_desc": "Premium service
(1 month)",

  "pms": "all",
  "amount": "19.95",
  "currency": "USD",
  "time": "1735084500.3561"
}'

Attention! It's important to keep the raw data 'as is', including all tabulations, whitespaces, and line breaks. 
For example, the signature becomes invalid if your software formats json, adds or removes spaces. 

So there are such HTTP query string and POST request body:
*/ 
$the_query_string = 'shop_name=Very%20useful%20service';
$the_request_body = '{
  "shop_user_id": "[email protected]",
  "shop_payment_id": "INVOICE-1746",
  "shop_payment_desc": "Premium service
(1 month)",

  "pms": "all",
  "amount": "19.95",
  "currency": "USD",
  "time": "1735084500.3561"
}';

// • A pair of 'API key' and 'Secret key' gathered from the merchant panel
$the_api_key = 'key1';
$the_api_secret = 'secret1';

// • Concatenation:
//
// hash method is SHA-256 (HTTP query string + request body)
$string_for_sha = $the_query_string . $the_request_body;
/* Value: 'shop_name=Very%20useful%20service{
  "shop_user_id": "[email protected]",
  "shop_payment_id": "INVOICE-1746",
  "shop_payment_desc": "Premium service
(1 month)",

  "pms": "all",
  "amount": "19.95",
  "currency": "USD",
  "time": "1735084500.3561"
}'
*/

// • Calculating the HTTP header 'Sign'

$signature_sha256 = hash_hmac("sha256", $string_for_sha, $the_api_secret); 
// 'ef15476f28b379e4b137a2dcd9ed495332e4766004ac3610bb92a69ba2303c28'

/* • Signed HTTP request:
  Method: POST
  URI: '/api/v1/private/checkout/payment/create'
  HTTP header 'Api-Key': 'key1'
  HTTP header 'Sign': 'ef15476f28b379e4b137a2dcd9ed495332e4766004ac3610bb92a69ba2303c28'
  POST body: '{
  "shop_user_id": "[email protected]",
  "shop_payment_id": "INVOICE-1746",
  "shop_payment_desc": "Premium service
(1 month)",

  "pms": "all",
  "amount": "19.95",
  "currency": "USD",
  "time": "1735084500.3561"
}' 
*/

साइनचर कैलकुलेशन के लिए स्ट्रिंग बनाने का Python उदाहरण:

string_for_hash_calculation = f'{request.query_params.urlencode()}{request.data.urlencode()}'

पैरामीटर

API सभी पैरामीटर को दोनों QUERY_STRING और POST अनुरोध के बॉडी में स्वीकार करता है।

बूलियन चर

API आशा करता है कि Boolean वेरिएबल्स में '0' या '1' मिलेगा, लेकिन अप्रत्यक्ष प्रकार रूपांतरण के कारण, कोई भी टेक्स्ट स्ट्रिंग '1' के रूप में माना जाएगा, यहाँ तक कि शब्द 'false' भी। इसलिए, Boolean वेरिएबल के लिए स्पष्ट रूप से 'FALSE' मान सेट करने के लिए, आपको इसे या तो '0' मान या खाली स्ट्रिंग पास करनी होगी।

दशमलव विभाजक

सांख्यिकाओं में दशमलव अलग करने के लिए केवल दशमलव बिंदु का प्रयोग किया जाता है।

पैरामीटर में अक्षर का आकार

कुछ अपवादों को छोड़कर, सभी पैरामीटर केस-संवेदी होते हैं।

कॉलबैक URL

AxtonPay के एडमिन पैनल में, चेकआउट सेटिंग्स पेज पर, AxtonPay से सर्वर-टू-सर्वर नोटिफिकेशन प्राप्त करने के लिए स्टोर URL सेट करना संभव है, साथ ही इनवॉइस भुगतान या उसकी रद्दीकरण के बाद खरीदार को रीडायरेक्ट करने के लिए URL, और त्रुटि होने की स्थिति में URL भी सेट किए जा सकते हैं।

इन URL को चालान निर्माण अनुरोध में ओवरराइड किया जा सकता है।

AxtonPay एपीआई के तरीके

चालान निर्माण: /api/v1/private/checkout/payment/create

मेथड /api/v1/private/checkout/payment/create चालान निर्माण शुरू करता है।

यदि सफल होता है, तो यह विधि एक लिंक ('invoice_url') लौटाती है, जिस पर आपको ग्राहक को भुगतान के लिए भेजना चाहिए।

स्वयं के चालान पैरामीटर:

• time (अनिवार्य) - POSIX timestamp (Unix time)
• amount (अनिवार्य) - भुगतान की जाने वाली राशि (उत्पाद या सेवा की कीमत जिसे स्टोर प्राप्त करना चाहता है)
• currency (अनिवार्य) - ISO 4217-alpha के अनुसार 3-अक्षरों वाला मुद्रा कोड, केस-असेंसिटिव
• pms (अनिवार्य) - चालान पृष्ठ पर प्रदर्शित भुगतान विधियाँ। यदि आप सभी भुगतान विधियों की अनुमति देना चाहते हैं, तो मान 'all' है; यदि आप केवल कुछ की अनुमति देना चाहते हैं, तो उनके कॉमा से अलग किए हुए संख्यात्मक पहचानकों को सूचीबद्ध करें।
• pm - चयनित भुगतान विधि का पहचानकर्ता। यह महत्वपूर्ण है कि यदि 'pm' पैरामीटर पास किया जाता है, तो चालान 'ट्रांसपेरेंट मोड' में बनाया जाएगा, अर्थात् खरीदार चालान पृष्ठ नहीं देखेगा, बल्कि सीधे भुगतान प्रणाली पर जाएगा।
• extra_data - किसी भी अतिरिक्त डेटा को शामिल करने वाला एक सहसंबंधित ऐरे; यह डेटा पूरी तरह से स्टोर को लौटाया जाता है
• shop_user_id - स्टोर में उपयोगकर्ता पहचानकर्ता, इसे बिना किसी बदलाव के स्टोर में वापस भेजा जाता है
• shop_payment_id - स्टोर में भुगतान पहचानकर्ता, यह स्टोर में बिना बदले हुए रूप में लौटाया जाता है
• shop_name - स्टोर का नाम (इंवॉइस पेज पर दिखाया गया)
• shop_payment_desc - ऑर्डर विवरण (इंवॉइस पृष्ठ पर प्रदर्शित)
• shop_payment_remark - इस भुगतान के बारे में आपकी नोट्स (यह भुगतान पर आपके किसी भी नोट के लिए एक क्षेत्र है, जिसे AxtonPay कहीं भी नहीं भेजता; यह केवल भुगतान की सूची में दिखाई देता है; यह स्टोर में वापस नहीं जाता)
• valid_time - वह समयावधि जिसमें चालान का भुगतान किया जा सकता है; सेकंड में
• view_time - समय अंतराल जिसके दौरान चालान बाहरी लिंक के माध्यम से देखने के लिए उपलब्ध है; सेकंड में; काउंटडाउन 'valid_time' अवधि समाप्त होने के बाद शुरू होता है
• server_notification_method - दुकान को भुगतान स्थितियों के बारे में सर्वर-से-सर्वर सूचनाएँ भेजने की विधि; मान्य मान: POST, GET

इनवॉइस की कुछ सेटिंग्स चेकआउट सेटिंग्स पेज पर सेट की जाती हैं। लेकिन अनुरोध में पास की गई मान इन सेटिंग्स पर प्राथमिकता लेंगे।

चेकआउट पैरामीटर जिन्हें इस चालान के लिए ओवरराइड किया जा सकता है:

• customer_success_url - एक लिंक जिस पर खरीदार को उस स्थिति में पुनर्निर्देशित किया जाएगा यदि चालान सफलतापूर्वक भुगतान किया गया हो (यानी यदि चालान की स्थिति 'paid' या 'overpaid' है)।
• customer_cancel_url - एक लिंक जिस पर खरीदार को पुनर्निर्देशित किया जाएगा यदि भुगतान रद्द कर दिया जाता है
• customer_fail_url - एक लिंक जिस पर खरीदार को तब रीडायरेक्ट किया जाएगा यदि भुगतान में कोई त्रुटि होती है
• server_notification_url - भुगतान स्थितियों की सर्वर-से-सर्वर सूचनाएँ स्टोर को भेजने के लिए लिंक

ध्यान दें: अपनी गोपनीयता नीति का पालन करने के लिए, आमतौर पर आपके ग्राहक के व्यक्तिगत डेटा को इनवॉइस की विवरण में शामिल करना आवश्यक नहीं होता है। उदाहरण के लिए, "shop_user_id" पैरामीटर में, उनके ईमेल या फोन नंबर के बजाय एक सार ग्राहक आईडी निर्दिष्ट करना बेहतर है। इसी प्रकार, "shop_payment_desc" में भी, ग्राहक का डेटा बिल्कुल शामिल न करना बेहतर है, क्योंकि वे पहले ही अपने बारे में सब कुछ जानते हैं; इसके बजाय, आप भुगतान किए गए सामान या सेवाओं के बारे में कुछ जानकारी लिख सकते हैं, या सिर्फ कार्रवाई के प्रकार को लिख सकते हैं, उदाहरण के लिए, "खरीद" या "बैलेंस टॉप-अप"।

सभी संदर्भ अनिवार्य रूप से प्रोटोकॉल के साथ प्रसारित किए जाते हैं।

अनुरोध का उदाहरण:

<?php
// API credentials - get it from settings of the checkout
$api_key = 'API_KEY';
$api_secret = 'API_SECRET';
// API endpoint
$api_endpoint = 'https://mp.axtonpay.com/api/v1/private/checkout';
// Current POSIX timestamp
$time = time();
// API method URL
$api_url = $api_endpoint . '/payment/create';

// Prepare POST parameters
$post_data = [
    'amount' => 4.99,
    'currency' => 'USD',
    'pms' => 'all', // visible payment methods; either 'all' or comma-separated list of selected GUIDs
    // 'pm' => '92807385', // define the certain payment method if you do not want payer to see the list of all possible payment methods

    // Below parameters are optional
    'extra_data' => ['param1'=>'value 1', 'param2'=>'value 2'],

    'shop_user_id' => '[email protected]',
    'shop_payment_id' => 'TEST-333-' . $time,
    'shop_name' => 'TEST-333 web shop',
    'shop_payment_desc' => 'TEST-333 payment description visible to payer',
    'shop_payment_remark' => 'TEST-333 payment remark for admin',

    'customer_success_url' => 'https://example.com/?status=paid-or-overpaid&once=TEST-333-' . $time, 
    'customer_cancel_url' => 'https://example.com/?status=cancelled-by-payer&once=TEST-333-' . $time,
    'customer_fail_url' => 'https://example.com/?status=error&once=TEST-333-' . $time,
    'server_notification_url' => 'https://example.com/?for=server-to-server-notificataions',
    'server_notification_method' => 'POST',
	
    'valid_time' => 60*60*24*7, // seconds
    'view_time'  => 60*60*24*21, // seconds, clock starts after ending of 'valid_time' period
];

// Prepare GET parameters
$query_string = 'time=' . $time;

// Build the request body
$request_body = json_encode($post_data); // Encode as JSON
// $request_body = http_build_query($post_data);

// Concatenate QUERY_STRING and REQUEST_BODY
$string_for_sha = $query_string . $request_body;

// Calculate the signature
$signature = hash_hmac('sha256', $string_for_sha, $api_secret);

// Prepare HTTP headers
$headers = [
    'Api-Key: ' . $api_key,
    'Sign: ' . $signature,
    'Content-Type: application/json'
];

// Initialize cURL
$ch = curl_init($api_url . '?' . $query_string);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request_body);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

// Execute the request
$response = curl_exec($ch);

// Close cURL
curl_close($ch);
?>

इनवॉइस निर्माण का अनुरोध करते समय सफल प्रतिक्रिया का उदाहरण:

{
    "status": "ok",
    "data": "invoice created",
    "pid": "HNQ5CAHM",
    "test": false,
    "created_at": "2025-12-27T08:14:55.000000Z",
    "invoice_url": "https:\/\/27375212.b88pay.com\/i\/HNQ5CAHM"
}

इनवॉइस जानकारी प्राप्त करना: /api/v1/private/checkout/payment/get/{PID}

ज़रूरी जानकारी प्राप्त करने के लिए, उस मेथड /api/v1/private/checkout/payment/get/{PID} को कॉल करें, URL के अंत में इनवॉइस का PID निर्दिष्ट करके।

अनुरोध के पैरामीटर:

• time (अनिवार्य) - POSIX timestamp (Unix time)

हस्ताक्षर बनाने के लिए एक पंक्ति का उदाहरण:

// Full URL:
https://mp.axtonpay.com/api/v1/private/checkout/payment/get/GIKR3XPY?time=1766837343

// String for signature calculation: 
time=1766837343

उत्तर का उदाहरण:

{
    "status": "ok",
    "data": {
        "pid": "HNQ5CAHM",
        "checkout_guid": 34677320,
        "created_at": "2025-12-27 12:07:21",
        "updated_at": "2025-12-27 12:07:34",
        "data": {
            "ip": "1.2.3.4",
            "pms": "all",
            "extra_data": {
                "param1": "val1",
                "param2": "val2",
                "server_notification_url": "https:\/\/example.com\/?for=server-to-server-notificataions"
            },
            "redirect_url": "\/wait\/HNQ5CAHM",
            "customer_fail_url": "https:\/\/example.com\/?status=error&id=TEST-333-1766837240",
            "allow_change_amount": false,
            "customer_cancel_url": "https:\/\/example.com\/?status=cancelled-by-payer&id=TEST-333-1766837240",
            "customer_success_url": "https:\/\/example.com\/?status=paid-or-overpaid&id=TEST-333-1766837240"
        },
        "payment_status": 0,
        "amount": "4.99",
        "filled": "0.00",
        "currency_id": 5,
        "transparent": 1,
        "expires_at": "2026-01-03 12:07:21",
        "invisible_at": "2026-01-26 12:07:21",
        "paid_at": null,
        "confirmed_at": null,
        "shop_name": "TEST-333 web shop",
        "shop_user_id": "[email protected]",
        "shop_payment_id": "TEST-333-1766837240",
        "shop_payment_desc": "TEST-333 payment description visible to payer",
        "shop_payment_remark": "TEST-333 payment remark for merchant",
        "payment_method_id": 92807385,
        "gateway_id": 40056646,
        "payment_option_id": 297,
        "txid": null,
        "account_from": null,
        "account_to": "TEnYvbfg9YqJeaVtVHAwEvG2kmAJcTzxTh",
        "payment_option_amount": "17.865973",
        "payment_option_filled": "0.000000",
        "payment_option_currency_id": 317,
        "exchange_rates_expires_at": "2025-12-27 12:27:33",
        "test": false,
        "initiator": "api",
        "initiator_info": null,
        "payment_option": {
            "id": 297,
            "gateway_id": 40056646,
            "pm": "trx",
            "currency_id": 317,
            "name": "Tron",
            "icon": "crypto\/tron.png",
            "min_invoice": null,
            "max_invoice": null
        },
        "payment_option_currency": {
            "id": 317,
            "name": "Tron",
            "code": "TRX",
            "minor_unit": 6
        },
        "currency": {
            "id": 5,
            "name": "United States dollar",
            "code": "USD",
            "minor_unit": 2
        },
        "invoice_url": "https:\/\/27375212.b88pay.com\/i\/HNQ5CAHM"
    }
}

मांग की गई राशि और चुकाई गई राशि की तुलना

प्रतिक्रिया में कई अलग-अलग राशि शामिल हैं (उस मुद्रा में जिसमें चालान जारी किया गया था):

• "amount" - चालान की गई राशि,
• "filled" - चालान का भुगतान किया गया हिस्सा,
• "total_filled" - कुल मिलाकर ग्राहक ने कितना भुगतान किया, जिसमें कमीशन भी शामिल हैं।

अगर "filled = amount", तो इसे उतना ही भुगतान किया जाता है जितना कि इसकी जरूरत होती है।

यदि "filled > amount", तो अधिक भुगतान है।

यदि "filled < amount", तो चालान पूरा भुगतान नहीं किया गया है (अल्प भुगतान)।

इनवॉइस: स्थिति परिवर्तन के बारे में AxtonPay से सूचना की प्रसंस्करण

हर बार जब किसी चालान की स्थिति बदलती है, AxtonPay server_notification_url को एक सूचना भेजता है (server_notification_method का उपयोग करके)

उदाहरण डेटा:

{
    "pid": "U5IB4WIO",
    "status": "3",
    "shop_user_id": "3q23g",
    "shop_payment_id": "h76r5",
    "amount": "240.00000000",
    "filled": "0.00000000",
    "fee": "0",
    "total_filled": "0.00000000",
    "currency": "DASH",
    "test": "0"
}

इस सूचना के जवाब में AxtonPay को HTTP code 200 प्राप्त होने की उम्मीद है, जो इसकी सफल प्राप्ति की पुष्टि करता है। अन्यथा, AxtonPay 12 और बार धीरे-धीरे बढ़ते हुए अंतराल पर पुनः प्रयास करेगा, और फिर सूचना की स्थिति 'error' में बदल जाएगी (लेकिन इसका चालान की स्थिति पर कोई प्रभाव नहीं पड़ता)।

संभव स्थिति मान:

• 0 - pending
• 1 - paid
• 2 - error
• 3 - cancelled by customer
• 4 - underpaid
• 5 - overpaid
• 8 - expired

सफल भुगतान की स्थिति 1 (paid) और 5 (overpaid) हैं; इनके प्राप्त होने की स्थिति में आप ग्राहक को भुगतान किए गए खरीद को स्थानांतरित कर सकते हैं या बैलेंस को पुनः भर सकते हैं। जिन भुगतानों की स्थिति 5 (overpaid) है, बैलेंस पुनः भरने की स्थिति में आप वास्तव में प्राप्त भुगतान की राशि से बैलेंस को पुनः भर सकते हैं, लेकिन यदि माल/सेवाओं की बिक्री और अधिक भुगतान की महत्वपूर्ण राशि है तो यह सलाह दी जाती है कि भुगतानकर्ता से संपर्क करें और उसके साथ तय करें कि अधिक भुगतान को कैसे निपटाया जाए।

आंशिक रूप से सफल स्थिति 4 (underpaid) है; इस स्थिति प्राप्त होने पर असल में प्राप्त भुगतान की राशि के अनुसार बैलेंस रिचार्ज करना संभव है। हालाँकि, इस स्थिति को वस्तुओं/सेवाओं की बिक्री के लिए सफल नहीं माना जा सकता।

अन्य सभी स्थितियाँ - 0 (pending), 2 (error), 3 (canceled by customer) भुगतान की पूरी अनुपस्थिति दर्शाती हैं; इनके प्राप्त होने की स्थिति में बैलेंस पूर्ति या वस्त्रों/सेवाओं की बिक्री पर कोई कार्रवाई नहीं करनी चाहिए।

हस्ताक्षर जाँच

यह सुनिश्चित करने के लिए कि सूचनाएं वास्तव में AxtonPay द्वारा भेजी गई हैं, इसे भरोसा करने से पहले प्राप्त सूचनाओं के सिग्नेचर की जांच करना आवश्यक है। सत्यापन आपके अपने अनुरोधों को साइन करने के समान है, बस आखिरी चरण जोड़ा गया है, जब आपको गणना किए गए सिग्नेचर की तुलना प्राप्त HTTP हेडर 'Sign' से करनी चाहिए।

बदलाव हुए भुगतान स्थिति के बारे में सूचनाएं प्राप्त करने के बाद मुख्य कदम निम्नलिखित हैं:

• प्राप्त नोटिफिकेशन से सभी तर्कों की पूरी श्रृंखला (QUERY_STRING) लें,
• प्राप्त नोटिफिकेशन से पूरा POST data (REQUEST_BODY) लें,
• उन QUERY_STRING + REQUEST_BODY और उपयुक्त 'Secret key' का उपयोग करके हस्ताक्षर की गणना करें,
• गणना किए गए हस्ताक्षर की तुलना HTTP हेडर 'Sign' में प्राप्त हुए हस्ताक्षर से करें,
• अगर हस्ताक्षर एक जैसे हैं, तो सूचनाएँ वास्तव में AxtonPay से आई हैं;
• अगर हस्ताक्षर अलग हैं, तो यह भुगतानकर्ता द्वारा धोखा देने का प्रयास हो सकता है।

हस्ताक्षर निर्माण के लिए एक पंक्ति का उदाहरण:

// Full URL:
https://EXAMPLE.COM?time=1737027838.1237

// POST body: 
pid=ABCD5678&status=1&shop_user_id=&shop_payment_id=&amount=25.00000000&filled=25.00000000&fee=0&total_filled=25.00000000&currency=RDD&test=0

// String for signature calculation: 
time=1737027838.1237pid=ABCD5678&status=1&shop_user_id=&shop_payment_id=&amount=25.00000000&filled=25.00000000&fee=0&total_filled=25.00000000&currency=RDD&test=0

पुष्टि कि स्टोर ने भुगतान जानकारी संसाधित कर दी है: /api/v1/private/checkout/payment/confirm/{PID}

यह अनुरोध AxtonPay को भेजा गया है जो इसके द्वारा प्राप्त सूचनाओं के जवाब में है। कार्यात्मक रूप से, यह पुष्टि है कि स्टोर ने प्राप्त सूचनाओं को सफलतापूर्वक प्राप्त और संसाधित कर लिया है।

किसी अनुरोध को भेजने के लिए, /api/v1/private/checkout/payment/confirm/{PID} मेथड को कॉल करें, URL के अंत में चालान का पिड निर्दिष्ट करके।

अनुरोध पैरामीटर:

• time (अनिवार्य) - POSIX timestamp (Unix time)
• status (आवश्यक, पूर्णांक) - भुगतान स्थिति संख्या जिसके लिए स्टोर पुष्टि भेजता है

यदि प्रेषित स्थिति इस चालान की सिस्टम में वर्तमान स्थिति से मेल खाती है, AxtonPay 'OK' के साथ प्रतिक्रिया देगा और यदि यह मेल नहीं खाती है, तो यह एक त्रुटि के साथ प्रतिक्रिया देगा।

हस्ताक्षर निर्माण के लिए एक पंक्ति का उदाहरण:

// Full URL:
https://mp.axtonpay.com/api/v1/private/checkout/payment/confirm/ABCD5678?time=1737011414

// POST body: 
{"status":"1"}

// String for signature calculation:
time=1737011414{"status":"1"}

यदि वर्तमान भुगतान स्थिति समान है तो प्रतिक्रिया का उदाहरण:

{
    "status": "ok",
    "data": "\"Paid\" status notification is confirmed"
}

यदि वर्तमान भुगतान स्थिति अनुरोध में भेजी गई स्थिति से भिन्न हो तो प्रतिक्रिया का उदाहरण:

{
    "status": "error",
    "message": "Something went wrong"
}

मुद्रा कोड

सिक्के जो चालान बनाने के लिए उपयोग किए जा सकते हैं।

अधिकांश प्रयुक्त मुद्रा कोड फिएट मुद्राओं से संबंधित हैं, और वे ISO 4217 के बराबर हैं। सूची में कुछ क्रिप्टोकरेंसी भी शामिल हैं।