API payment gateway xPayapi

SCI | Get transaction details

Method name: sci_transaction_details. This method should be called to get and check transaction information.

https://api.xpayapi.com/index.php

Parameter

Success 200

• Success-Response

HTTP/1.1 200 OK
			{
				"error": false,
				"message": "Ok",
				"data": {
					"transaction": "2431038", // transaction number in the system xpayapi: 96401
					"txid": "e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5", //Hash track for explorer
					"shop_id": "138",  // Merchant ID 123
					"order_id": "order 1", // unique numeric identifier of the payment in your merchant, example: 150800
					"amount": "1.00000000", //  amount to credited example: 1.01
					"fee": "0.00000000", //  fee of network
					"currency": "DOGE", // currency(USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, ETC, XRP, TRX, XLM, BNB, USDT, BUSD, USDC, ADA, EOS, SHIB)
					"system": "Dogecoin", //system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, Zcash, EthereumClassic, Ripple, TRON, Stellar, BinanceCoin_BEP20, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
					"address": "DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Target address
					"tag": "", //Tag for Ripple and Stellar
					"status": "no", //"no" - not confirmed, "yes" - confirmed and credited
					"date_update": "2020-07-23 15:06:58", //Date last change transaction info
					"explorer_address_link": "https://explorer.xpayapi.com/dogecoin/address/DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Link to address explorer
					"explorer_transaction_link": "https://explorer.xpayapi.com/dogecoin/transaction/e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5" //Link to transaction explorer
				}
			}
			

Error 4xx

• Error-Response

HTTP/1.1 200 OK
			{
				"error": true,
				"message": "Account not found",
				"data": {}
			}
			

SCI | Get cryptocurrency address for deposit

Method name: sci_create_order_get_data. Creates an address to receive payment. After creating an address for payment, you need to display it on your project page along with a small instruction on how to pay.

https://api.xpayapi.com/index.php

Parameter

Success 200

• Success-Response

HTTP/1.1 200 OK
			{
				"error": false,
				"message": "Data has been successfully received.",
				"data": {
					"invoice": "579205",
					"order_id": "12345",
					"address": "bc1qgd5jezucgjkrnp00h8fcq8wsxacwf65d88j7gf", // address to pay
					"amount": "1.03030000",
					"system": "BitCoin",
					"currency": "BTC",
					"notif_url": "https://xpayapi.com/notif_url.php", # link to redirect for IPN
					"pay_link": "https://pay.xpayapi.com/sci/hash/ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to pay the invoice
					"tag": false // not false if exists
				}
			}
			

Error 4xx

• Error-Response

HTTP/1.1 200 OK
			{
				"error": true,
				"message": "Specify the payment amount. Error code: 22",
				"data": {}
			}
			

API | Get currency rate for pair

Method name: api_currency_rate. Get currency rate for pair. Attention!!! Instead of the xpayapi.com domain, you should use the currency.xpayapi.com subdomain.

https://currency.xpayapi.com/index.php

Parameter

Success 200

• Success-Response

HTTP/1.1 200 OK
			{
				"error": false,
				"message": "Ok",
				"data": {
					"value": "52873.18000000"
				}
			}
			

Error 4xx

• Error-Response

HTTP/1.1 200 OK
			{
				"error": true,
				"message": "Wrong currency_out!",
				"data": {}
			}
			

API | Instant payment

Method name: api_payment. This is an instant payment method designed for executing automatic mass payments from your merchant account.

https://api.xpayapi.com/index.php

Parameter

• Example-Request

