Tries to use sdk on test api. 1) I generate private key with master password 2) I create and approve merchant token with the help of generator from examples, for key from 1st step. I saw it in dashboard for my account 3) Now tries to create invoice with configured client on the test api and got subject error in response

What I'm doing wrong?

Hi there @foam-agency -- could you share a bit more about your scenario?

What version of PHP are you running? We support 7.4, 8.0, and 8.1
What facade did you generate the token for?
How are you instantiating your BitPay client?
Are you using a configuration file, or in-line configuration?
Could you share an example invoice creation call that fails?

php 8.0 merchat facade Here is laravel DI for bitpay service

$this->app->singleton(\BitPaySDK\Client::class, function ($app) {
            return \BitPaySDK\Client::create()->withData(
                'Test',
                '/var/www/html/private.key',
                \BitPaySDK\Tokens::loadFromArray([
                    'merchant' => '2M<secret>1n', //merchant
                ]),
                'secret' //used to decrypt your private key, if encrypted
            );
        });

Here is invoice creattion code

$bitpay_client = resolve(Client::class); /** @var $bitpay_client Client */

        $invoice = new Invoice($cart->getAmount(), 'USD'); //Always use the included Currency model to avoid typos
        $invoice->setOrderId("65f5090680f6");
        $invoice->setFullNotifications(true);
        $invoice->setExtendedNotifications(true);
        $invoice->setNotificationURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
        $invoice->setRedirectURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
        $invoice->setItemDesc("Ab tempora sed ut.");
        $invoice->setNotificationEmail("");

        $buyer = new Buyer();
        $buyer->setName("Bily Matthews");
        $buyer->setEmail("");
        $buyer->setAddress1("168 General Grove");
        $buyer->setAddress2("");
        $buyer->setCountry("AD");
        $buyer->setLocality("Port Horizon");
        $buyer->setNotify(true);
        $buyer->setPhone("+990123456789");
        $buyer->setPostalCode("KY7 1TH");
        $buyer->setRegion("New Port");

        $invoice->setBuyer($buyer);

        $result_invoice = $bitpay_client->createInvoice($invoice, 'merchant');

I am getting the same error. I created the key with the ConfigGenerator, added the token to my API account. It doesn't work with similar code above, nor does it work when I try with the BitPay Tests. I am running PHP 8.1 and Laravel 9.

use BitPaySDK\Client;
use BitPaySDK\Model\Currency;
use BitPaySDK\Model\Invoice\Invoice;
use BitPaySDK\Tokens;

class PaymentHelper
{

    public static function bitpayRequest($orderId, $grandTotal, $billing)
    {

        $bitpay = Client::create()->withData(
            'Test',
            config_path('bitpay/bitpay.key'),
            new Tokens(
                "Token" //merchant
            ),
            "Password", //used to decrypt your private key, if encrypted
        );
        $invoice = new Invoice(50.0, Currency::USD);
        $basicInvoice = $bitpay->createInvoice($invoice);
    }
}

BitPaySDK\Exceptions\InvoiceCreationException with message 'BITPAY-INVOICE-CREATE: Failed to create invoice-> failed to serialize Invoice object : failed to retrieve HTTP response body : Unauthorized sin'

Also of note, the Guide has $invoice->setToken($bitpay->_token);, but $bitpay->_token does not exist.

@foam-agency , @karenmt thank you so much for the feedback. We're in the process of updating our SDK and guides, and do have a working example we can share, however it's not shown using Laravel. With the popularity of the framework, we'll be sure to add this to our backlog as something to provide in the near future.

Can you both confirm that when you create your token, you are:

