Uncaught BitPaySDK\Exceptions\InvoiceQueryException: BITPAY-INVOICE-GET: Failed to retrieve invoice

[doliveira-v]

Hi there, can someone please check why we're getting this error? the JSON returned is valid but the bug is still in place.

bitpay/sdk: 7.2.0
PHP: 8.1

<?php
require('/home/sites/myapp/my_initial_script.php');

                        $bitpay = BitPaySDK\Client::create()->withData(
                                BitPaySDK\Environment::Production,
                                BITPAY_KEY_PATH,
                                new BitPaySDK\Tokens(
                                        BITPAY_TOKEN
                                ),
                                BITPAY_KEY,
                                (MY_PROXY),
                        );
var_dump($bitpay->getInvoice('3fq...cropped...Np'));

[16-Feb-2023 09:40:58 America/New_York] PHP Fatal error:  Uncaught BitPaySDK\Exceptions\InvoiceQueryException: BITPAY-INVOICE-GET: Failed to retrieve invoice-> failed to deserialize BitPay server response (Invoice) : BITPAY-UTIL: Unexpected JsonMapper exception. -> JSON property "selectedWallet" in class "BitPaySDK\Model\Invoice\BuyerProvidedInfo" must not be NULL in /home/sites/myapp/v0.6/vendor/bitpay/sdk/src/BitPaySDK/Client.php:327
Stack trace:
#0 /home/user/bitpay.php(13): BitPaySDK\Client->getInvoice('3fqs...cropped...Np')
#1 {main}
  thrown in /home/sites/myapp/v0.6/vendor/bitpay/sdk/src/BitPaySDK/Client.php on line 327
[16-Feb-2023 09:40:58 America/New_York] PHP Warning (User): (argv:[0] => bitpay.php) bitpay.php:Uncaught BitPaySDK\Exceptions\InvoiceQueryException: BITPAY-INVOICE-GET: Failed to retrieve invoice-> failed to deserialize BitPay server response (Invoice) : BITPAY-UTIL: Unexpected JsonMapper exception. -> JSON property "selectedWallet" in class "BitPaySDK\Model\Invoice\BuyerProvidedInfo" must not be NULL in /home/sites/myapp/v0.6/vendor/bitpay/sdk/src/BitPaySDK/Client.php:327 Stack trace: #0 /home/user/bitpay.php(13): BitPaySDK\Client->getInvoice('3fqskL3FZcYkmpM...') #1 {main}   thrown /home/sites/myapp/v0.6/vendor/bitpay/sdk/src/BitPaySDK/Client.php:327  [] - line 625 in /home/sites/myapp/v0.6/classes/Logger.php -  in /home/sites/myapp/v0.6/classes/Logger.php on line 625
[16-Feb-2023 09:40:58 America/New_York] PHP Stack trace:
[16-Feb-2023 09:40:58 America/New_York] PHP   0. handleError() :0
[16-Feb-2023 09:40:58 America/New_York] PHP   1. trigger_error() /home/sites/myapp/v0.6/classes/Logger.php:625
[16-Feb-2023 09:40:58 America/New_York] PHP   2. trigger_error() /home/sites/myapp/v0.6/classes/Logger.php:364
[16-Feb-2023 09:40:58 America/New_York] PHP   3. log() /home/sites/myapp/v0.6/include/exception_handler.php:155
[16-Feb-2023 09:40:58 America/New_York] PHP   4. catchFatalError() :0

