AxtonPay API

সাধারণ তথ্য

এপিআই এন্ডপয়েন্ট

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

Content-type

এপিআই ২টি কনটেন্ট টাইপ সহ HTTP অনুরোধ গ্রহণ করে: 'application/x-www-form-urlencoded', 'application/json'।

HTTP হেডারটি POST বডির কনটেন্টের সাথে মানানসই হওয়া উচিত।

সংক্ষেপ এবং সংজ্ঞা

• {PID} - চালানের আইডি, সাধারণত এটি একটি অনন্য ৮ অক্ষরের অক্ষরসংখ্যার ক্রম।
• Shop - আপনার ওয়েবসাইট যা AxtonPay পরিষেবার মাধ্যমে পেমেন্ট গ্রহণ করে

API-এর সাথে কাজ করার অ্যালগরিদম

পেমেন্ট পাওয়ার সাধারণ ক্রমবিধি:

• একটি ইনভয়েস তৈরি করুন ('/api/v1/private/checkout/payment/create'), API প্রতিক্রিয়ায় ইনভয়েসের 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' প্যারামিটারটি পাস করা বাধ্যতামূলক।

এই স্বাক্ষরটি ২৪ ঘন্টার জন্য বৈধ। যদি 'time' প্যারামিটারের মান বর্তমান সার্ভারের সময় থেকে ২৪ ঘন্টার চেয়ে বেশি পার্থক্য থাকে (উভয় দিকেই, আগের বা পরের), তবে অনুরোধটি ব্যর্থ হবে এমনকি স্বাক্ষরটি সঠিকভাবে গণনা করলেও।

যদি মার্চেন্ট প্যানেল কোনো স্বাক্ষরের সঙ্গে একটি অনুরোধ গ্রহণ করে, সেই স্বাক্ষরটি পুনরায় ব্যবহার করা যাবে না, এমনকি একই প্যারামিটার সহ অনুরোধ পাঠানোর জন্যও (এতে প্যারামিটার '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 অনুরোধের বডিতেও গ্রহণ করে।

বুলিয়ান ভেরিয়েবল

এপিআইটি Boolean ভেরিয়েবলে '0' বা '1' পাওয়ার আশা করে, কিন্তু অপ্রকাশিত টাইপ রূপান্তরের কারণে, যেকোনো টেক্সট স্ট্রিংকে '1' হিসেবে গণ্য করা হবে, এমনকি শব্দটি 'false' হলেও। তাই, একটি Boolean ভেরিয়েবলের জন্য স্পষ্টভাবে 'FALSE' মান সেট করতে, আপনাকে এতে '0' মান অথবা একটি খালি স্ট্রিং প্রেরণ করতে হবে।

দশমিক বিভাজক

সংখ্যায় দশমিক আলাদা করার জন্য শুধুমাত্র দশমিক বিন্দু ব্যবহৃত হয়।

প্যারামিটারগুলিতে অক্ষরের কেস

কিছুমাত্র ব্যতিক্রম ছাড়া, সমস্ত প্যারামিটার কেস-সেন্সিটিভ।

কলব্যাক URL

AxtonPay এর অ্যাডমিন প্যানেলে, চেকআউট সেটিংস পৃষ্ঠায়, AxtonPay থেকে সার্ভার-টু-সার্ভার নোটিফিকেশন প্রাপ্ত করার জন্য স্টোর URL সেট করা সম্ভব, পাশাপাশি ইনভয়েসের পেমেন্ট বা এর বাতিল করার পর ক্রেতাকে পুনঃনির্দেশ করার জন্য URL, এবং ত্রুটির ক্ষেত্রে URL সেট করা সম্ভব।

এই URL গুলি ইনভয়েস তৈরি করার অনুরোধে ওভাররাইড করা যেতে পারে।

AxtonPay API এর পদ্ধতি

ইনভয়েস তৈরি: /api/v1/private/checkout/payment/create

পদ্ধতি /api/v1/private/checkout/payment/create চালান তৈরি শুরু করে।

যদি সফল হয়, পদ্ধতিটি একটি লিঙ্ক ('invoice_url') ফেরত দেয় যেটিতে আপনাকে গ্রাহককে পেমেন্ট করার জন্য পাঠাতে হবে।

নিজস্ব চালানের প্যারামিটারসমূহ:

• time (প্রয়োজনীয়) - POSIX timestamp (Unix time)
• amount (প্রয়োজনীয়) - প্রদেয় যতো অর্থ (পণ্যের বা সেবার দাম যা দোকানটি পেতে চায়)
• currency (প্রয়োজনীয়) - ISO 4217-alpha অনুযায়ী ৩ অক্ষরের মুদ্রা কোড, বড়-ছোট অক্ষরের পার্থক্য নেই
• 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 - সময় অন্তরাল যার মধ্যে চালানটি বাহ্যিক লিঙ্কের মাধ্যমে দেখার জন্য উপলব্ধ থাকে; সেকেন্ডে; ⏳ সময়কাল শেষ হওয়ার পরে কাউন্টডাউন শুরু হয়
• 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}

আপনার প্রয়োজনীয় তথ্য পেতে, URL এর শেষে ইনভয়েসের PID উল্লেখ করে /api/v1/private/checkout/payment/get/{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 ক্রমবর্ধমান সময় অন্তর ১২ বার পুনরায় চেষ্টা করবে, এবং তারপর বিজ্ঞপ্তির অবস্থা '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-কে পাঠানো হয়েছে এ থেকে প্রাপ্ত বিজ্ঞপ্তির প্রতি প্রতিক্রিয়ার হিসেবে। কার্যকরভাবে, এটি একটি নিশ্চিতকরণ যে দোকানটি প্রাপ্ত বিজ্ঞপ্তি সফলভাবে গ্রহণ ও প্রক্রিয়াজাত করেছে।

একটি অনুরোধ পাঠাতে, URL-এর শেষে চালানের pid উল্লেখ করে /api/v1/private/checkout/payment/confirm/{PID} মেথডটি কল করুন।

অনুরোধ প্যারামিটারসমূহ:

• 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-এর সমান। এছাড়াও তালিকায় কয়েকটি ক্রিপ্টোকারেন্সি রয়েছে।