yellow/php-sdk

Yellow Bitcoin Payment SDK

0.0.2 2015-04-16 21:35 UTC

This package is not auto-updated.

Last update: 2024-04-13 14:07:56 UTC


README

Installation :

Get more information with the Documentation.

Installing via Composer

The recommended way to install Yellow PHP SDK is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest master version of Yellow PHP SDK:

php composer.phar require yellow/php-sdk

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Dependencies

  • PHP 5.4 or higher
  • guzzlehttp/guzzle 5.0
  • ext-curl
  • ext-hash 1.0
  • ext-json 1.0

Example :

<?php
use Yellow\Bitcoin\Invoice;
$api_key = "Your API public key";
$api_secret = "Your API Private key";
$yellow = new Invoice($api_key,$api_secret);
/// this will return an array with invoice data
$paylaod = array(
    "base_price" => 10,
    "base_ccy"   => "USD",
    "callback"   => "http://yourstore.local/checkout/status/"
);
$invoice  = $yellow->createInvoice($payload);
var_dump($invoice);
/// this will return an array with invoice status data
$status = $yellow->checkInvoiceStatus($invoice["id"]);
var_dump($status);

IPN validation :

to validate the IPN simply use following snippet on your IPN page/controller

 <?php
 use Yellow\Bitcoin\Invoice;
 $api_key = "Your API public key";
 $api_secret = "Your API Private key";
 $yellow = new Invoice($api_key,$api_secret);
 $isValidIPN = $yellow->verifyIPN($url, $signature, $key, $nonce, $body); //bool
 var_dump($isValidIPN);

Documentation

More information can be found in the online documentation at http://yellowpay.co/docs/api/.