{
    "url": "https://bitpay.com/invoice?id=3fqskL3 ...cropped... Np",
    "status": "expired",
    "price": 500,
    "currency": "USD",
    "itemDesc": "$500 account credit for total...cropped...gmail.com (NO REFUNDS)",
    "orderId": "...cropped...",
    "invoiceTime": 1676058827981,
    "rateRefreshTime": 1676058827981,
    "expirationTime": 1676059727981,
    "currentTime": 1676558726734,
    "guid": "90349e...cropped...2d0d35607a3",
    "id": "3fq...cropped...Np",
    "lowFeeDetected": false,
    "amountPaid": 0,
    "displayAmountPaid": "0",
    "exceptionStatus": false,
    "targetConfirmations": 6,
    "guaranteedPaymentTargetConfirmations": 6,
    "guaranteedPayment": false,
    "transactions": [],
    "transactionSpeed": "medium",
    "buyer": [],
    "redirectURL": "https:/...cropped...lling/",
    "refundAddresses": [],
    "refundAddressRequestPending": false,
    "buyerProvidedEmail": "tota...cropped...ail.com",
    "buyerProvidedInfo": {
        "selectedWallet": null,
        "layer": null,
        "emailAddress": "tot...cropped...ail.com"
    },
    "paymentSubtotals": {
        "BTC": 2319700,
        "BCH": 393229600,
        "ETH": 329117000000000000,
        "GUSD": 50000,
        "PAX": 5e+20,
        "BUSD": 5e+20,
        "USDC": 500000000,
        "DOGE": 613363320700,
        "LTC": 537860000
    },
    "paymentTotals": {
        "BTC": 2322900,
        "BCH": 393229600,
        "ETH": 329117000000000000,
        "GUSD": 50000,
        "PAX": 5e+20,
        "BUSD": 5e+20,
        "USDC": 500000000,
        "DOGE": 613465576100,
        "LTC": 537860000
    },
    "paymentDisplayTotals": {
        "BTC": "0.023229",
        "BCH": "3.932296",
        "ETH": "0.329117",
        "GUSD": "500.00",
        "PAX": "500.00",
        "BUSD": "500.00",
        "USDC": "500.00",
        "DOGE": "6134.655761",
        "LTC": "5.378600"
    },
    "paymentDisplaySubTotals": {
        "BTC": "0.023197",
        "BCH": "3.932296",
        "ETH": "0.329117",
        "GUSD": "500.00",
        "PAX": "500.00",
        "BUSD": "500.00",
        "USDC": "500.00",
        "DOGE": "6133.633207",
        "LTC": "5.378600"
    },
    "exchangeRates": {
        "BTC": {
            "USD": 21554.972999999998,
            "BCH": 167.758443733922,
            "ETH": 14.046262470920194,
            "GUSD": 21554.972999999998,
            "PAX": 21554.972999999998,
            "BUSD": 21554.972999999998,
            "USDC": 21554.972999999998,
            "DOGE": 260792.8922447085,
            "LTC": 229.47911210475885
        },
        "BCH": {
            "USD": 127.15218476142283,
            "BTC": 0.005839800001602335,
            "ETH": 0.08285851067019612,
            "GUSD": 127.15218476142283,
            "PAX": 127.15218476142283,
            "BUSD": 127.15218476142283,
            "USDC": 127.15218476142283,
            "DOGE": 1538.4099033968216,
            "LTC": 1.3536908622396482
        },
        "ETH": {
            "USD": 1519.2143999999996,
            "BTC": 0.06977393496094773,
            "BCH": 11.823770015493132,
            "GUSD": 1519.2143999999996,
            "PAX": 1519.2143999999996,
            "BUSD": 1519.2143999999996,
            "USDC": 1519.2143999999996,
            "DOGE": 18380.92385064966,
            "LTC": 16.1738997125519
        },
        "GUSD": {
            "USD": 1,
            "BTC": 4.5927641918709915e-05,
            "BCH": 0.007782818551149288,
            "ETH": 0.0006516483444873809,
            "PAX": 1,
            "BUSD": 1,
            "USDC": 1,
            "DOGE": 12.098966314859615,
            "LTC": 0.010646225912913872
        },
        "PAX": {
            "USD": 1,
            "BTC": 4.5927641918709915e-05,
            "BCH": 0.007782818551149288,
            "ETH": 0.0006516483444873809,
            "GUSD": 1,
            "BUSD": 1,
            "USDC": 1,
            "DOGE": 12.098966314859615,
            "LTC": 0.010646225912913872
        },
        "BUSD": {
            "USD": 1,
            "BTC": 4.5927641918709915e-05,
            "BCH": 0.007782818551149288,
            "ETH": 0.0006516483444873809,
            "GUSD": 1,
            "PAX": 1,
            "USDC": 1,
            "DOGE": 12.098966314859615,
            "LTC": 0.010646225912913872
        },
        "USDC": {
            "USD": 1,
            "BTC": 4.5927641918709915e-05,
            "BCH": 0.007782818551149288,
            "ETH": 0.0006516483444873809,
            "GUSD": 1,
            "PAX": 1,
            "BUSD": 1,
            "DOGE": 12.098966314859615,
            "LTC": 0.010646225912913872
        },
        "DOGE": {
            "USD": 0.08151775352169041,
            "BTC": 3.743918137610637e-06,
            "BCH": 0.0006344377619882504,
            "ETH": 5.3120908962502596e-05,
            "GUSD": 0.08151775352169041,
            "PAX": 0.08151775352169041,
            "BUSD": 0.08151775352169041,
            "USDC": 0.08151775352169041,
            "LTC": 0.0008678562867939782
        },
        "LTC": {
            "USD": 92.96099999999998,
            "BTC": 0.0042694795204051925,
            "BCH": 0.7234985953333889,
            "ETH": 0.06057788175189141,
            "GUSD": 92.96099999999998,
            "PAX": 92.96099999999998,
            "BUSD": 92.96099999999998,
            "USDC": 92.96099999999998,
            "DOGE": 1124.7320075956645
        }
    },
    "minerFees": {
        "BTC": {
            "satoshisPerByte": 22.054,
            "totalFee": 3200,
            "fiatAmount": 0.69
        },
        "BCH": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "ETH": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "GUSD": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "PAX": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "BUSD": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "USDC": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        },
        "DOGE": {
            "satoshisPerByte": 695615.14,
            "totalFee": 102255400,
            "fiatAmount": 0.08
        },
        "LTC": {
            "satoshisPerByte": 0,
            "totalFee": 0,
            "fiatAmount": 0
        }
    },
    "shopper": [],
    "jsonPayProRequired": false,
    "merchantName": "...cropped...LLC",
    "bitpayIdRequired": false,
    "itemizedDetails": [
        []
    ],
    "shopify": [],
    "supportedTransactionCurrencies": {
        "BTC": {
            "enabled": true
        },
        "BCH": {
            "enabled": true
        },
        "ETH": {
            "enabled": true
        },
        "GUSD": {
            "enabled": true
        },
        "PAX": {
            "enabled": true
        },
        "BUSD": {
            "enabled": true
        },
        "USDC": {
            "enabled": true
        },
        "XRP": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "DOGE": {
            "enabled": true
        },
        "DAI": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "WBTC": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "LTC": {
            "enabled": true
        },
        "SHIB": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "APE": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "EUROC": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "MATIC": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "ETH_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "MATIC_e": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "USDC_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "BUSD_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "DAI_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "WBTC_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "SHIB_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "USDT": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        },
        "USDT_m": {
            "enabled": false,
            "reason": "merchantDisabledByParam"
        }
    },
    "paymentCodes": {
        "BTC": {
            "BIP72b": "bitcoin:?r=https://bitpay.com/i/3f...cropped...Np",
            "BIP73": "https://bitpay.com/i/3fq...cropped...Np"
        },
        "BCH": {
            "BIP72b": "bitcoincash:?r=https://bitpay.com/i/3fq...cropped...Np",
            "BIP73": "https://bitpay.com/i/3fqs...cropped...Np"
        },
        "ETH": {
            "EIP681": "ethereum:?r=https://bitpay.com/i/3f...cropped...Np"
        },
        "GUSD": {
            "EIP681b": "ethereum:?r=https://bitpay.com/i/3fq...cropped...Np"
        },
        "PAX": {
            "EIP681b": "ethereum:?r=https://bitpay.com/i/3fq...cropped...Np"
        },
        "BUSD": {
            "EIP681b": "ethereum:?r=https://bitpay.com/i/3f...cropped...Np"
        },
        "USDC": {
            "EIP681b": "ethereum:?r=https://bitpay.com/i/3f...cropped...Np"
        },
        "DOGE": {
            "BIP72b": "dogecoin:?r=https://bitpay.com/i/3fq...cropped...Np",
            "BIP73": "https://bitpay.com/i/3f...cropped...Np"
        },
        "LTC": {
            "BIP72b": "litecoin:?r=https://bitpay.com/i/3fq...cropped...Np",
            "BIP73": "https://bitpay.com/i/3fq...cropped...Np"
        }
    },
    "universalCodes": {
        "paymentString": "https://link.bitpay.com/i/3fq...cropped...Np"
    },
    "token": "3yjmDksP81m7S...cropped...tsGF3ay8NP86Wa"
}

