Hosted checkout

PHP examples

• Hosted Flow Integration
• Embedded Integration

<?php
//Your API Key
$api_key = 'Your API Key Here';

$data = [
	'currency' => 'USD',
	'amount' => 300.99,
	'store_name' => 'My First Store',
	'store_logo' => 'https://mysite.com/logo.png',
	'item_name' => 'Printer Epson',
	'item_desc' => 'Printer Epson EcoTank L5590',
	'item_number' => 1592,
	'custom' => 'XH32is',
	'wallets' => 'BTC,LTC,ETH',
	'ipn_url' => 'https://mysite.com/webhook',
	'success_url' => 'https://mysite.com/thank_you',
	'cancel_url' => 'https://mysite.com/store'
];
$ch = curl_init('https://coinmkr.com/api/v1/checkout');
$payload = json_encode( $data );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Content-Type:application/json',
	'x-api-key: '.$api_key,
));
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response);

if($result->status == 'error'){
	//Error
	die('Error was found: '.$result->message);
}else{
	//Success and redirect to payment form
	header('location: '.$result->url);
	exit;
}
?>

<?php
//Your API Key
$api_key = 'Your API Key Here';

$data = [
	'currency' => 'USD',
	'amount' => 300.99,
	'store_name' => 'My First Store',
	'store_logo' => 'https://mysite.com/logo.png',
	'item_name' => 'Printer Epson',
	'item_desc' => 'Printer Epson EcoTank L5590',
	'item_number' => 1592,
	'custom' => 'XH32is',
	'wallets' => 'BTC,LTC,ETH',
	'ipn_url' => 'https://mysite.com/webhook'
];
$ch = curl_init('https://coinmkr.com/api/v1/checkout');
$payload = json_encode( $data );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Content-Type:application/json',
	'x-api-key: '.$api_key,
));
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response);

if($result->status == 'error'){
	//Error
	echo 'Error was found: '.$result->message;
}else{
	//Embedded form
	?>
	<script src="<?php echo $result->script;?>"></script>
<?php
}
?>

A success message returns a json response:

{
    "status": "success",
    "id": "c0e48e4cae927s31343",
    "url": "https:\/\/coinmkr.com\/checkout\/c0e48e4cae927s31343",
    "script": "https:\/\/coinmkr.com\/checkout\/js\/c0e48e4cae927s31343"
}

Postback notification

Webhook is invoked when a transaction is added to a block or when it appears in the mempool (ETH and BSC).

The request body of the POST request is a JSON object with the following structure:

{
  "status": "completed",
  "payment": {
    "delivery": "on_time",
    "asset": "LTC",
    "blockchain": "LTC",
    "address": "ltc1q95wg2wz93ve0v8vcsfnsuthn37gy5azpsg5ygh",
    "amount": "0.00988995",
    "total_received": "0.00988995",
    "txID": "1b5f874ad29f7bc1c46bd099152de6606c2c066370af93b0e08750c28cb44dba"
  },
  "store": {
    "currency": "USD",
    "amount": 1,
    "item_name": "Printer Epson",
    "item_number": 1592,
    "custom": "XH32is"
  }
}

Data information:

• status: if amount is equal or higher than required, then status will be completed otherwise it returns uncompleted. If it is uncompleted, then user needs to send more funds to complete this transaction.
• payment:delivery: if system detects that deposit is completed before than 60 minutes, then it returns on_time, otherwise it returns delayed
• payment:asset: cryptocurrency code of transaction.
• payment:blockchain: the blockchain where this transactions is done.
• payment:address: your deposit address.
• payment:amount: amount received in this notification.
• payment:total_received: the total amount received, if user made twice deposits, then this is the sum of amounts of those two transactions.
• payment:txID: the transaction id (TXID) of this transaction in the blockchain.
• store:currency: The currency you sent for your product or service.
• store:amount: The amount (in the currency chosen) of the payment.
• store:item_name: The name of the item being purchased.
• store:item_number: This is a passthru variable for your own use.
• store:custom: This is a passthru variable for your own use.

<?php

$api_key = "Your_API_Key";

$raw_post_data = file_get_contents('php://input');

$signature = hash_hmac("sha256", $raw_post_data, $api_key);

if($signature != $_SERVER['HTTP_COINMKR_SIGNATURE']){
	die('Invalid signature');
}

$payment_data = json_decode($raw_post_data);
                
            

Credit consumption

You will consume credits only for API calls, in case of Hosted Checkout, there are some required calls:

1. 3 credits per address generated from each chain.
2. 30 credits per webhook subscription from each chain.
3. (*) 10 credits per webhook notification each chain.
4. 2 credits per webhook unsubscription from each chain.

(*) You will be notified only if you receive a payment within the 12 hours, after that period credits for webhook notification will not be debited.

An unsuccessful transaction will consume 35 credits per wallet

A successful transaction will consume 35 credits per wallet + 10 credits per notification