require_once 'xpayapi_api.class.php';
			$xpayapi_config = [
				"merchant_id" => "Merchant ID",
				"merchant_password" => "Merchant Password",
				"api_id" => "API ID",
				"api_password" => "API Password",
				"config" => [
					"test_mode" => false,
				],
			];
			
			$system_id = [
				"bitcoin"		=> 20, // BTC
				"ethereum"		=> 21, // ETH
				"litecoin"		=> 22, // LTC
				"dash"			=> 23, // DASH
				"dogecoin"		=> 24, // DOGE
				"binancecoin_bep20"	=> 25, // BNB BEP20    
				"tron"			=> 26, // TRX
				"tron_trc20"	=> 27, // USDT TRC20
				"binancesmartchain_bep20" => 28, // USDT BEP20
				"binancesmartchain_bep20" => 33, // SHIB BEP20
				"ethereum_erc20" => 32, // USDT ERC20
			];
				
			$xPayApi_params = [
				"merchant_id" => $xpayapi_config["merchant_id"],
				"wallet" => [
					"address" => "TRdjwv1fHZvzs3m3fbLxh9fhguNtxLVfWD",
					"tag" => "",
				],
				"amount" => "5",
				"system" => "TRON",
				"currency" => "TRX",
				"comment" => "Testing comment",
				"priority" => "low", // low, medium, high
			];
			$xPayApi = new \xPayApi\xPayApiAPI(
				$xpayapi_config["api_id"],
				$xpayapi_config["api_password"],
				$xpayapi_config["config"]["test_mode"]
			);
			$res = $xPayApi->sendMoney(
				$xPayApi_params["merchant_id"],
				$xPayApi_params["wallet"],
				$xPayApi_params["amount"],
				$xPayApi_params["system"],
				$xPayApi_params["currency"],
				$xPayApi_params["priority"],
				$xPayApi_params["comment"]
			);
			
			if ($res['error']) {
				echo $res["message"]; // $res["message"] - the text of the error message
				//actions in case of an error
			} else {
				//actions in case of success
				$merchant_id = $res["data"]["shop_id"];                     // merchant id that you originally made payment, example 122
				$transaction = $res["data"]["transaction"];                 // transaction number of the payment, example 123456
				$txid = $res["data"]["txid"];                               // txid 5b74e07821da048e4efe3182420fd717bbafd4c0f6f7f2f48a8fe8e55eb923df can be empty
				// In this case, the information about the transaction can be obtained using a universal link from the Explorer_Transaction_Link field, see below
				$payment_id = $res["data"]["payment_id"];                   // Payment transaction number in the payment system, example 59363855
				$amount = $res["data"]["amount"];                           // the amount of the payment, how much was written off from the balance of the merchant
				$amount_pay = $res["data"]["amount_pay"];                   // the amount of the payment, as it is the user
				$system = $res["data"]["system"];                           // the system of payment, which was made the payment, example: Bitcoin
				$currency = $res["data"]["currency"];                       // the payment currency, for example: BTC
				$number = $res["data"]["number"];                           // the address where you sent the funds
				$fee_percent = $res["data"]["fee_percent"];// the transfer fee percentage, example: 1.5 (in %)
				$fee_amount = $res["data"]["fee_amount"];  // the transfer fee amount, example: 1.00
				$paid_commission = $res["data"]["paid_commission"];         // who paid for the Commission, for example: shop
			
				$explorer_address_link =
					$res["data"]["explorer_address_link"];          // A link to view information about the address
				$explorer_transaction_link =
					$res["data"]["explorer_transaction_link"];      // Link to view transaction information
			
				echo sprintf(
					'We have sent the %s %s %s to %s. The txid is %s',
					$system,
					$amount,
					$currency,
					$explorer_address_link,
					$number,
					$explorer_transaction_link,
					$txid
				);
			}
			

Success 200

• Success-Response

HTTP/1.1 200 OK
			{
				"error": false,
				"message": "Data has been successfully received.",
				"data": {
					"shop_id": "123", // id merchant from which you made the payment, example 122
					"transaction": "130236", // transaction number of the payment, example 130236
					"payment_id": "478937139", // transaction number of the payment system, example 478937139
					"txid": "70d6dc6841782c6efd8deac4b44d9cc3338fda7af38043dd47d7cbad7e84d5dd" // txid 70d6dc6841782c6efd8deac4b44d9cc3338fda7af38043dd47d7cbad7e84d5dd
					"amount": "1.01", // the amount of the payment, how much was written off from the balance store 0.42
					"amount_pay": "1.0306", // the amount of the payment, as it is the user, example: 0.41
					"system": "BitCoin", // system, example: Berty(USD,RUB), BitCoin(BTC), Ethereum(ETH), Litecoin(LTC), Dogecoin(DOGE), Dash(DASH), BitcoinCash(BCH), EthereumClassic(ETC), Ripple(XRP), TRON(TRX), Stellar(XLM), BinanceCoin_BEP20(BNB), TRON_TRC20(USDT), BinanceSmartChain_BEP20(USDT), BinanceSmartChain_BEP20(SHIB), Ethereum_ERC20(USDT)
					"currency": "BTC", // the currency of payment, for example: USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, ETC, XRP, XLM, BNB, USDT, BUSD, USDC, ADA, EOS, SHIB
					"number": "bc1qgd5jezucgjkrnp00h8fcq8wsxacwf65d88j7gf", // the address where you sent the funds
					"shop_comission_percent": "1.5", // the transfer fee percentage, example: 1.5
					"shop_comission_amount": "1.0", // the transfer fee amount, example: 1.00
					"paid_commission": "shop" // who paid for the commission, for example: shop
					"explorer_address_link": "https://explorer.xpayapi.com/tron/address/TQsGVya16tiMQgybR5M4xAD4pwjRioqa21" // A link to view information about the address
					"explorer_transaction_link": "https://explorer.xpayapi.com/tron/transaction/70d6dc6841782c6efd8deac4b44d9cc3338fda7af38043dd47d7cbad7e84d5dd" // Link to view transaction information
				}
			}
			

Error 4xx

• Error-Response

HTTP/1.1 200 OK
			{
				"error": true,
				"message": "There is not enough money on the account. Error code: 5.",
				"data": {}
			}