[bobbrodie]

Hey @doliveira-v, I definitely see what's going on here, that buyerProvidedInfo.selectedWallet is coming back null and we don't expect that. I've got just a few questions:

• Can you confirm that the actual invoice JSON that's generated in BitPay has null for that value? For example, when you go to https://test.bitpay.com/invoices/{invoice-id-here}, is it there and null, or does the key not exist?
• Could you share a request using the PHP SDK against the test environment that will produce an invoice with this value as null?

When I create an invoice, if there's no buyerProvidedInfo.selectedWallet, then it is not part of the response:

Replication steps will be incredibly helpful in diagnosing.

Thanks!

[doliveira-v]

Hey Bob, yes I can confirm:

"buyerProvidedInfo": {
        "selectedWallet": null,

the request I shared initially should trigger that behavior:

<?php
require('/home/sites/myapp/my_initial_script.php');

                        $bitpay = BitPaySDK\Client::create()->withData(
                                BitPaySDK\Environment::Production,
                                BITPAY_KEY_PATH,
                                new BitPaySDK\Tokens(
                                        BITPAY_TOKEN
                                ),
                                BITPAY_KEY,
                                (MY_PROXY),
                        );
var_dump($bitpay->getInvoice('3fq...cropped...Np'));

I will email you privately the transaction ID to help the investigation.

[bobbrodie]

Thanks, @doliveira-v -- this code doesn't actually create the invoice, but rather gets one that was already created. We're looking for a working example of using the PHP SDK to generate a new invoice that will produce a null value for buyerProvidedInfo.selectedWallet as we have yet to replicate.

[doliveira-v]

<?php

$bitpay = new BitPayWrapper();
$invoice = $bitpay->createInvoice($amount_usd, $item_description);


... wrapper class file


/**
	* @param $amount - Integer if it's less than 10 will return false
	* @param $item_description - Description of the invoice we are creating.
	* @param $currency - What type of currency are we making the conversion from the selected currency to bitcoin?
	* @return array(
	* 'transaction_id' => String of Bitpay invoice id
	* 'invoice_url' => String of the invoice url where users can pay
	* 'status' => String of current status of the invoice
	* ) or false on failure
	*/
	public function createInvoice(float $amount, string $item_description, string $currency = 'USD')
	{
		if ($amount < 10)
		{
			$this->addError('Minimum amount for a Bitcoin transaction is $10.00 USD.');
			return false;
		}

		$bitpay = $this->getClient();
		if ($bitpay === false)
		{
			return false;
		}

		/**
		* Test Bitcoins are at a minimum, why should I send $10 to the test environment when I can send 1.05
		* https://coinfaucet.eu/en/btc-testnet/
		* The faucet is usually closed, but when you get some it may not be many.
		*/
		/**
		if (isDevEnv())
		{
			$amount = 10;
		}
		*/

		$invoice = false;
		try
		{
			/**
			* @see https://bitpay.com/api/#rest-api-resources-invoices-resource
			* @see https://bitpay.com/api/#rest-api-resources-invoices-create-an-invoice
			*/
			$invoice = new BitPaySDK\Model\Invoice\Invoice($amount, $currency);
			$invoice->setOrderId(self::MYLEDGERNAMECONSTANT);
			$invoice->setNotificationURL(defined('MY_BIT_CALLBACK_URL') ? MY_BIT_CALLBACK_URL : '');
			/**
			* @see transactionSpeed
			* high - The invoice will go from a status of "new" to "confirmed", bypassing the "paid" status.
			* medium - The invoice will go from a status of "new" to "paid" followed by "confirmed" and then "complete"
			* low - The invoice will go from a status of "new" to "paid" followed by "complete", thus bypassing the "confirmed" status.
			*/
			$invoice->setTransactionSpeed('medium');
			$invoice->setRedirectURL($this->getRedirectURL());
			$invoice->setItemDesc($item_description);
			$invoice->setPaymentCurrencies(self::ACCEPTABLE_CURRENCIES);

			$invoice = $bitpay->createInvoice($invoice);
		}
		catch (BitPaySDK\Exceptions\BitPayException $e)
		{
			$this->addError('Unable to create an invoice please try again later.');

			$logger->log(['type' => 'generic error', 'object_ref' => $this, 'details' => 'BitPay Invoice creation failed: ' . $e->getMessage()]);

			$invoice = false;
		}

		if ($invoice === false)
		{
			return false;
		}

		return [
			'transaction_id' => $invoice->getId(),
			'invoice_url'    => $invoice->getURL(),
			'status'         => $invoice->getStatus()
		];
	}

[bobbrodie]

Thanks again, @doliveira-v. Here's where we are:

Overview

Our goal here is to replicate your issue with the SDK outside of other frameworks and logic, so I've taken your try block and implemented it in a script that accepts a token and password. The only dependency loaded by Composer is "bitpay/sdk": "7.2.0". It is a fresh composer install (I deleted composer.lock and vendor/). My project is called BitpayPHPTest and is executed with the following:

php issue_212.php --token ***** REDACTED ***** --password ***** REDACTED *****

Example Invoice Creation

Using the post in your example, I have created the following which is intended to be a simple (and not production-ready) test to have something that doesn't take custom logic or frameworks into account.

Your example wrapper class does the following, so I did the same:

• Creates an Invoice object with amount and currency
  • setOrderId()
  • setNotificationURL()
  • setTransactionSpeed()
  • setRedirectURL()
  • setItemDesc()
  • setPaymentCurrencies()
• Passes the invoice to the createInvoice() function on the BitPay client

The code you posted doesn't show us examples of the values being passed into each of the Invoice variables and functions which shouldn't make a big difference but I wouldn't rule it out, since it's an unknown.

Script

<?php
namespace SUMOHeavy\BitpayPHPTest;

use \BitPaySDK\Model\Currency;
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);
    $invoice->setOrderId('1000000000');
    $invoice->setNotificationURL('https://notification.example.com');
    $invoice->setTransactionSpeed('medium');
    $invoice->setRedirectURL('https://redirect.example.com');
    $invoice->setItemDesc("My description");
    $invoice->setPaymentCurrencies([Currency::BTC]);

    $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;
    
    print_r($this->client->getInvoice($basicInvoice->getId()));
  }
}