Generating a private key
Deriving a public key from the private key
Deriving an SIN from the public key
Creating a token on the Merchant facade
Claimed the pairing code in the test environment (https://test.bitpay.com/) to activate the token
When making calls, you are using the token returned from the POST token call, and not the ID from the dashboard

Here are some examples that I use locally, without a framework. They aren't intended to be production-ready, just something scrappy I use for on-the-fly testing. I add and remove various bits depending on what I need to do, so there may be an occasional unused variable, etc. but I tested before posting so it should be alright.

Simplified key generation class

<?php
namespace YourNamespace\BitpayPHPExample;

error_reporting(E_ALL ^ E_DEPRECATED);

use BitPayKeyUtils\KeyHelper\PrivateKey;
use BitPayKeyUtils\Storage\EncryptedFilesystemStorage;

require __DIR__ . '/../vendor/autoload.php';

class Keygen {
  private $privateKey;

  private function createToken() {
    $facade      = 'merchant';
    $publicKey   = $this->privateKey->getPublicKey();
    $resourceUrl = 'https://test.bitpay.com/tokens';
    $sin         = $publicKey->getSin()->__toString();

    $postData = json_encode([
        'id' => $sin,
        'facade' => $facade
    ]);

    $curlCli = curl_init($resourceUrl);
    $xSignature = $this->privateKey->sign($resourceUrl . $postData);
    echo 'Signed Data: ' . $xSignature . PHP_EOL . PHP_EOL;

    curl_setopt($curlCli, CURLOPT_HTTPHEADER, [
        'x-accept-version: 2.0.0',
        'Content-Type: application/json',
        'x-identity' => $publicKey->__toString(),
        'x-signature' => $xSignature
    ]);

    curl_setopt($curlCli, CURLOPT_CUSTOMREQUEST, 'POST');
    curl_setopt($curlCli, CURLOPT_POSTFIELDS, stripslashes($postData));
    curl_setopt($curlCli, CURLOPT_RETURNTRANSFER, true);

    $result = curl_exec($curlCli);
    $resultData = json_decode($result, TRUE);

    curl_close($curlCli);

    if (array_key_exists('error', $resultData)) {
        echo $resultData['error'];
        exit;
    }

    echo 'Store this information for later!' . PHP_EOL;
    echo '=================================' . PHP_EOL;
    echo 'SIN:          ' . $sin . PHP_EOL;
    echo 'X-Identity:   ' . $publicKey->__toString() . PHP_EOL;
    echo 'Token:        ' . $resultData['data'][0]['token'] . PHP_EOL;
    echo 'Facade:       ' . $resultData['data'][0]['facade'] . PHP_EOL;
    echo '=================================' . PHP_EOL;

    /**
     * Example of a pairing Code returned from the BitPay API
     * which needs to be APPROVED on the BitPay Dashboard before being able to use it.
     **/
    echo 'Pairing Code: ' . $resultData['data'][0]['pairingCode'] . PHP_EOL . PHP_EOL;
    echo 'Log into the BitPay dashboard, search for your pairing code, and create the token.' . PHP_EOL;
  }

  public function generate($password) {
    $privateKey = new PrivateKey(__DIR__ . '/../secure/private.key');
    $this->privateKey = $privateKey->generate();

    $storageEngine = new EncryptedFilesystemStorage($password);
    $storageEngine->persist($this->privateKey);

    $this->createToken();
  }
}

If you run generate(), it will print data like this (note the *** are just placeholders so we're not sharing sensitive info):

Signed Data: *** LONG STRING ***

Store this information for later!
=================================
SIN:          *** YOUR SIN STRING ***
X-Identity:   *** X-IDENTITY HEADER FOR THIS CALL ***
Token:        *** THE TOKEN TO USE IN OTHER CALLS ***
Facade:       merchant
=================================
Pairing Code: *** PAIRING CODE TO CLAIM TOKEN ***

Example class to generate invoice

<?php
namespace YourNamespace\BitpayPHPExample;

error_reporting(E_ALL ^ E_DEPRECATED);

use \BitPaySDK\Model\Currency;
use \BitPaySDK\Model\Invoice\Buyer;
use \BitPaySDK\Model\Invoice\Invoice;

require __DIR__ . '/../vendor/autoload.php';

class ExampleInvoice {
  private $client;

  private function setClient($token, $password) {
    $client = \BitPaySDK\Client::create()->withData(
      \BitPaySDK\Env::Test,
      __DIR__ . '/../secure/private.key',
      new \BitPaySDK\Tokens(
          $token
      ),
      $password,
      null
    );

    $this->client = $client;
  }

  public function create($token, $password) {
    $this->setClient($token, $password);
    $invoice = new Invoice(50.0, Currency::USD); //Always use the included Currency model to avoid typos
    $invoice->setToken($token);
    $invoice->setOrderId('1000000000');
    $invoice->setFullNotifications(true);
    $invoice->setExtendedNotifications(true);
    $invoice->setNotificationURL('https://hookb.in/kxEkW1MzZoUBDokBLjGP');
    $invoice->setRedirectURL('https://hookb.in/kxEkW1MzZoUBDokBLjGP');
    $invoice->setItemDesc('My test item');
    $invoice->setNotificationEmail('r.brodie+seller@your-domain-here.com');
    $invoice->setBuyerEmail('r.brodie+buyer@your-domain-here.com');

    $buyer = new Buyer();
    $buyer->setName('Robert Brodie');
    $buyer->setEmail('r.brodie+buyer@your-domain-here.com');
    $buyer->setAddress1('123 Main St.');
    $buyer->setAddress2('');
    $buyer->setCountry('US');
    $buyer->setLocality('Anytown');
    $buyer->setNotify(true);
    $buyer->setPostalCode('11111');
    $buyer->setRegion('New City');

    $invoice->setBuyer($buyer);

    $basicInvoice = $this->client->createInvoice($invoice);
    echo 'Invoice URL      : ' . $basicInvoice->getUrl() . PHP_EOL;
    echo 'Invoice JSON URL : ' . 'https://test.bitpay.com/invoices/' . $basicInvoice->getId() . PHP_EOL;
  }
}

This will give output like the following:

Invoice URL      : https://test.bitpay.com/invoice?id=*** INVOICE ID ***
Invoice JSON URL : https://test.bitpay.com/invoices/*** INVOICE ID ***

When creating the private key, I followed the instructions on https://github.com/bitpay/php-bitpay-client-v2/blob/master/GUIDE.md#getting-started which only mentions running the Bitpay Config Generator. There is no mention of creating a public key or sin. There is a link that says "Getting your client token", but it's a dead link.

It looks like the library should be grabbing the public key on its own. In RESTcli.php, it creates x-identity with $this->_identity = $this->_ecKey->getPublicKey()->__toString();, where $this->_ecKey is an instance of PrivateKey. $sin is referenced in the ConfigGenerator, but it doesn't provide it at al.

Hi @karenmt we are currently working on updating documentation and will have more robust information for the SDKs, overall. More in-depth documentation regarding the end-to-end process can be found in the API documentation.

An SIN is the system identification number, and can be derived from the public key. You don't need a static public key like many key pairs, because a new one can be easily derived. You're right that it doesn't mention generating a public key or SIN, I just keep them in my personal scripts because they're concepts to understand regarding the system. The SDK does this for you and populates the necessary headers.

Testing

I've re-tested the config generator and have been able to create invoices.

Here are the steps that I followed:

Ensure that the PrivateKeyName.key file does not exist in the directory that you run the config generator from (examples/)
Change to the examples/ directory
Run php ConfigGenerator.php
- Note the pairing codes
- Note the tokens
Claim your pairing codes
Implement a BitPay Client (note: the password used in the ConfigGenerator, unless modified, will be YourMasterPassword.)
Use the BitPay Client to create an invoice

Notes

The SDK is at version 7.0.0. The guide does reference ^5.0 so if you don't need to use that version specifically, I recommend using the latest. We can update that to have it while the new docs are being written.
I do see a typo in the guide. It shows BitPaySDK\Env.Test instead of BitPaySDK\Env::Test, and depending on how you're loading, you may need to reference the namespace off the root, like \BitPaySDK\Env::Test. We can update that in the docs.
Ensure that the tokens in your config match the output of the ConfigGenerator, just to be sure.

Please let me know if this is helpful -- we're taking all feedback and are considering it all as we build out plans both near-term and long-term.

Here are the steps I took:

composer install bitpay/sdk -- it installed 7.0
Modify ConfigGenerator.php with my values: privateKeyName, yourMasterPassword, generatePayoutToken to false, generateYMLfile to false, correct path to vendor directory
Run php vendor/bitpay/sdk/examples/ConfigGenerator.php from the project root
Add Pairing Code to account. Client ID does not match Token, I'm guessing those are two different things. Token that was output to the screen does match what was in the config.json
Move bitpay.key and BitPay.config.json from project root to config/bitpay folder.
Using php artisan tinker (Laravel's command line interface), try the following code:

use BitPaySDK\Client;
use BitPaySDK\Env;
use BitPaySDK\Model\Currency;
use BitPaySDK\Model\Invoice\Invoice;
use BitPaySDK\Tokens;

$bitpay =Client::create()->withData(
            Env::Test,
            config_path('bitpay/bitpay.key'), // Laravel's helper to create the absolute path to the file
            new Tokens(
                "MyMerchantToken" // Same as in the config and shown on screen
            ),
            "MyPassword", // same used in ConfigGenerator and showing in BitPay.config.json
        );
        $invoice = new Invoice(50.0, Currency::USD);
        $basicInvoice = $bitpay->createInvoice($invoice);

With that, I get

BitPaySDK\Exceptions\InvoiceCreationException with message 'BITPAY-INVOICE-CREATE: Failed to create invoice-> failed to serialize Invoice object : failed to retrieve HTTP response body : Unauthorized sin

I also copied your ExampleInvoice script, and got the same error.

Thanks again, @karenmt . I've used your example to create an invoice using Laravel. Here are the steps that I've followed to achieve this.

NOTE: I am sharing my tokens (not the generated private key) for real-world demonstration purposes, but they were for the Test environment and have since been revoked.

Step 1: Generate Private Key and Tokens

The ConfigGenerator is just an example to show how keys and tokens can be generated. It is not intended to be run from within a project, so here's what I did, starting from scratch (I am using PHP 8.1):

Check out the SDK into a separate directory

git clone git@github.com:bitpay/php-bitpay-client-v2.git

Change to the new directory

cd php-bitpay-client-v2

Install dependencies

composer install

Change to the examples/ directory

cd examples/

Update ConfigGenerator.php

$privateKeyname = 'bitpay.key';
$yourMasterPassword = 'MyPassword';

Run ConfigGenerator.php

php ConfigGenerator.php

My output

Merchant Facade
    -> Pairing Code: ZpQ1tku
    -> Token: 3yPULLLr8HZF5xknd141Dx15Mh6CHt1TTXbncqtooneH

Payout Facade
    -> Pairing Code: xXhrP8h
    -> Token: CEufXJGDTbYKAtR5YhNx8kRZc5AL7kvsfcKoqXxkVcqM

Claim the merchant token (not worried about payout for this test)

Log into https://test.bitpay.com/dashboard/getstarted
Go to Payment Tools > API Tokens
Enter the Pairing Code
Click the Find button
Give it a label: ConfigGenerator3
Enter my 2FA code

Note: The Client ID and Token are not the same, no expectation for them to match.

Step 2: Set up Laravel

Create a new application

laravel new test-laravel

Install the BitPay SDK

composer require bitpay/sdk

Copy the private key to the Laravel app

Copied bitpay.key to the config/bitpay/ directory

Load Tinker

php artisan tinker

Run the following

use BitPaySDK\Client;
use BitPaySDK\Env;
use BitPaySDK\Model\Currency;
use BitPaySDK\Model\Invoice\Invoice;
use BitPaySDK\Tokens;

$bitpay = Client::create()->withData(
            Env::Test,
            config_path('bitpay/bitpay.key'),
            new Tokens(
              "3yPULLLr8HZF5xknd141Dx15Mh6CHt1TTXbncqtooneH"
            ),
            "MyPassword",
          );
$invoice = new Invoice(50.0, Currency::USD);
$basicInvoice = $bitpay->createInvoice($invoice);
print_r($basicInvoice);

Receive the following output

Summary

Unfortunately, without knowing more about your environment and setyp it will be difficult to fully understand what is happening for you in particular. This test was run using PHP 8.1 and Laravel 9.x. If you could report any specific issues you find while debugging, along with a stacktrace that would be very helpful.

I created a new project/folder for just php-bitpay-client-v2, and running the ConfigGenerator from there created a useable key/token that worked with my existing Laravel code. At this point, I can only guess it's a difference in packages installed between Laravel and a straight installation of php-bitpay-client-v2. The majority of the differences in the packages are minor versions, but there's a few major version differences that I'm not sure make a difference. I've listed the packages below in case it might help. Laravel is fully up-to-date, and php-bitpay-client-v2 was installed an hour ago.

. Laravel Straight bitpay sdk bitpay/key-utils v1.1.0 v1.0.1908 doctrine/instantiator 1.4.1 1.4.0
guzzlehttp/guzzle 7.5.0 7.3.0
guzzlehttp/promises 1.5.2 1.4.1
guzzlehttp/psr7 2.4.1 2.0.0
myclabs/deep-copy 1.11.0 1.10.2
nikic/php-parser v4.15.1 v4.13.0
phar-io/version 3.2.1 3.1.0
phpdocumentor/reflection-docblock 5.2.2
phpdocumentor/type-resolver 1.6.1 1.5.1
phpspec/prophecy 1.14.0
phpunit/php-code-coverage 9.2.17 9.2.7
phpunit/php-file-iterator 3.0.6 3.0.5
phpunit/phpunit 9.5.25 9.5.10
sebastian/comparator 4.0.8 4.0.6
sebastian/environment 5.1.4 5.1.3
sebastian/exporter 4.0.5 4.0.3
sebastian/global-state 5.0.5 5.0.3
sebastian/type 3.2.0 2.3.4
symfony/deprecation-contracts v3.1.1 v2.4.0
symfony/polyfill-ctype v1.26.0 v1.23.0
symfony/yaml v6.1.4 v5.3.6
webmozart/assert 1.11.0 1.10.0

Thanks, @karenmt. Since it's working on a clean setup, we'll close this for now. I would suggest ensuring that your existing Laravel application uses the same versions as the new one you created. If you find any specific replicable bugs, please let us know.

@karenmt , @foam-agency just a quick heads up -- we have found the reason the setup I've posted works. Version 1.0.1908 of the keyutils was prior to an open source contribution of a deprecation cleanup released in 1.1.0. All tests have been passing and initial manual tests passed as well. We are addressing the issue and will release SDK version 7.0.1 and Key Utils version 1.2.0, which we are anticipating will be released early this coming week.

Note: keys generated with 1.0.1908 are working with an application using 1.1.0.

Thank you so much for reporting this, and I will report back here upon the release of the new versions of the SDK and Key Utils. In the meantime, I've re-opened this bug.

We have updated the following:

bitpay-php-keyutils: 1.1.1
php-bitpay-client-v2: 7.0.1

We have checked that:

Keys generated with 1.0.1908 work in 7.0.1
Keys generated with 1.1.1 work in 7.0.1

This is part of an effort to handle the deprecation of Serializable interfaces in PHP 8.1.

Thanks again @foam-agency , @karenmt !

I can confirm that I have encountered the same error today, also on Laravel, however as per @karenmt suggestion, running the config gen on a seperate project folder and plugging the keypair into existing project works like a charm.

I am running laravel sail on a mac, but unsure whether this is actually the cause of the issue, thought I would leave my confirmation here for anyone running into the same issue.

bitpay / php-bitpay-client-v2

BITPAY-INVOICE-CREATE: Failed to create invoice-> failed to serialize Invoice object : failed to retrieve HTTP response body : Unauthorized sin" #111

Testing

Notes

Step 1: Generate Private Key and Tokens

Step 2: Set up Laravel

Summary