Bittylicious API - Revision history

Cocodude at 17:07, 15 August 2013

2013-08-15T17:07:48Z

@@ Line 1: / Line 1: @@
 =Complete trade=
@@ Line 14: / Line 31: @@
 ** transOtherParty (other party in this transaction, usually the name of the sender)
 * Returned data (JSON structure)
-* ''trades'' array:
+** success (true or false)
 ==Signature==

Cocodude at 11:32, 15 August 2013

2013-08-15T11:32:43Z

← Older revision		Revision as of 11:32, 15 August 2013
Line 13:		Line 13:
	** transReference (transaction reference, usually matches reference above)		** transReference (transaction reference, usually matches reference above)
	** transOtherParty (other party in this transaction, usually the name of the sender)		** transOtherParty (other party in this transaction, usually the name of the sender)
			* Returned data (JSON structure)
			* ''trades'' array:
			** status (trade status, e.g. ''PAID'')
			** reference (trade ID)
			** amountCurrency (e.g. 10.30)
			** currency (e.g. ''GBP'')
			** amountBTC
			** statusExpiry (MySQL DATETIME of the expiry of this status)

	==Signature==		==Signature==

Cocodude: /* Signature */

2013-07-24T08:13:55Z

Signature

← Older revision		Revision as of 08:13, 24 July 2013
Line 18:		Line 18:
	In order to confirm that a trade should be paid out, the bank account client needs to send the signed output of a message to Bittylicious. The part of Bittylicious that actually sends out the coins will then verify this against the public key assigned to this offer.		In order to confirm that a trade should be paid out, the bank account client needs to send the signed output of a message to Bittylicious. The part of Bittylicious that actually sends out the coins will then verify this against the public key assigned to this offer.

	The message that needs to be signed takes the JSON form:		The message that needs to be signed takes the JSON form and is encoded using sha512:

	* version = 1		* version = 1

Cocodude: /* Signature */

2013-07-24T08:11:34Z

Signature

← Older revision		Revision as of 08:11, 24 July 2013
Line 37:		Line 37:
	die();		die();
	}		}

	// Build data		// Build data
	$tradeID = $argv[1];		$tradeID = $argv[1];
Line 44:		Line 44:
	$updateID = $argv[3] + 1;		$updateID = $argv[3] + 1;
	$data = json_encode(array('version' => (int)1, 'reference' => $tradeID, 'btcaddress' => $btcAddress, 'updateID' => (int)$updateID));		$data = json_encode(array('version' => (int)1, 'reference' => $tradeID, 'btcaddress' => $btcAddress, 'updateID' => (int)$updateID));

	if (isset($argv[4]) && $argv[4] == 'debug')		if (isset($argv[4]) && $argv[4] == 'debug')
	echo "Data is {$data}\n";		echo "Data is {$data}\n";

	// Get private key		// Get private key
	$fp = fopen("private.key", "r");		$fp = fopen("private.key", "r");
Line 57:		Line 57:
	if (!$pkeyid)		if (!$pkeyid)
	die("Private key not valid");		die("Private key not valid");

	// compute signature		// compute signature
	openssl_sign($data, $signature, $pkeyid, 'sha512');		openssl_sign($data, $signature, $pkeyid, 'sha512');

	// free the key from memory		// free the key from memory
	openssl_free_key($pkeyid);		openssl_free_key($pkeyid);

	echo base64_encode($signature) . "\n";		echo base64_encode($signature) . "\n";
	?>		?>

Cocodude at 08:11, 24 July 2013

2013-07-24T08:11:12Z

← Older revision		Revision as of 08:11, 24 July 2013
Line 13:		Line 13:
	** transReference (transaction reference, usually matches reference above)		** transReference (transaction reference, usually matches reference above)
	** transOtherParty (other party in this transaction, usually the name of the sender)		** transOtherParty (other party in this transaction, usually the name of the sender)

			==Signature==

			In order to confirm that a trade should be paid out, the bank account client needs to send the signed output of a message to Bittylicious. The part of Bittylicious that actually sends out the coins will then verify this against the public key assigned to this offer.

			The message that needs to be signed takes the JSON form:

			* version = 1
			* reference = ''trade reference''
			* btcaddress = ''BTC address coins will be sent to''
			* updateID = ''update identifier provided in response to the Trade List API call plus 1''

			For example, the following could be signed:

			{"version":1,"reference":"BJU02PF7S","btcaddress":"1B4oWw64wPIW9jf01oaabNoK67qxYeNJg3","updateID":3}

			PHP code to do this is as follows:

			<?php
			if (!isset($argv[3]))
			{
			echo "Syntax: {$argv[0]} TradeReference BTCAddress UpdateID [debug]\n";
			die();
			}

			// Build data
			$tradeID = $argv[1];
			$btcAddress = $argv[2];
			// Plus one because this update increments the updateID anyway
			$updateID = $argv[3] + 1;
			$data = json_encode(array('version' => (int)1, 'reference' => $tradeID, 'btcaddress' => $btcAddress, 'updateID' => (int)$updateID));

			if (isset($argv[4]) && $argv[4] == 'debug')
			echo "Data is {$data}\n";

			// Get private key
			$fp = fopen("private.key", "r");
			if (!$fp)
			die("Could not open private key private.key\n");
			$priv_key = fread($fp, 8192);
			fclose($fp);
			$pkeyid = openssl_get_privatekey($priv_key);
			if (!$pkeyid)
			die("Private key not valid");

			// compute signature
			openssl_sign($data, $signature, $pkeyid, 'sha512');

			// free the key from memory
			openssl_free_key($pkeyid);

			echo base64_encode($signature) . "\n";
			?>

Cocodude: Created page with "=Complete trade= * URL is https://bittylicious.com/api/v1/complete * Required input data (POST fields): api_key offerID reference (trade reference) action = 'complet..."

2013-07-23T13:54:38Z

Created page with "=Complete trade= * URL is https://bittylicious.com/api/v1/complete * Required input data (POST fields): ** api_key ** offerID ** reference (trade reference) ** action = 'complet..."

New page

=Complete trade=

* URL is https://bittylicious.com/api/v1/complete
* Required input data (POST fields):
** api_key
** offerID
** reference (trade reference)
** action = 'complete'
** signature (see below)
* Optional input data (POST fields):
** transCommentaryFull (full transaction commentary)
** transType (transaction type, e.g. ''Faster Payments In'')
** transReference (transaction reference, usually matches reference above)
** transOtherParty (other party in this transaction, usually the name of the sender)

Bittylicious API - Revision history

Cocodude at 17:07, 15 August 2013

Cocodude at 11:32, 15 August 2013

Cocodude: /* Signature */

Cocodude: /* Signature */

Cocodude at 08:11, 24 July 2013

Cocodude: Created page with "=Complete trade= * URL is https://bittylicious.com/api/v1/complete * Required input data (POST fields): ** api_key ** offerID ** reference (trade reference) ** action = 'complet..."

Cocodude: Created page with "=Complete trade= * URL is https://bittylicious.com/api/v1/complete * Required input data (POST fields): api_key offerID reference (trade reference) action = 'complet..."