$options = getopt('t', ['token:', 'password:']);
if (!is_array($options)) {
  echo 'Missing required params. Please pass both --token and --password' . PHP_EOL;
  exit();
}

if (is_array($options)) {
  if (!array_key_exists('token', $options)) {
    echo 'Missing required params --token' . PHP_EOL;
    exit();
  }

  if (!array_key_exists('password', $options)) {
    echo 'Missing required params --password' . PHP_EOL;
    exit();
  }

  if (array_key_exists('token', $options) && array_key_exists('password', $options)) {
    $token    = $options['token'];
    $password = $options['password'];
    
    $invoice = new ExampleInvoice;
    $invoice->create($token, $password); 
  }
}

Output

The output from print_r($this->client->getInvoice($basicInvoice->getId())); produced the following:

BitPaySDK\Model\Invoice\Invoice Object
(
    [_currency:protected] => USD
    [_guid:protected] => 9b9bfe4a-0df7-a254-f449-7ed66ad7aa06
    [_token:protected] => 6ams3f47L2mgb4PE1v5XBdZHnosnSBR6QxyxbWbJHCmV71udWQ8Wovg9nnwEADs5qd
    [_price:protected] => 50
    [_posData:protected] => 
    [_notificationURL:protected] => 
    [_transactionSpeed:protected] => medium
    [_fullNotifications:protected] => 
    [_notificationEmail:protected] => 
    [_redirectURL:protected] => https://redirect.example.com
    [_orderId:protected] => 1000000000
    [_itemDesc:protected] => My description
    [_itemCode:protected] => 
    [_physical:protected] => 
    [_paymentCurrencies:protected] => 
    [_paymentSubtotals:protected] => stdClass Object
        (
            [BTC] => 201000
        )

    [_paymentTotals:protected] => stdClass Object
        (
            [BTC] => 201100
        )

    [_paymentDisplayTotals:protected] => 
    [_paymentDisplaySubTotals:protected] => 
    [_paymentCodes:protected] => stdClass Object
        (
            [BTC] => stdClass Object
                (
                    [BIP72b] => bitcoin:?r=https://test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1
                    [BIP73] => https://test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1
                )

        )

    [_paymentString:protected] => 
    [_verificationLink:protected] => 
    [_acceptanceWindow:protected] => 
    [_buyer:protected] => BitPaySDK\Model\Invoice\Buyer Object
        (
            [_name:protected] => 
            [_address1:protected] => 
            [_address2:protected] => 
            [_locality:protected] => 
            [_region:protected] => 
            [_postalCode:protected] => 
            [_country:protected] => 
            [_email:protected] => 
            [_phone:protected] => 
            [_notify:protected] => 
        )

    [_refundAddresses:protected] => Array
        (
        )

    [_closeURL:protected] => 
    [_autoRedirect:protected] => 
    [_jsonPayProRequired:protected] => 
    [_buyerEmail:protected] => 
    [_buyerSms:protected] => 
    [_merchantName:protected] => SUMO Heavy Industries LLC
    [_selectedTransactionCurrency:protected] => 
    [_forcedBuyerSelectedWallet:protected] => 
    [_forcedBuyerSelectedTransactionCurrency:protected] => 
    [_itemizedDetails:protected] => Array
        (
            [0] => Array
                (
                )

        )

    [_id:protected] => XycpV9YBqdWSrfQa2HJGj1
    [_url:protected] => https://test.bitpay.com/invoice?id=XycpV9YBqdWSrfQa2HJGj1
    [_status:protected] => new
    [_lowFeeDetected:protected] => 
    [_invoiceTime:protected] => 1676576343727
    [_expirationTime:protected] => 1676577243727
    [_currentTime:protected] => 1676576343949
    [_transactions:protected] => Array
        (
        )

    [_exceptionStatus:protected] => 
    [_targetConfirmations:protected] => 6
    [_refundAddressRequestPending:protected] => 
    [_buyerProvidedEmail:protected] => 
    [_buyerProvidedInfo:protected] => BitPaySDK\Model\Invoice\BuyerProvidedInfo Object
        (
            [_name:protected] => 
            [_phoneNumber:protected] => 
            [_selectedWallet:protected] => 
            [_emailAddress:protected] => 
            [_selectedTransactionCurrency:protected] => 
            [_sms:protected] => 
            [_smsVerified:protected] => 
        )

    [_transactionDetails:protected] => BitPaySDK\Model\Invoice\TransactionDetails Object
        (
            [_amount:protected] => 
            [_description:protected] => 
            [_isFee:protected] => 
        )

    [_universalCodes:protected] => BitPaySDK\Model\Invoice\UniversalCodes Object
        (
            [_paymentString:protected] => https://link.test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1
            [_verificationLink:protected] => 
        )

    [_supportedTransactionCurrencies:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrencies Object
        (
            [_btc:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 1
                    [_reason:protected] => 
                )

            [_bch:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

            [_eth:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

            [_usdc:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

            [_gusd:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

            [_pax:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

            [_xrp:protected] => BitPaySDK\Model\Invoice\SupportedTransactionCurrency Object
                (
                    [_enabled:protected] => 
                    [_reason:protected] => merchantDisabledByParam
                )

        )

    [_minerFees:protected] => BitPaySDK\Model\Invoice\MinerFees Object
        (
            [_btc:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 1
                    [_totalFee:protected] => 100
                    [_fiatAmount:protected] => 0.02
                )

            [_bch:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_eth:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_usdc:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_gusd:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_pax:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_busd:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_xrp:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_doge:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

            [_ltc:protected] => BitPaySDK\Model\Invoice\MinerFeesItem Object
                (
                    [_satoshisPerByte:protected] => 
                    [_totalFee:protected] => 
                    [_fiatAmount:protected] => 
                )

        )

    [_nonPayProPaymentReceived:protected] => 
    [_shopper:protected] => BitPaySDK\Model\Invoice\Shopper Object
        (
            [_user:protected] => 
        )

    [_billId:protected] => 
    [_refundInfo:protected] => BitPaySDK\Model\Invoice\RefundInfo Object
        (
            [_supportRequest:protected] => 
            [_currency:protected] => 
            [_amounts:protected] => 
        )

    [_extendedNotifications:protected] => 
    [_isCancelled:protected] => 
    [_transactionCurrency:protected] => 
    [_underpaidAmount:protected] => 
    [_overpaidAmount:protected] => 
    [_amountPaid:protected] => 0
    [_displayAmountPaid:protected] => 0
    [_exchangeRates:protected] => stdClass Object
        (
            [BTC] => stdClass Object
                (
                    [USD] => 24875.6
                )

        )

    [_bitpayIdRequired:protected] => 
    [_paymentDisplaytotals] => stdClass Object
        (
            [BTC] => 0.002011
        )

    [_paymentDisplaySubtotals] => stdClass Object
        (
            [BTC] => 0.002010
        )

)

Invoice JSON

This generated invoice https://test.bitpay.com/invoices/XycpV9YBqdWSrfQa2HJGj1 with the following JSON (Note: I have formatted the JSON. The actual response from the API has whitespace and newlines removed.)

{
  "facade": "public/invoice",
  "data": {
    "url": "https://test.bitpay.com/invoice?id=XycpV9YBqdWSrfQa2HJGj1",
    "status": "new",
    "price": 50,
    "currency": "USD",
    "itemDesc": "My description",
    "orderId": "1000000000",
    "invoiceTime": 1676576343727,
    "rateRefreshTime": 1676576343727,
    "expirationTime": 1676577243727,
    "currentTime": 1676576482257,
    "guid": "9b9bfe4a-0df7-a254-f449-7ed66ad7aa06",
    "id": "XycpV9YBqdWSrfQa2HJGj1",
    "lowFeeDetected": false,
    "amountPaid": 0,
    "displayAmountPaid": "0",
    "exceptionStatus": false,
    "redirectURL": "https://redirect.example.com",
    "refundAddressRequestPending": false,
    "buyerProvidedInfo": {
      "selectedTransactionCurrency": "BTC",
      "layer": null
    },
    "paymentSubtotals": {
      "BTC": 201000
    },
    "paymentTotals": {
      "BTC": 201100
    },
    "paymentDisplayTotals": {
      "BTC": "0.002011"
    },
    "paymentDisplaySubTotals": {
      "BTC": "0.002010"
    },
    "exchangeRates": {
      "BTC": {
        "USD": 24875.6
      }
    },
    "supportedTransactionCurrencies": {
      "BTC": {
        "enabled": true
      },
      "BCH": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "ETH": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "GUSD": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "PAX": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "BUSD": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "USDC": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "XRP": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "DOGE": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "LTC": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "APE": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "EUROC": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "MATIC": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "MATIC_e": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "ETH_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "USDC_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "BUSD_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "DAI_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "WBTC_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "SHIB_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "USDT": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      },
      "USDT_m": {
        "enabled": false,
        "reason": "merchantDisabledByParam"
      }
    },
    "minerFees": {
      "BTC": {
        "satoshisPerByte": 1,
        "totalFee": 100,
        "fiatAmount": 0.02
      }
    },
    "jsonPayProRequired": false,
    "itemizedDetails": [
      {}
    ],
    "universalCodes": {
      "paymentString": "https://link.test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1"
    },
    "merchantName": "SUMO Heavy Industries LLC",
    "paymentCodes": {
      "BTC": {
        "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1",
        "BIP73": "https://test.bitpay.com/i/XycpV9YBqdWSrfQa2HJGj1"
      }
    },
    "token": "767cdhmwtn7XgW1QrSkuEwiNi5XhsYqEf7LDUrHiVaAiXQFyfq6kqprXkrXpwdjKFk"
  }
}

Next Steps

As a next step to help debug your issue, it would be incredibly helpful to have a step-by-step replication script to produce an invoice with buyerProvidedInfo.selectedWallet set to null.

[doliveira-v]

I will look into this tomorrow to help with the replication but for now I'd just like to highlight that we are not having problems creating invoices but rather using the $bitpay->getInvoice() method, in a poll script that runs recurrently, maybe this will help understand the issue.

[bobbrodie]

Thanks, @doliveira-v. I’ve taken that into consideration in the post and after creating an invoice call the following:

print_r($this->client->getInvoice($basicInvoice->getId()))

The reason I can get the invoice is that I don’t have a null buyerProvidedInfo.selectedWallet (I don’t have one at all).

What we need to get to the bottom of is how you’re creating invoices that have a null value for that field. That will be really helpful.

[bobbrodie]

Hi @doliveira-v I just wanted to follow up to see if you could share the replication steps to create an invoice that results in buyerProvidedInfo.selectedWallet. My goal is to understand the root cause, so we don't just immediately open the SDK to accept a null in that field, since it shouldn't be. Resolving this for you is a priority so as soon as there's an example we'll go ahead and test. Thanks!

[doliveira-v]

Hi there, our accounts & billing team is actively collaborating on replication scenarios and I'll reply back as soon as we have enough relevant data to help the investigation, next monday/tuesday will likely be when I'll be able to share more information, stay tuned, thank you!

[bobbrodie]

Sounds great, thank you so much!

[devicenull]

@bobbrodie the docs suggest this information is provided by the person attempting to pay for the invoice:

buyerProvidedInfo
Information collected from the buyer during the process of paying an invoice. Initially this object is empty.

So I don't think you're going to get a code example that sets this to null - this seems like something that bitpay itself is doing.

[bobbrodie]

Hi @devicenull this is what we're trying to get to the bottom of with @doliveira-v and I believe you are correct. We haven't been able to accomplish setting selectedWallet to null via the SDK, and you can't mark an invoice as paid in the production environment without paying it. As you've mentioned, it could something occurring during the payment process.

Our hope is to gather more information about specific invoices that this is occurring on in their account (outside of GitHub) because I don't believe it should ever be null.

With that said, we do want to address the root problem. We could update the SDK to allow that field to be processed when it's null, but that may lead to other issues so we want to be cautious there.

[devicenull]

I work for the same company as @doliveira-v , so I'm definitely aware of this issue. We don't really have any insight into what our customers are doing with the invoice page.

We could create a support ticket, but I'm not sure if they have the ability to pull this sort of information for us.

[bobbrodie]

Got it, thanks @devicenull -- that's helpful clarification. So to confirm:

• buyerProvidedInfo.selectedWallet is not part of the resulting invoice data when your invoices are created
• After being paid by customers, buyerProvidedInfo.selectedWallet is then returned in the invoice object JSON and its value is null

Is this correct?

Just a few other questions:

• Are you seeing a null value for buyerProvidedInfo.selectedWallet on all paid invoices?
• Are all the invoices with a null value for buyerProvidedInfo.selectedWallet being paid with the same cryptocurrency?

[devicenull]

Are you seeing a null value for buyerProvidedInfo.selectedWallet on all paid invoices?
Are all the invoices with a null value for buyerProvidedInfo.selectedWallet being paid with the same cryptocurrency?

No, this is actually only on unpaid invoices. These invoices have expired (which is why we think selectedWallet is null) before they were paid.