The official PHP library for the Coinbase Commerce API.
PHP version 5.4 and above are supported.
For more details visit Coinbase API docs.
To start using this library register an account on Coinbase Commerce.
You will find your API_KEY from User Settings.
Next initialize a Client for interacting with the API. The only required parameter to initialize a client is apiKey, however, you can also pass in baseUrl, apiVersion and timeout.
Parameters can be also be set post-initialization:
use CoinbaseCommerce\ApiClient;
//Make sure you don't store your API Key in your source code!
$apiClientObj = ApiClient::init(<API_KEY>);
$apiClientObj->setTimeout(3);$apiClientObj->verifySsl(false);The API resource class provides the following static methods: list, all, create, retrieve, updateById, deleteById. Additionally, the API resource class also provides the following instance methods: save, delete, insert, update.
Each API method returns an ApiResource which represents the JSON response from the API.
When the response data is parsed into objects, the appropriate ApiResource subclass will automatically be used.
Client supports the handling of common API errors and warnings. All errors that occur during any interaction with the API will be raised as exceptions.
| Error | Status Code |
|---|---|
| APIException | * |
| InvalidRequestException | 400 |
| ParamRequiredException | 400 |
| ValidationException | 400 |
| AuthenticationException | 401 |
| ResourceNotFoundException | 404 |
| RateLimitExceededException | 429 |
| InternalServerException | 500 |
| ServiceUnavailableException | 503 |
Install with composer:
composer require coinbase/coinbase-commerceuse CoinbaseCommerce\ApiClient;
//Make sure you don't store your API Key in your source code!
ApiClient::init('API_KEY');Checkouts API docs
More examples on how to use checkouts can be found in the examples/Resources/CheckoutExample.php file
use CoinbaseCommerce\Resources\Checkout;$checkoutObj = Checkout::retrieve(<checkout_id>);$checkoutData = [
'name' => 'The Sovereign Individual',
'description' => 'Mastering the Transition to the Information Age',
'pricing_type' => 'fixed_price',
'local_price' => [
'amount' => '100.00',
'currency' => 'USD'
],
'requested_info' => ['name', 'email']
];
$newCheckoutObj = Checkout::create($checkoutData);
// or
$newCheckoutObj = new Checkout();
$newCheckoutObj->name = 'The Sovereign Individual';
$newCheckoutObj->description = 'Mastering the Transition to the Information Age';
$newCheckoutObj->pricing_type = 'fixed_price';
$newCheckoutObj->local_price = [
'amount' => '100.00',
'currency' => 'USD'
];
checkoutObj->requested_info = ['name', 'email'];
checkoutObj->save();$checkoutObj = new Checkout();
$checkoutObj->id = <checkout_id>;
$checkoutObj->name = 'new name';
$checkoutObj->save();
// or
$newParams = [
'name' => 'New name'
];
Checkout::updateById(<checkout_id>, $newParams});$checkoutObj = new Checkout();
$checkoutObj->id = <checkout_id>;
$checkoutObj->delete();
// or
Checkout::deleteById(<checkout_id>);List method returns ApiResourceList object.
$params = [
'limit' => 2,
'order' => 'desc'
];
$list = Checkout::getList($params);
foreach($list as $checkout) {
var_dump($checkout);
}
// Get number of items in list
$count = $list->count();
// or
$count = count($list);
// Get number of all checkouts
$countAll = $list->countAll();
// Get pagination
$pagination = $list->getPagination();
// To load next page with previous setted params(in this case limit, order)
if ($list->hasNext()) {
$list->loadNext();
foreach($list as $checkout) {
var_dump($checkout);
}
}$params = [
'order' => 'desc'
];
$allCheckouts = Checkout::getAll($params);Charges API docs
More examples on how to use charges can be found in the examples/Resources/ChargeExample.php file
use CoinbaseCommerce\Resources\Charge;$chargeObj = Charge::retrieve(<charge_id>);$chargeData = [
'name' => 'The Sovereign Individual',
'description' => 'Mastering the Transition to the Information Age',
'local_price' => [
'amount' => '100.00',
'currency' => 'USD'
],
'pricing_type' => 'fixed_price'
];
Charge::create($chargeData);
// or
$chargeObj = new Charge();
$chargeObj->name = 'The Sovereign Individual';
$chargeObj->description = 'Mastering the Transition to the Information Age';
$chargeObj->local_price = [
'amount' => '100.00',
'currency' => 'USD'
];
$chargeObj->pricing_type = 'fixed_price';
$chargeObj->save();$list = Charge::getList();
foreach($list as $charge) {
var_dump($list);
}
$pagination = $list->getPagination();$allCharges = Charge::getAll();Resolve a charge that has been previously marked as unresolved.
$chargeObj = Charge::retrieve(<charge_id>);
if ($chargeObj) {
$chargeObj->resolve();
}
Cancels a charge that has been previously created. Note: Only new charges can be successfully canceled. Once payment is detected, charge can no longer be canceled.
$chargeObj = Charge::retrieve(<charge_id>);
if ($chargeObj) {
$chargeObj->confirm();
}
Events API Docs
More examples on how to use events can be found in the examples/Resources/EventExample.php file
use CoinbaseCommerce\Resources\Event;$eventObj = Event::retrieve(<event_id>);$listEvent = Event::getList();
foreach($listEvent as $event) {
var_dump($event);
}
$pagination = $listEvent->getPagination();$allEvents = Event::getAll();It's prudent to be conscious of warnings. The library will log all warnings to a standard PSR-3 logger if one is configured.
use CoinbaseCommerce\ApiClient;
//Make sure you don't store your API Key in your source code!
$apiClientObj = ApiClient::init(<API_KEY>);
$apiClientObj->setLogger($logger);Coinbase Commerce signs the webhook events it sends to your endpoint, allowing you to validate and verify that they weren't sent by someone else.
You can find a simple example of how to use this with Express in the examples/Webhook folder
use CoinbaseCommerce\Webhook;
try {
Webhook::verifySignature($signature, $body, $sharedSecret);
echo 'Successfully verified';
} catch (\Exception $exception) {
echo $exception->getMessage();
echo 'Failed';
}Any and all contributions are welcome! The process is simple: fork this repo, make your changes, run the test suite, and submit a pull request. To run the tests, clone the repository and run the following commands:
composer install
composer testApache-2.0