diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 00000000..98f1e2b1
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ - package-ecosystem: "composer"
+ directory: "/"
+ schedule:
+ interval: "weekly"
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
new file mode 100644
index 00000000..188bf6ba
--- /dev/null
+++ b/.github/workflows/documentation.yml
@@ -0,0 +1,27 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - master
+
+concurrency:
+ group: documentation
+ cancel-in-progress: true
+
+jobs:
+ phpdoc:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Run phpdoc
+ run: |
+ docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 -d ./src -t ./docs
+ - name: git commit
+ run: |
+ git config user.name "GitHub Actions"
+ git config user.email ""
+ git add docs/
+ git commit -m "Update phpdoc" || echo "No changes to commit"
+ git push
\ No newline at end of file
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 00000000..fa3c6b2d
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,64 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+ phpunit9:
+ runs-on: ubuntu-20.04
+
+ strategy:
+ matrix:
+ php-version: ['8.0']
+
+ steps:
+ - uses: actions/checkout@v3
+ - uses: php-actions/composer@v5
+ with:
+ php_version: ${{ matrix.php-version }}
+ args: --ignore-platform-reqs
+ - uses: php-actions/phpunit@v3
+ with:
+ configuration: phpunit.xml
+ php_version: ${{ matrix.php-version }}
+ php_extensions: bcmath gmp xdebug
+ testsuite: Unit
+ version: 9
+ env:
+ XDEBUG_MODE: coverage
+
+ phpunit10:
+ runs-on: ubuntu-20.04
+
+ strategy:
+ matrix:
+ php-version: ['8.1', '8.2']
+
+ steps:
+ - uses: actions/checkout@v3
+ - uses: php-actions/composer@v5
+ with:
+ php_version: ${{ matrix.php-version }}
+ args: --ignore-platform-reqs
+ - uses: php-actions/phpunit@v3
+ with:
+ configuration: phpunit.xml
+ php_version: ${{ matrix.php-version }}
+ php_extensions: bcmath gmp xdebug
+ testsuite: Unit
+ version: 10
+ env:
+ XDEBUG_MODE: coverage
+
+ phpcs:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+ - uses: php-actions/composer@v5
+ with:
+ php_version: 8.1
+ php_extensions: bcmath gmp xdebug
+ - name: Install PHP_CodeSniffer
+ run: |
+ curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+ php phpcs.phar src --standard=ruleset.xml
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 65e46107..c1c6fef4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,13 @@
-composer.phar
-/vendor/
+# IDE
.idea
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+# Compose
+/vendor/
+composer.phar
+
+# phpDocumentor
+.phpdoc
+
+# PHPUnit
+.phpunit.result.cache
+test/unit/_html
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 35712894..00000000
--- a/.travis.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-language: php
-php:
- - 7.1
- - 7.2
- - 7.3
\ No newline at end of file
diff --git a/GUIDE.md b/GUIDE.md
deleted file mode 100644
index 68614d33..00000000
--- a/GUIDE.md
+++ /dev/null
@@ -1,189 +0,0 @@
-## Using the BitPay PHP client
-
-This SDK provides a convenient abstraction of BitPay's [cryptographically-secure API](https://bitpay.com/api) and allows payment gateway developers to focus on payment flow/e-commerce integration rather than on the specific details of client-server interaction using the API. This SDK optionally provides the flexibility for developers to have control over important details, including the handling of private keys needed for client-server communication.
-
-It also implements BitPay's remote client authentication and authorization strategy. No private or shared-secret information is ever transmitted over the wire.
-
-### Dependencies
-
-You must have a BitPay merchant account to use this SDK. It's free to [sign-up for a BitPay merchant account](https://bitpay.com/start).
-
-If you need a test account, please visit https://test.bitpay.com/dashboard/signup and register for a BitPay merchant test account. Please fill in all questions, so you get a fully working test account.
-If you are looking for a testnet bitcoin wallet to test with, please visit https://bitpay.com/wallet and
-create a new wallet.
-If you need testnet bitcoin please visit a testnet faucet, e.g. https://testnet.coinfaucet.eu/en/ or http://tpfaucet.appspot.com/
-
-For more information about testing, please see https://bitpay.com/docs/testing
-
-### Handling your client private key
-
-Each client paired with the BitPay server requires a ECDSA key. This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard. The public key is also used for securely signing all API requests from the client. See the [BitPay API](https://bitpay.com/api) for more information.
-
-The private key should be stored in the client environment such that it cannot be compromised. If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the [API tokens](https://bitpay.com/api-tokens) for more information.
-
-To generate the configuration file required to load the SDK:
-
-The [BitPay Config Generator](https://github.com/bitpay/php-bitpay-client-v2/blob/master/examples/ConfigGenerator.php) helps to generate the private key, as well as a environment file formatted in JSON or YML which contains all configuration requirements, that should be stored in the client local file system. It is not recommended to transmit the private key over any public or unsecure networks.
-
-The comments in this script will assist you to create the environment file which you will be able to modify it later.
-
-Once the Config Generator has run and generated the Json/Yml correctly, read the console output and follow the instructions in order to pair your new tokens.
-
-The environment file can be either generated by the script mentioned avobe or created manually by copying the following Json or YML structure:
-
-JSON:
-```json
-{
- "BitPayConfiguration": {
- "Environment": "",
- "EnvConfig": {
- "Test": {
- "PrivateKeyPath": "",
- "PrivateKeySecret": "",
- "ApiTokens": {
- "merchant": "",
- "payroll": ""
- }
- },
- "Prod": {
- "PrivateKeyPath": "",
- "PrivateKeySecret": "",
- "ApiTokens": {
- "merchant": "",
- "payroll": ""
- }
- }
- }
- }
-}
-```
-##
-YML:
-```yml
-BitPayConfiguration:
- Environment: null
- EnvConfig:
- Test:
- PrivateKeyPath: null
- PrivateKeySecret: null
- ApiTokens:
- merchant: null
- payroll: null
- Prod:
- PrivateKeyPath: null
- ApiTokens:
- merchant: null
- payroll: null
-```
-
-# Installation
-
-## Composer
-
-### Install Composer
-
-```bash
-curl -sS https://getcomposer.org/installer | php
-```
-
-### Install via composer by hand
-
-Add to your composer.json file by hand.
-
-```javascript
-{
- ...
- "require": {
- ...
- "bitpay/sdk": "~3.0"
- }
- ...
-}
-```
-
-Once you have added this, just run:
-
-```bash
-php composer.phar update bitpay/sdk
-```
-
-### Install using composer
-
-```bash
-php composer.phar require bitpay/sdk:~3.0
-```
-
-### Initializing your BitPay client
-
-Once you have the environment file (JSON or YML previously generated) you can initialize the client on two different ways:
-
-```php
-// Provide the full path to the env file which you have previously stored securely.
-
-$bitpay = BitPaySDK\Client::create()->withFile([FULL_PATH_TO_THE_CONFIG_FILE]);
-```
-
-```php
-// Initialize with separate variables
-// and Private Key stored in file.
-
-$bitpay = BitPaySDK\Client::create()->withData(
- BitPaySDK\Env.Test,
- "[FULL_PATH_TO_THE_PRIVATE_KEY]",
- new BitPaySDK\Tokens(
- "7UeQtMcsHamehE4gDZojUQbNRbSuSdggbH17sawtobGJ", //merchant
- "5j48K7pUrX5k59DLhRVYkCupgw2CtoEt8DBFrHo2vW47" //payroll
- ),
- "YourMasterPassword" //used to decrypt your private key, if encrypted
-);
-```
-```php
-// Initialize with separate variables
-// and Private Key as HEX string.
-
-$bitpay = BitPaySDK\Client::create()->withData(
- BitPaySDK\Env.Test,
- "[PRIVATE_KEY_AS_HEX_STRING]",
- new BitPaySDK\Tokens(
- "7UeQtMcsHamehE4gDZojUQbNRbSuSdggbH17sawtobGJ", //merchant
- "5j48K7pUrX5k59DLhRVYkCupgw2CtoEt8DBFrHo2vW47" //payroll
- )
-);
-```
-##
-### Create an invoice
-
-```php
-$invoice = $bitpay->createInvoice(new Invoice(50.0, "USD"));
-
-$invoiceUrl = $invoice->getURL();
-
-$status = $invoice->getStatus();
-```
-
-> **WARNING**:
-If you get the following error when initiating the client for first time:
-"500 Internal Server Error` response: {"error":"Account not setup completely yet."}"
-Please, go back to your BitPay account and complete the required steps.
-More info [here](https://support.bitpay.com/hc/en-us/articles/203010446-How-do-I-apply-for-a-merchant-account-)
-
-### Retrieve an invoice
-
-```php
-$invoice = $bitpay->getInvoice($invoice->getId());
-```
-
-### Get exchange Rates
-
-You can retrieve BitPay's [BBB exchange rates](https://bitpay.com/exchange-rates).
-
-```php
-$rates = $bitpay->getRates();
-
-$rate = $rates->getRate(Currency::USD); //Always use the included Currency model to avoid typos
-
-$rates->update();
-```
-
-See also the test package for more examples of API calls.
-
diff --git a/README.md b/README.md
index 87f6f1c3..b7a83964 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,65 @@
-
+
# BitPay PHP Client
[](https://raw.githubusercontent.com/bitpay/php-bitpay-client-v2/master/LICENSE)
[](https://packagist.org/packages/bitpay/sdk)
[](https://packagist.org/packages/bitpay/sdk)
-[](https://packagist.org/packages/bitpay/sdk)
-Full implementation of the BitPay Payment Gateway. This library implements BitPay's [Cryptographically Secure RESTful API](https://bitpay.com/api).
-
-Our Lite version will most likely be all you need to integrate to your site, available [here](https://github.com/bitpay/php-bitpay-light-client)
+Full implementation of the BitPay Payment Gateway. This library implements BitPay's [Cryptographically Secure RESTful API](https://developer.bitpay.com/reference/concepts).
## Getting Started
-To get up and running with our PHP library quickly, follow [The GUIDE](https://github.com/bitpay/php-bitpay-client-v2/blob/master/GUIDE.md)
+To get up and running with our PHP library quickly, follow [the guide](https://bitpay.readme.io/reference/php-full-sdk-getting-started)
## Support
* https://github.com/bitpay/php-bitpay-client-v2/issues
* https://support.bitpay.com
+### Requirements
+
+- PHP version: 8.0 / 8.1 / 8.2
+- PHP extensions: json, reflection
+
+## Unit Tests
+```php
+./vendor/bin/phpunit --testsuite "Unit"
+```
+
+## Functional Tests
+
+To run functional tests you will need to perform the following steps.
+
+### Generate Configuration
+
+
+Run the following command to generate `BitPay.config.yml`:
+
+```bash
+composer setup
+```
+
+Copy `BitPay.config.yml` to the `test/functional/BitPaySDK` directory.
+
+Copy `PrivateKeyName.key` to the `setup` directory.
+
+### Create Recipient
+
+To submit requests you should:
+
+1. Create a recipient in https://test.bitpay.com/dashboard/payouts/recipients
+2. Accept the invite in the recipient's email inbox
+3. Create a file at `test/functional/BitPaySDK/email.txt` containing the email
+ address of the recipient you created in step 1.
+
+### Run the Functional Tests
+
+Run the following command to execute the functional tests:
+
+```php
+./vendor/bin/phpunit --testsuite "Functional"
+```
+
## Contribute
To contribute to this project, please fork and submit a pull request.
diff --git a/composer.json b/composer.json
index 50ce9e49..acc652de 100644
--- a/composer.json
+++ b/composer.json
@@ -12,12 +12,13 @@
],
"homepage": "https://github.com/bitpay/php-bitpay-client-v2",
"require": {
- "bitpay/key-utils": "^1.0",
- "php": "^7.1",
- "guzzlehttp/guzzle": "^6.3",
+ "php": "^8.0 || ^8.1 || ^8.2",
"ext-json": "*",
"ext-reflection": "*",
- "symfony/yaml": "^3.0 || ^4.3"
+ "bitpay/key-utils": "^1.1",
+ "guzzlehttp/guzzle": "^7.0",
+ "symfony/yaml": "^5.4 || ^6.0 || ^6.1 || ^6.2",
+ "netresearch/jsonmapper": "^4.1"
},
"authors": [
{
@@ -26,16 +27,22 @@
}
],
"require-dev": {
- "phpunit/phpunit": "^7.5"
+ "phpunit/phpunit": "^9.0 || ^10.2.2"
+ },
+ "scripts": {
+ "setup": [
+ "php setup/ConfigGenerator.php"
+ ]
},
"autoload": {
"psr-4": {
- "": "src/"
+ "BitPaySDK\\": "src/BitPaySDK"
}
},
"autoload-dev": {
"psr-4": {
- "BitPaySDK\\Test\\": "tests/"
+ "BitPaySDK\\Test\\": "test/unit/BitPaySDK",
+ "BitPaySDK\\Functional\\": "test/functional/BitPaySDK"
}
}
}
diff --git a/composer.lock b/composer.lock
index 1f054906..db7dcf5f 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,30 +4,35 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
- "content-hash": "a54038a9842f8776f6679ea1d030209f",
+ "content-hash": "451eb76a8505f9377f6bc5294dfcc1c8",
"packages": [
{
"name": "bitpay/key-utils",
- "version": "v1.0.1908",
+ "version": "1.1.2",
"source": {
"type": "git",
"url": "https://github.com/bitpay/bitpay-php-keyutils.git",
- "reference": "004edafa83bf08dc1ec4a7bdd75d5663882ce073"
+ "reference": "44283014751d1886b41c7de29f1972737d6dfe4d"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/bitpay/bitpay-php-keyutils/zipball/004edafa83bf08dc1ec4a7bdd75d5663882ce073",
- "reference": "004edafa83bf08dc1ec4a7bdd75d5663882ce073",
+ "url": "https://api.github.com/repos/bitpay/bitpay-php-keyutils/zipball/44283014751d1886b41c7de29f1972737d6dfe4d",
+ "reference": "44283014751d1886b41c7de29f1972737d6dfe4d",
"shasum": ""
},
"require": {
"ext-bcmath": "*",
"ext-curl": "*",
- "ext-gmp": "*",
"ext-iconv": "*",
"ext-json": "*",
"ext-openssl": "*"
},
+ "require-dev": {
+ "phpunit/phpunit": "^7.5 || ^9.0"
+ },
+ "suggest": {
+ "ext-gmp": "Required to use this package with GMP instead of BCMath"
+ },
"type": "library",
"autoload": {
"psr-4": {
@@ -45,181 +50,304 @@
}
],
"description": "BitPay Utils pack for cryptography",
- "time": "2019-08-19T16:42:16+00:00"
+ "support": {
+ "issues": "https://github.com/bitpay/bitpay-php-keyutils/issues",
+ "source": "https://github.com/bitpay/bitpay-php-keyutils/tree/1.1.2"
+ },
+ "time": "2023-06-15T19:11:27+00:00"
},
{
"name": "guzzlehttp/guzzle",
- "version": "6.4.1",
+ "version": "7.7.0",
"source": {
"type": "git",
"url": "https://github.com/guzzle/guzzle.git",
- "reference": "0895c932405407fd3a7368b6910c09a24d26db11"
+ "reference": "fb7566caccf22d74d1ab270de3551f72a58399f5"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/guzzle/guzzle/zipball/0895c932405407fd3a7368b6910c09a24d26db11",
- "reference": "0895c932405407fd3a7368b6910c09a24d26db11",
+ "url": "https://api.github.com/repos/guzzle/guzzle/zipball/fb7566caccf22d74d1ab270de3551f72a58399f5",
+ "reference": "fb7566caccf22d74d1ab270de3551f72a58399f5",
"shasum": ""
},
"require": {
"ext-json": "*",
- "guzzlehttp/promises": "^1.0",
- "guzzlehttp/psr7": "^1.6.1",
- "php": ">=5.5"
+ "guzzlehttp/promises": "^1.5.3 || ^2.0",
+ "guzzlehttp/psr7": "^1.9.1 || ^2.4.5",
+ "php": "^7.2.5 || ^8.0",
+ "psr/http-client": "^1.0",
+ "symfony/deprecation-contracts": "^2.2 || ^3.0"
+ },
+ "provide": {
+ "psr/http-client-implementation": "1.0"
},
"require-dev": {
+ "bamarni/composer-bin-plugin": "^1.8.1",
"ext-curl": "*",
- "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.4 || ^7.0",
- "psr/log": "^1.1"
+ "php-http/client-integration-tests": "dev-master#2c025848417c1135031fdf9c728ee53d0a7ceaee as 3.0.999",
+ "php-http/message-factory": "^1.1",
+ "phpunit/phpunit": "^8.5.29 || ^9.5.23",
+ "psr/log": "^1.1 || ^2.0 || ^3.0"
},
"suggest": {
+ "ext-curl": "Required for CURL handler support",
+ "ext-intl": "Required for Internationalized Domain Name (IDN) support",
"psr/log": "Required for using the Log middleware"
},
"type": "library",
"extra": {
- "branch-alias": {
- "dev-master": "6.3-dev"
+ "bamarni-bin": {
+ "bin-links": true,
+ "forward-command": false
}
},
"autoload": {
- "psr-4": {
- "GuzzleHttp\\": "src/"
- },
"files": [
"src/functions_include.php"
- ]
+ ],
+ "psr-4": {
+ "GuzzleHttp\\": "src/"
+ }
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
+ {
+ "name": "Graham Campbell",
+ "email": "hello@gjcampbell.co.uk",
+ "homepage": "https://github.com/GrahamCampbell"
+ },
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
+ },
+ {
+ "name": "Jeremy Lindblom",
+ "email": "jeremeamia@gmail.com",
+ "homepage": "https://github.com/jeremeamia"
+ },
+ {
+ "name": "George Mponos",
+ "email": "gmponos@gmail.com",
+ "homepage": "https://github.com/gmponos"
+ },
+ {
+ "name": "Tobias Nyholm",
+ "email": "tobias.nyholm@gmail.com",
+ "homepage": "https://github.com/Nyholm"
+ },
+ {
+ "name": "Márk Sági-Kazár",
+ "email": "mark.sagikazar@gmail.com",
+ "homepage": "https://github.com/sagikazarmark"
+ },
+ {
+ "name": "Tobias Schultze",
+ "email": "webmaster@tubo-world.de",
+ "homepage": "https://github.com/Tobion"
}
],
"description": "Guzzle is a PHP HTTP client library",
- "homepage": "http://guzzlephp.org/",
"keywords": [
"client",
"curl",
"framework",
"http",
"http client",
+ "psr-18",
+ "psr-7",
"rest",
"web service"
],
- "time": "2019-10-23T15:58:00+00:00"
+ "support": {
+ "issues": "https://github.com/guzzle/guzzle/issues",
+ "source": "https://github.com/guzzle/guzzle/tree/7.7.0"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/GrahamCampbell",
+ "type": "github"
+ },
+ {
+ "url": "https://github.com/Nyholm",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2023-05-21T14:04:53+00:00"
},
{
"name": "guzzlehttp/promises",
- "version": "v1.3.1",
+ "version": "2.0.0",
"source": {
"type": "git",
"url": "https://github.com/guzzle/promises.git",
- "reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646"
+ "reference": "3a494dc7dc1d7d12e511890177ae2d0e6c107da6"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/guzzle/promises/zipball/a59da6cf61d80060647ff4d3eb2c03a2bc694646",
- "reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646",
+ "url": "https://api.github.com/repos/guzzle/promises/zipball/3a494dc7dc1d7d12e511890177ae2d0e6c107da6",
+ "reference": "3a494dc7dc1d7d12e511890177ae2d0e6c107da6",
"shasum": ""
},
"require": {
- "php": ">=5.5.0"
+ "php": "^7.2.5 || ^8.0"
},
"require-dev": {
- "phpunit/phpunit": "^4.0"
+ "bamarni/composer-bin-plugin": "^1.8.1",
+ "phpunit/phpunit": "^8.5.29 || ^9.5.23"
},
"type": "library",
"extra": {
- "branch-alias": {
- "dev-master": "1.4-dev"
+ "bamarni-bin": {
+ "bin-links": true,
+ "forward-command": false
}
},
"autoload": {
"psr-4": {
"GuzzleHttp\\Promise\\": "src/"
- },
- "files": [
- "src/functions_include.php"
- ]
+ }
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
+ {
+ "name": "Graham Campbell",
+ "email": "hello@gjcampbell.co.uk",
+ "homepage": "https://github.com/GrahamCampbell"
+ },
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
+ },
+ {
+ "name": "Tobias Nyholm",
+ "email": "tobias.nyholm@gmail.com",
+ "homepage": "https://github.com/Nyholm"
+ },
+ {
+ "name": "Tobias Schultze",
+ "email": "webmaster@tubo-world.de",
+ "homepage": "https://github.com/Tobion"
}
],
"description": "Guzzle promises library",
"keywords": [
"promise"
],
- "time": "2016-12-20T10:07:11+00:00"
+ "support": {
+ "issues": "https://github.com/guzzle/promises/issues",
+ "source": "https://github.com/guzzle/promises/tree/2.0.0"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/GrahamCampbell",
+ "type": "github"
+ },
+ {
+ "url": "https://github.com/Nyholm",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2023-05-21T13:50:22+00:00"
},
{
"name": "guzzlehttp/psr7",
- "version": "1.6.1",
+ "version": "2.5.0",
"source": {
"type": "git",
"url": "https://github.com/guzzle/psr7.git",
- "reference": "239400de7a173fe9901b9ac7c06497751f00727a"
+ "reference": "b635f279edd83fc275f822a1188157ffea568ff6"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/guzzle/psr7/zipball/239400de7a173fe9901b9ac7c06497751f00727a",
- "reference": "239400de7a173fe9901b9ac7c06497751f00727a",
+ "url": "https://api.github.com/repos/guzzle/psr7/zipball/b635f279edd83fc275f822a1188157ffea568ff6",
+ "reference": "b635f279edd83fc275f822a1188157ffea568ff6",
"shasum": ""
},
"require": {
- "php": ">=5.4.0",
- "psr/http-message": "~1.0",
- "ralouphie/getallheaders": "^2.0.5 || ^3.0.0"
+ "php": "^7.2.5 || ^8.0",
+ "psr/http-factory": "^1.0",
+ "psr/http-message": "^1.1 || ^2.0",
+ "ralouphie/getallheaders": "^3.0"
},
"provide": {
+ "psr/http-factory-implementation": "1.0",
"psr/http-message-implementation": "1.0"
},
"require-dev": {
- "ext-zlib": "*",
- "phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.8"
+ "bamarni/composer-bin-plugin": "^1.8.1",
+ "http-interop/http-factory-tests": "^0.9",
+ "phpunit/phpunit": "^8.5.29 || ^9.5.23"
},
"suggest": {
- "zendframework/zend-httphandlerrunner": "Emit PSR-7 responses"
+ "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses"
},
"type": "library",
"extra": {
- "branch-alias": {
- "dev-master": "1.6-dev"
+ "bamarni-bin": {
+ "bin-links": true,
+ "forward-command": false
}
},
"autoload": {
"psr-4": {
"GuzzleHttp\\Psr7\\": "src/"
- },
- "files": [
- "src/functions_include.php"
- ]
+ }
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
+ {
+ "name": "Graham Campbell",
+ "email": "hello@gjcampbell.co.uk",
+ "homepage": "https://github.com/GrahamCampbell"
+ },
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
},
+ {
+ "name": "George Mponos",
+ "email": "gmponos@gmail.com",
+ "homepage": "https://github.com/gmponos"
+ },
+ {
+ "name": "Tobias Nyholm",
+ "email": "tobias.nyholm@gmail.com",
+ "homepage": "https://github.com/Nyholm"
+ },
+ {
+ "name": "Márk Sági-Kazár",
+ "email": "mark.sagikazar@gmail.com",
+ "homepage": "https://github.com/sagikazarmark"
+ },
{
"name": "Tobias Schultze",
+ "email": "webmaster@tubo-world.de",
"homepage": "https://github.com/Tobion"
+ },
+ {
+ "name": "Márk Sági-Kazár",
+ "email": "mark.sagikazar@gmail.com",
+ "homepage": "https://sagikazarmark.hu/"
}
],
"description": "PSR-7 message implementation that also provides common utility methods",
@@ -233,29 +361,205 @@
"uri",
"url"
],
- "time": "2019-07-01T23:21:34+00:00"
+ "support": {
+ "issues": "https://github.com/guzzle/psr7/issues",
+ "source": "https://github.com/guzzle/psr7/tree/2.5.0"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/GrahamCampbell",
+ "type": "github"
+ },
+ {
+ "url": "https://github.com/Nyholm",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2023-04-17T16:11:26+00:00"
+ },
+ {
+ "name": "netresearch/jsonmapper",
+ "version": "v4.2.0",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/cweiske/jsonmapper.git",
+ "reference": "f60565f8c0566a31acf06884cdaa591867ecc956"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/cweiske/jsonmapper/zipball/f60565f8c0566a31acf06884cdaa591867ecc956",
+ "reference": "f60565f8c0566a31acf06884cdaa591867ecc956",
+ "shasum": ""
+ },
+ "require": {
+ "ext-json": "*",
+ "ext-pcre": "*",
+ "ext-reflection": "*",
+ "ext-spl": "*",
+ "php": ">=7.1"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "~7.5 || ~8.0 || ~9.0",
+ "squizlabs/php_codesniffer": "~3.5"
+ },
+ "type": "library",
+ "autoload": {
+ "psr-0": {
+ "JsonMapper": "src/"
+ }
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "OSL-3.0"
+ ],
+ "authors": [
+ {
+ "name": "Christian Weiske",
+ "email": "cweiske@cweiske.de",
+ "homepage": "http://github.com/cweiske/jsonmapper/",
+ "role": "Developer"
+ }
+ ],
+ "description": "Map nested JSON structures onto PHP classes",
+ "support": {
+ "email": "cweiske@cweiske.de",
+ "issues": "https://github.com/cweiske/jsonmapper/issues",
+ "source": "https://github.com/cweiske/jsonmapper/tree/v4.2.0"
+ },
+ "time": "2023-04-09T17:37:40+00:00"
+ },
+ {
+ "name": "psr/http-client",
+ "version": "1.0.2",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/php-fig/http-client.git",
+ "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/php-fig/http-client/zipball/0955afe48220520692d2d09f7ab7e0f93ffd6a31",
+ "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31",
+ "shasum": ""
+ },
+ "require": {
+ "php": "^7.0 || ^8.0",
+ "psr/http-message": "^1.0 || ^2.0"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "1.0.x-dev"
+ }
+ },
+ "autoload": {
+ "psr-4": {
+ "Psr\\Http\\Client\\": "src/"
+ }
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "MIT"
+ ],
+ "authors": [
+ {
+ "name": "PHP-FIG",
+ "homepage": "https://www.php-fig.org/"
+ }
+ ],
+ "description": "Common interface for HTTP clients",
+ "homepage": "https://github.com/php-fig/http-client",
+ "keywords": [
+ "http",
+ "http-client",
+ "psr",
+ "psr-18"
+ ],
+ "support": {
+ "source": "https://github.com/php-fig/http-client/tree/1.0.2"
+ },
+ "time": "2023-04-10T20:12:12+00:00"
+ },
+ {
+ "name": "psr/http-factory",
+ "version": "1.0.2",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/php-fig/http-factory.git",
+ "reference": "e616d01114759c4c489f93b099585439f795fe35"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/php-fig/http-factory/zipball/e616d01114759c4c489f93b099585439f795fe35",
+ "reference": "e616d01114759c4c489f93b099585439f795fe35",
+ "shasum": ""
+ },
+ "require": {
+ "php": ">=7.0.0",
+ "psr/http-message": "^1.0 || ^2.0"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "1.0.x-dev"
+ }
+ },
+ "autoload": {
+ "psr-4": {
+ "Psr\\Http\\Message\\": "src/"
+ }
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "MIT"
+ ],
+ "authors": [
+ {
+ "name": "PHP-FIG",
+ "homepage": "https://www.php-fig.org/"
+ }
+ ],
+ "description": "Common interfaces for PSR-7 HTTP message factories",
+ "keywords": [
+ "factory",
+ "http",
+ "message",
+ "psr",
+ "psr-17",
+ "psr-7",
+ "request",
+ "response"
+ ],
+ "support": {
+ "source": "https://github.com/php-fig/http-factory/tree/1.0.2"
+ },
+ "time": "2023-04-10T20:10:41+00:00"
},
{
"name": "psr/http-message",
- "version": "1.0.1",
+ "version": "2.0",
"source": {
"type": "git",
"url": "https://github.com/php-fig/http-message.git",
- "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363"
+ "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363",
- "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363",
+ "url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71",
+ "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71",
"shasum": ""
},
"require": {
- "php": ">=5.3.0"
+ "php": "^7.2 || ^8.0"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.0.x-dev"
+ "dev-master": "2.0.x-dev"
}
},
"autoload": {
@@ -270,7 +574,7 @@
"authors": [
{
"name": "PHP-FIG",
- "homepage": "http://www.php-fig.org/"
+ "homepage": "https://www.php-fig.org/"
}
],
"description": "Common interface for HTTP messages",
@@ -283,7 +587,10 @@
"request",
"response"
],
- "time": "2016-08-06T14:39:51+00:00"
+ "support": {
+ "source": "https://github.com/php-fig/http-message/tree/2.0"
+ },
+ "time": "2023-04-04T09:54:51+00:00"
},
{
"name": "ralouphie/getallheaders",
@@ -323,24 +630,98 @@
}
],
"description": "A polyfill for getallheaders.",
+ "support": {
+ "issues": "https://github.com/ralouphie/getallheaders/issues",
+ "source": "https://github.com/ralouphie/getallheaders/tree/develop"
+ },
"time": "2019-03-08T08:55:37+00:00"
},
+ {
+ "name": "symfony/deprecation-contracts",
+ "version": "v3.0.2",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/symfony/deprecation-contracts.git",
+ "reference": "26954b3d62a6c5fd0ea8a2a00c0353a14978d05c"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/26954b3d62a6c5fd0ea8a2a00c0353a14978d05c",
+ "reference": "26954b3d62a6c5fd0ea8a2a00c0353a14978d05c",
+ "shasum": ""
+ },
+ "require": {
+ "php": ">=8.0.2"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-main": "3.0-dev"
+ },
+ "thanks": {
+ "name": "symfony/contracts",
+ "url": "https://github.com/symfony/contracts"
+ }
+ },
+ "autoload": {
+ "files": [
+ "function.php"
+ ]
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "MIT"
+ ],
+ "authors": [
+ {
+ "name": "Nicolas Grekas",
+ "email": "p@tchwork.com"
+ },
+ {
+ "name": "Symfony Community",
+ "homepage": "https://symfony.com/contributors"
+ }
+ ],
+ "description": "A generic function and convention to trigger deprecation notices",
+ "homepage": "https://symfony.com/",
+ "support": {
+ "source": "https://github.com/symfony/deprecation-contracts/tree/v3.0.2"
+ },
+ "funding": [
+ {
+ "url": "https://symfony.com/sponsor",
+ "type": "custom"
+ },
+ {
+ "url": "https://github.com/fabpot",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2022-01-02T09:55:41+00:00"
+ },
{
"name": "symfony/polyfill-ctype",
- "version": "v1.12.0",
+ "version": "v1.27.0",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-ctype.git",
- "reference": "550ebaac289296ce228a706d0867afc34687e3f4"
+ "reference": "5bbc823adecdae860bb64756d639ecfec17b050a"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/550ebaac289296ce228a706d0867afc34687e3f4",
- "reference": "550ebaac289296ce228a706d0867afc34687e3f4",
+ "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/5bbc823adecdae860bb64756d639ecfec17b050a",
+ "reference": "5bbc823adecdae860bb64756d639ecfec17b050a",
"shasum": ""
},
"require": {
- "php": ">=5.3.3"
+ "php": ">=7.1"
+ },
+ "provide": {
+ "ext-ctype": "*"
},
"suggest": {
"ext-ctype": "For best performance"
@@ -348,16 +729,20 @@
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.12-dev"
+ "dev-main": "1.27-dev"
+ },
+ "thanks": {
+ "name": "symfony/polyfill",
+ "url": "https://github.com/symfony/polyfill"
}
},
"autoload": {
- "psr-4": {
- "Symfony\\Polyfill\\Ctype\\": ""
- },
"files": [
"bootstrap.php"
- ]
+ ],
+ "psr-4": {
+ "Symfony\\Polyfill\\Ctype\\": ""
+ }
},
"notification-url": "https://packagist.org/downloads/",
"license": [
@@ -381,41 +766,56 @@
"polyfill",
"portable"
],
- "time": "2019-08-06T08:03:45+00:00"
+ "support": {
+ "source": "https://github.com/symfony/polyfill-ctype/tree/v1.27.0"
+ },
+ "funding": [
+ {
+ "url": "https://symfony.com/sponsor",
+ "type": "custom"
+ },
+ {
+ "url": "https://github.com/fabpot",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2022-11-03T14:55:06+00:00"
},
{
"name": "symfony/yaml",
- "version": "v4.3.8",
+ "version": "v6.0.19",
"source": {
"type": "git",
"url": "https://github.com/symfony/yaml.git",
- "reference": "324cf4b19c345465fad14f3602050519e09e361d"
+ "reference": "deec3a812a0305a50db8ae689b183f43d915c884"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/symfony/yaml/zipball/324cf4b19c345465fad14f3602050519e09e361d",
- "reference": "324cf4b19c345465fad14f3602050519e09e361d",
+ "url": "https://api.github.com/repos/symfony/yaml/zipball/deec3a812a0305a50db8ae689b183f43d915c884",
+ "reference": "deec3a812a0305a50db8ae689b183f43d915c884",
"shasum": ""
},
"require": {
- "php": "^7.1.3",
- "symfony/polyfill-ctype": "~1.8"
+ "php": ">=8.0.2",
+ "symfony/polyfill-ctype": "^1.8"
},
"conflict": {
- "symfony/console": "<3.4"
+ "symfony/console": "<5.4"
},
"require-dev": {
- "symfony/console": "~3.4|~4.0"
+ "symfony/console": "^5.4|^6.0"
},
"suggest": {
"symfony/console": "For validating YAML files using the lint command"
},
+ "bin": [
+ "Resources/bin/yaml-lint"
+ ],
"type": "library",
- "extra": {
- "branch-alias": {
- "dev-master": "4.3-dev"
- }
- },
"autoload": {
"psr-4": {
"Symfony\\Component\\Yaml\\": ""
@@ -438,44 +838,57 @@
"homepage": "https://symfony.com/contributors"
}
],
- "description": "Symfony Yaml Component",
+ "description": "Loads and dumps YAML files",
"homepage": "https://symfony.com/",
- "time": "2019-10-30T12:58:49+00:00"
+ "support": {
+ "source": "https://github.com/symfony/yaml/tree/v6.0.19"
+ },
+ "funding": [
+ {
+ "url": "https://symfony.com/sponsor",
+ "type": "custom"
+ },
+ {
+ "url": "https://github.com/fabpot",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2023-01-11T11:50:03+00:00"
}
],
"packages-dev": [
{
"name": "doctrine/instantiator",
- "version": "1.3.0",
+ "version": "2.0.0",
"source": {
"type": "git",
"url": "https://github.com/doctrine/instantiator.git",
- "reference": "ae466f726242e637cebdd526a7d991b9433bacf1"
+ "reference": "c6222283fa3f4ac679f8b9ced9a4e23f163e80d0"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/doctrine/instantiator/zipball/ae466f726242e637cebdd526a7d991b9433bacf1",
- "reference": "ae466f726242e637cebdd526a7d991b9433bacf1",
+ "url": "https://api.github.com/repos/doctrine/instantiator/zipball/c6222283fa3f4ac679f8b9ced9a4e23f163e80d0",
+ "reference": "c6222283fa3f4ac679f8b9ced9a4e23f163e80d0",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": "^8.1"
},
"require-dev": {
- "doctrine/coding-standard": "^6.0",
- "ext-pdo": "*",
- "ext-phar": "*",
- "phpbench/phpbench": "^0.13",
- "phpstan/phpstan-phpunit": "^0.11",
- "phpstan/phpstan-shim": "^0.11",
- "phpunit/phpunit": "^7.0"
- },
- "type": "library",
- "extra": {
- "branch-alias": {
- "dev-master": "1.2.x-dev"
- }
+ "doctrine/coding-standard": "^11",
+ "ext-pdo": "*",
+ "ext-phar": "*",
+ "phpbench/phpbench": "^1.2",
+ "phpstan/phpstan": "^1.9.4",
+ "phpstan/phpstan-phpunit": "^1.3",
+ "phpunit/phpunit": "^9.5.27",
+ "vimeo/psalm": "^5.4"
},
+ "type": "library",
"autoload": {
"psr-4": {
"Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/"
@@ -489,7 +902,7 @@
{
"name": "Marco Pivetta",
"email": "ocramius@gmail.com",
- "homepage": "http://ocramius.github.com/"
+ "homepage": "https://ocramius.github.io/"
}
],
"description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors",
@@ -498,41 +911,60 @@
"constructor",
"instantiate"
],
- "time": "2019-10-21T16:45:58+00:00"
+ "support": {
+ "issues": "https://github.com/doctrine/instantiator/issues",
+ "source": "https://github.com/doctrine/instantiator/tree/2.0.0"
+ },
+ "funding": [
+ {
+ "url": "https://www.doctrine-project.org/sponsorship.html",
+ "type": "custom"
+ },
+ {
+ "url": "https://www.patreon.com/phpdoctrine",
+ "type": "patreon"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/doctrine%2Finstantiator",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2022-12-30T00:23:10+00:00"
},
{
"name": "myclabs/deep-copy",
- "version": "1.9.3",
+ "version": "1.11.1",
"source": {
"type": "git",
"url": "https://github.com/myclabs/DeepCopy.git",
- "reference": "007c053ae6f31bba39dfa19a7726f56e9763bbea"
+ "reference": "7284c22080590fb39f2ffa3e9057f10a4ddd0e0c"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/007c053ae6f31bba39dfa19a7726f56e9763bbea",
- "reference": "007c053ae6f31bba39dfa19a7726f56e9763bbea",
+ "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/7284c22080590fb39f2ffa3e9057f10a4ddd0e0c",
+ "reference": "7284c22080590fb39f2ffa3e9057f10a4ddd0e0c",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": "^7.1 || ^8.0"
},
- "replace": {
- "myclabs/deep-copy": "self.version"
+ "conflict": {
+ "doctrine/collections": "<1.6.8",
+ "doctrine/common": "<2.13.3 || >=3,<3.2.2"
},
"require-dev": {
- "doctrine/collections": "^1.0",
- "doctrine/common": "^2.6",
- "phpunit/phpunit": "^7.1"
+ "doctrine/collections": "^1.6.8",
+ "doctrine/common": "^2.13.3 || ^3.2.2",
+ "phpunit/phpunit": "^7.5.20 || ^8.5.23 || ^9.5.13"
},
"type": "library",
"autoload": {
- "psr-4": {
- "DeepCopy\\": "src/DeepCopy/"
- },
"files": [
"src/DeepCopy/deep_copy.php"
- ]
+ ],
+ "psr-4": {
+ "DeepCopy\\": "src/DeepCopy/"
+ }
},
"notification-url": "https://packagist.org/downloads/",
"license": [
@@ -546,32 +978,99 @@
"object",
"object graph"
],
- "time": "2019-08-09T12:45:53+00:00"
+ "support": {
+ "issues": "https://github.com/myclabs/DeepCopy/issues",
+ "source": "https://github.com/myclabs/DeepCopy/tree/1.11.1"
+ },
+ "funding": [
+ {
+ "url": "https://tidelift.com/funding/github/packagist/myclabs/deep-copy",
+ "type": "tidelift"
+ }
+ ],
+ "time": "2023-03-08T13:26:56+00:00"
+ },
+ {
+ "name": "nikic/php-parser",
+ "version": "v4.17.1",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/nikic/PHP-Parser.git",
+ "reference": "a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d",
+ "reference": "a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d",
+ "shasum": ""
+ },
+ "require": {
+ "ext-tokenizer": "*",
+ "php": ">=7.0"
+ },
+ "require-dev": {
+ "ircmaxell/php-yacc": "^0.0.7",
+ "phpunit/phpunit": "^6.5 || ^7.0 || ^8.0 || ^9.0"
+ },
+ "bin": [
+ "bin/php-parse"
+ ],
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "4.9-dev"
+ }
+ },
+ "autoload": {
+ "psr-4": {
+ "PhpParser\\": "lib/PhpParser"
+ }
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "BSD-3-Clause"
+ ],
+ "authors": [
+ {
+ "name": "Nikita Popov"
+ }
+ ],
+ "description": "A PHP parser written in PHP",
+ "keywords": [
+ "parser",
+ "php"
+ ],
+ "support": {
+ "issues": "https://github.com/nikic/PHP-Parser/issues",
+ "source": "https://github.com/nikic/PHP-Parser/tree/v4.17.1"
+ },
+ "time": "2023-08-13T19:53:39+00:00"
},
{
"name": "phar-io/manifest",
- "version": "1.0.3",
+ "version": "2.0.3",
"source": {
"type": "git",
"url": "https://github.com/phar-io/manifest.git",
- "reference": "7761fcacf03b4d4f16e7ccb606d4879ca431fcf4"
+ "reference": "97803eca37d319dfa7826cc2437fc020857acb53"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/phar-io/manifest/zipball/7761fcacf03b4d4f16e7ccb606d4879ca431fcf4",
- "reference": "7761fcacf03b4d4f16e7ccb606d4879ca431fcf4",
+ "url": "https://api.github.com/repos/phar-io/manifest/zipball/97803eca37d319dfa7826cc2437fc020857acb53",
+ "reference": "97803eca37d319dfa7826cc2437fc020857acb53",
"shasum": ""
},
"require": {
"ext-dom": "*",
"ext-phar": "*",
- "phar-io/version": "^2.0",
- "php": "^5.6 || ^7.0"
+ "ext-xmlwriter": "*",
+ "phar-io/version": "^3.0.1",
+ "php": "^7.2 || ^8.0"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.0.x-dev"
+ "dev-master": "2.0.x-dev"
}
},
"autoload": {
@@ -601,24 +1100,28 @@
}
],
"description": "Component for reading phar.io manifest information from a PHP Archive (PHAR)",
- "time": "2018-07-08T19:23:20+00:00"
+ "support": {
+ "issues": "https://github.com/phar-io/manifest/issues",
+ "source": "https://github.com/phar-io/manifest/tree/2.0.3"
+ },
+ "time": "2021-07-20T11:28:43+00:00"
},
{
"name": "phar-io/version",
- "version": "2.0.1",
+ "version": "3.2.1",
"source": {
"type": "git",
"url": "https://github.com/phar-io/version.git",
- "reference": "45a2ec53a73c70ce41d55cedef9063630abaf1b6"
+ "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/phar-io/version/zipball/45a2ec53a73c70ce41d55cedef9063630abaf1b6",
- "reference": "45a2ec53a73c70ce41d55cedef9063630abaf1b6",
+ "url": "https://api.github.com/repos/phar-io/version/zipball/4f7fd7836c6f332bb2933569e566a0d6c4cbed74",
+ "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74",
"shasum": ""
},
"require": {
- "php": "^5.6 || ^7.0"
+ "php": "^7.2 || ^8.0"
},
"type": "library",
"autoload": {
@@ -648,257 +1151,178 @@
}
],
"description": "Library for handling version information and constraints",
- "time": "2018-07-08T19:19:57+00:00"
+ "support": {
+ "issues": "https://github.com/phar-io/version/issues",
+ "source": "https://github.com/phar-io/version/tree/3.2.1"
+ },
+ "time": "2022-02-21T01:04:05+00:00"
},
{
- "name": "phpdocumentor/reflection-common",
- "version": "2.0.0",
+ "name": "phpunit/php-code-coverage",
+ "version": "9.2.27",
"source": {
"type": "git",
- "url": "https://github.com/phpDocumentor/ReflectionCommon.git",
- "reference": "63a995caa1ca9e5590304cd845c15ad6d482a62a"
+ "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
+ "reference": "b0a88255cb70d52653d80c890bd7f38740ea50d1"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/63a995caa1ca9e5590304cd845c15ad6d482a62a",
- "reference": "63a995caa1ca9e5590304cd845c15ad6d482a62a",
+ "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/b0a88255cb70d52653d80c890bd7f38740ea50d1",
+ "reference": "b0a88255cb70d52653d80c890bd7f38740ea50d1",
"shasum": ""
},
"require": {
- "php": ">=7.1"
+ "ext-dom": "*",
+ "ext-libxml": "*",
+ "ext-xmlwriter": "*",
+ "nikic/php-parser": "^4.15",
+ "php": ">=7.3",
+ "phpunit/php-file-iterator": "^3.0.3",
+ "phpunit/php-text-template": "^2.0.2",
+ "sebastian/code-unit-reverse-lookup": "^2.0.2",
+ "sebastian/complexity": "^2.0",
+ "sebastian/environment": "^5.1.2",
+ "sebastian/lines-of-code": "^1.0.3",
+ "sebastian/version": "^3.0.1",
+ "theseer/tokenizer": "^1.2.0"
},
"require-dev": {
- "phpunit/phpunit": "~6"
+ "phpunit/phpunit": "^9.3"
+ },
+ "suggest": {
+ "ext-pcov": "PHP extension that provides line coverage",
+ "ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.x-dev"
+ "dev-master": "9.2-dev"
}
},
"autoload": {
- "psr-4": {
- "phpDocumentor\\Reflection\\": "src/"
- }
+ "classmap": [
+ "src/"
+ ]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
- "MIT"
+ "BSD-3-Clause"
],
"authors": [
{
- "name": "Jaap van Otterdijk",
- "email": "opensource@ijaap.nl"
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
}
],
- "description": "Common reflection classes used by phpdocumentor to reflect the code structure",
- "homepage": "http://www.phpdoc.org/",
+ "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.",
+ "homepage": "https://github.com/sebastianbergmann/php-code-coverage",
"keywords": [
- "FQSEN",
- "phpDocumentor",
- "phpdoc",
- "reflection",
- "static analysis"
+ "coverage",
+ "testing",
+ "xunit"
],
- "time": "2018-08-07T13:53:10+00:00"
- },
- {
- "name": "phpdocumentor/reflection-docblock",
- "version": "4.3.2",
- "source": {
- "type": "git",
- "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git",
- "reference": "b83ff7cfcfee7827e1e78b637a5904fe6a96698e"
- },
- "dist": {
- "type": "zip",
- "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/b83ff7cfcfee7827e1e78b637a5904fe6a96698e",
- "reference": "b83ff7cfcfee7827e1e78b637a5904fe6a96698e",
- "shasum": ""
- },
- "require": {
- "php": "^7.0",
- "phpdocumentor/reflection-common": "^1.0.0 || ^2.0.0",
- "phpdocumentor/type-resolver": "~0.4 || ^1.0.0",
- "webmozart/assert": "^1.0"
- },
- "require-dev": {
- "doctrine/instantiator": "^1.0.5",
- "mockery/mockery": "^1.0",
- "phpunit/phpunit": "^6.4"
- },
- "type": "library",
- "extra": {
- "branch-alias": {
- "dev-master": "4.x-dev"
- }
- },
- "autoload": {
- "psr-4": {
- "phpDocumentor\\Reflection\\": [
- "src/"
- ]
- }
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
+ "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy",
+ "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.27"
},
- "notification-url": "https://packagist.org/downloads/",
- "license": [
- "MIT"
- ],
- "authors": [
+ "funding": [
{
- "name": "Mike van Riel",
- "email": "me@mikevanriel.com"
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
}
],
- "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.",
- "time": "2019-09-12T14:27:41+00:00"
+ "time": "2023-07-26T13:44:30+00:00"
},
{
- "name": "phpdocumentor/type-resolver",
- "version": "1.0.1",
+ "name": "phpunit/php-file-iterator",
+ "version": "3.0.6",
"source": {
"type": "git",
- "url": "https://github.com/phpDocumentor/TypeResolver.git",
- "reference": "2e32a6d48972b2c1976ed5d8967145b6cec4a4a9"
+ "url": "https://github.com/sebastianbergmann/php-file-iterator.git",
+ "reference": "cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/2e32a6d48972b2c1976ed5d8967145b6cec4a4a9",
- "reference": "2e32a6d48972b2c1976ed5d8967145b6cec4a4a9",
+ "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf",
+ "reference": "cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf",
"shasum": ""
},
"require": {
- "php": "^7.1",
- "phpdocumentor/reflection-common": "^2.0"
+ "php": ">=7.3"
},
"require-dev": {
- "ext-tokenizer": "^7.1",
- "mockery/mockery": "~1",
- "phpunit/phpunit": "^7.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.x-dev"
+ "dev-master": "3.0-dev"
}
},
"autoload": {
- "psr-4": {
- "phpDocumentor\\Reflection\\": "src"
- }
+ "classmap": [
+ "src/"
+ ]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
- "MIT"
+ "BSD-3-Clause"
],
"authors": [
{
- "name": "Mike van Riel",
- "email": "me@mikevanriel.com"
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
}
],
- "description": "A PSR-5 based resolver of Class names, Types and Structural Element Names",
- "time": "2019-08-22T18:11:29+00:00"
- },
- {
- "name": "phpspec/prophecy",
- "version": "1.9.0",
- "source": {
- "type": "git",
- "url": "https://github.com/phpspec/prophecy.git",
- "reference": "f6811d96d97bdf400077a0cc100ae56aa32b9203"
- },
- "dist": {
- "type": "zip",
- "url": "https://api.github.com/repos/phpspec/prophecy/zipball/f6811d96d97bdf400077a0cc100ae56aa32b9203",
- "reference": "f6811d96d97bdf400077a0cc100ae56aa32b9203",
- "shasum": ""
- },
- "require": {
- "doctrine/instantiator": "^1.0.2",
- "php": "^5.3|^7.0",
- "phpdocumentor/reflection-docblock": "^2.0|^3.0.2|^4.0|^5.0",
- "sebastian/comparator": "^1.1|^2.0|^3.0",
- "sebastian/recursion-context": "^1.0|^2.0|^3.0"
- },
- "require-dev": {
- "phpspec/phpspec": "^2.5|^3.2",
- "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5 || ^7.1"
- },
- "type": "library",
- "extra": {
- "branch-alias": {
- "dev-master": "1.8.x-dev"
- }
- },
- "autoload": {
- "psr-4": {
- "Prophecy\\": "src/Prophecy"
- }
- },
- "notification-url": "https://packagist.org/downloads/",
- "license": [
- "MIT"
+ "description": "FilterIterator implementation that filters files based on a list of suffixes.",
+ "homepage": "https://github.com/sebastianbergmann/php-file-iterator/",
+ "keywords": [
+ "filesystem",
+ "iterator"
],
- "authors": [
- {
- "name": "Konstantin Kudryashov",
- "email": "ever.zet@gmail.com",
- "homepage": "http://everzet.com/"
- },
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues",
+ "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/3.0.6"
+ },
+ "funding": [
{
- "name": "Marcello Duarte",
- "email": "marcello.duarte@gmail.com"
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
}
],
- "description": "Highly opinionated mocking framework for PHP 5.3+",
- "homepage": "https://github.com/phpspec/prophecy",
- "keywords": [
- "Double",
- "Dummy",
- "fake",
- "mock",
- "spy",
- "stub"
- ],
- "time": "2019-10-03T11:07:50+00:00"
+ "time": "2021-12-02T12:48:52+00:00"
},
{
- "name": "phpunit/php-code-coverage",
- "version": "6.1.4",
+ "name": "phpunit/php-invoker",
+ "version": "3.1.1",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
- "reference": "807e6013b00af69b6c5d9ceb4282d0393dbb9d8d"
+ "url": "https://github.com/sebastianbergmann/php-invoker.git",
+ "reference": "5a10147d0aaf65b58940a0b72f71c9ac0423cc67"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/807e6013b00af69b6c5d9ceb4282d0393dbb9d8d",
- "reference": "807e6013b00af69b6c5d9ceb4282d0393dbb9d8d",
+ "url": "https://api.github.com/repos/sebastianbergmann/php-invoker/zipball/5a10147d0aaf65b58940a0b72f71c9ac0423cc67",
+ "reference": "5a10147d0aaf65b58940a0b72f71c9ac0423cc67",
"shasum": ""
},
"require": {
- "ext-dom": "*",
- "ext-xmlwriter": "*",
- "php": "^7.1",
- "phpunit/php-file-iterator": "^2.0",
- "phpunit/php-text-template": "^1.2.1",
- "phpunit/php-token-stream": "^3.0",
- "sebastian/code-unit-reverse-lookup": "^1.0.1",
- "sebastian/environment": "^3.1 || ^4.0",
- "sebastian/version": "^2.0.1",
- "theseer/tokenizer": "^1.1"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^7.0"
+ "ext-pcntl": "*",
+ "phpunit/phpunit": "^9.3"
},
"suggest": {
- "ext-xdebug": "^2.6.0"
+ "ext-pcntl": "*"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "6.1-dev"
+ "dev-master": "3.1-dev"
}
},
"autoload": {
@@ -917,39 +1341,47 @@
"role": "lead"
}
],
- "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.",
- "homepage": "https://github.com/sebastianbergmann/php-code-coverage",
+ "description": "Invoke callables with a timeout",
+ "homepage": "https://github.com/sebastianbergmann/php-invoker/",
"keywords": [
- "coverage",
- "testing",
- "xunit"
+ "process"
+ ],
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/php-invoker/issues",
+ "source": "https://github.com/sebastianbergmann/php-invoker/tree/3.1.1"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
],
- "time": "2018-10-31T16:06:48+00:00"
+ "time": "2020-09-28T05:58:55+00:00"
},
{
- "name": "phpunit/php-file-iterator",
- "version": "2.0.2",
+ "name": "phpunit/php-text-template",
+ "version": "2.0.4",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/php-file-iterator.git",
- "reference": "050bedf145a257b1ff02746c31894800e5122946"
+ "url": "https://github.com/sebastianbergmann/php-text-template.git",
+ "reference": "5da5f67fc95621df9ff4c4e5a84d6a8a2acf7c28"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/050bedf145a257b1ff02746c31894800e5122946",
- "reference": "050bedf145a257b1ff02746c31894800e5122946",
+ "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/5da5f67fc95621df9ff4c4e5a84d6a8a2acf7c28",
+ "reference": "5da5f67fc95621df9ff4c4e5a84d6a8a2acf7c28",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^7.1"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.0.x-dev"
+ "dev-master": "2.0-dev"
}
},
"autoload": {
@@ -968,32 +1400,49 @@
"role": "lead"
}
],
- "description": "FilterIterator implementation that filters files based on a list of suffixes.",
- "homepage": "https://github.com/sebastianbergmann/php-file-iterator/",
+ "description": "Simple template engine.",
+ "homepage": "https://github.com/sebastianbergmann/php-text-template/",
"keywords": [
- "filesystem",
- "iterator"
+ "template"
+ ],
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/php-text-template/issues",
+ "source": "https://github.com/sebastianbergmann/php-text-template/tree/2.0.4"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
],
- "time": "2018-09-13T20:33:42+00:00"
+ "time": "2020-10-26T05:33:50+00:00"
},
{
- "name": "phpunit/php-text-template",
- "version": "1.2.1",
+ "name": "phpunit/php-timer",
+ "version": "5.0.3",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/php-text-template.git",
- "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686"
+ "url": "https://github.com/sebastianbergmann/php-timer.git",
+ "reference": "5a63ce20ed1b5bf577850e2c4e87f4aa902afbd2"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/31f8b717e51d9a2afca6c9f046f5d69fc27c8686",
- "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686",
+ "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/5a63ce20ed1b5bf577850e2c4e87f4aa902afbd2",
+ "reference": "5a63ce20ed1b5bf577850e2c4e87f4aa902afbd2",
"shasum": ""
},
"require": {
- "php": ">=5.3.3"
+ "php": ">=7.3"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "5.0-dev"
+ }
+ },
"autoload": {
"classmap": [
"src/"
@@ -1010,40 +1459,83 @@
"role": "lead"
}
],
- "description": "Simple template engine.",
- "homepage": "https://github.com/sebastianbergmann/php-text-template/",
+ "description": "Utility class for timing",
+ "homepage": "https://github.com/sebastianbergmann/php-timer/",
"keywords": [
- "template"
+ "timer"
+ ],
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/php-timer/issues",
+ "source": "https://github.com/sebastianbergmann/php-timer/tree/5.0.3"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
],
- "time": "2015-06-21T13:50:34+00:00"
+ "time": "2020-10-26T13:16:10+00:00"
},
{
- "name": "phpunit/php-timer",
- "version": "2.1.2",
+ "name": "phpunit/phpunit",
+ "version": "9.6.11",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/php-timer.git",
- "reference": "1038454804406b0b5f5f520358e78c1c2f71501e"
+ "url": "https://github.com/sebastianbergmann/phpunit.git",
+ "reference": "810500e92855eba8a7a5319ae913be2da6f957b0"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/1038454804406b0b5f5f520358e78c1c2f71501e",
- "reference": "1038454804406b0b5f5f520358e78c1c2f71501e",
+ "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/810500e92855eba8a7a5319ae913be2da6f957b0",
+ "reference": "810500e92855eba8a7a5319ae913be2da6f957b0",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "doctrine/instantiator": "^1.3.1 || ^2",
+ "ext-dom": "*",
+ "ext-json": "*",
+ "ext-libxml": "*",
+ "ext-mbstring": "*",
+ "ext-xml": "*",
+ "ext-xmlwriter": "*",
+ "myclabs/deep-copy": "^1.10.1",
+ "phar-io/manifest": "^2.0.3",
+ "phar-io/version": "^3.0.2",
+ "php": ">=7.3",
+ "phpunit/php-code-coverage": "^9.2.13",
+ "phpunit/php-file-iterator": "^3.0.5",
+ "phpunit/php-invoker": "^3.1.1",
+ "phpunit/php-text-template": "^2.0.3",
+ "phpunit/php-timer": "^5.0.2",
+ "sebastian/cli-parser": "^1.0.1",
+ "sebastian/code-unit": "^1.0.6",
+ "sebastian/comparator": "^4.0.8",
+ "sebastian/diff": "^4.0.3",
+ "sebastian/environment": "^5.1.3",
+ "sebastian/exporter": "^4.0.5",
+ "sebastian/global-state": "^5.0.1",
+ "sebastian/object-enumerator": "^4.0.3",
+ "sebastian/resource-operations": "^3.0.3",
+ "sebastian/type": "^3.2",
+ "sebastian/version": "^3.0.2"
},
- "require-dev": {
- "phpunit/phpunit": "^7.0"
+ "suggest": {
+ "ext-soap": "To be able to generate mocks based on WSDL files",
+ "ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage"
},
+ "bin": [
+ "phpunit"
+ ],
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.1-dev"
+ "dev-master": "9.6-dev"
}
},
"autoload": {
+ "files": [
+ "src/Framework/Assert/Functions.php"
+ ],
"classmap": [
"src/"
]
@@ -1059,38 +1551,58 @@
"role": "lead"
}
],
- "description": "Utility class for timing",
- "homepage": "https://github.com/sebastianbergmann/php-timer/",
+ "description": "The PHP Unit Testing framework.",
+ "homepage": "https://phpunit.de/",
"keywords": [
- "timer"
+ "phpunit",
+ "testing",
+ "xunit"
+ ],
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/phpunit/issues",
+ "security": "https://github.com/sebastianbergmann/phpunit/security/policy",
+ "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.11"
+ },
+ "funding": [
+ {
+ "url": "https://phpunit.de/sponsors.html",
+ "type": "custom"
+ },
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ },
+ {
+ "url": "https://tidelift.com/funding/github/packagist/phpunit/phpunit",
+ "type": "tidelift"
+ }
],
- "time": "2019-06-07T04:22:29+00:00"
+ "time": "2023-08-19T07:10:56+00:00"
},
{
- "name": "phpunit/php-token-stream",
- "version": "3.1.1",
+ "name": "sebastian/cli-parser",
+ "version": "1.0.1",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/php-token-stream.git",
- "reference": "995192df77f63a59e47f025390d2d1fdf8f425ff"
+ "url": "https://github.com/sebastianbergmann/cli-parser.git",
+ "reference": "442e7c7e687e42adc03470c7b668bc4b2402c0b2"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/995192df77f63a59e47f025390d2d1fdf8f425ff",
- "reference": "995192df77f63a59e47f025390d2d1fdf8f425ff",
+ "url": "https://api.github.com/repos/sebastianbergmann/cli-parser/zipball/442e7c7e687e42adc03470c7b668bc4b2402c0b2",
+ "reference": "442e7c7e687e42adc03470c7b668bc4b2402c0b2",
"shasum": ""
},
"require": {
- "ext-tokenizer": "*",
- "php": "^7.1"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^7.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.1-dev"
+ "dev-master": "1.0-dev"
}
},
"autoload": {
@@ -1105,73 +1617,48 @@
"authors": [
{
"name": "Sebastian Bergmann",
- "email": "sebastian@phpunit.de"
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
}
],
- "description": "Wrapper around PHP's tokenizer extension.",
- "homepage": "https://github.com/sebastianbergmann/php-token-stream/",
- "keywords": [
- "tokenizer"
+ "description": "Library for parsing CLI options",
+ "homepage": "https://github.com/sebastianbergmann/cli-parser",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/cli-parser/issues",
+ "source": "https://github.com/sebastianbergmann/cli-parser/tree/1.0.1"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
],
- "time": "2019-09-17T06:23:10+00:00"
+ "time": "2020-09-28T06:08:49+00:00"
},
{
- "name": "phpunit/phpunit",
- "version": "7.5.17",
+ "name": "sebastian/code-unit",
+ "version": "1.0.8",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/phpunit.git",
- "reference": "4c92a15296e58191a4cd74cff3b34fc8e374174a"
+ "url": "https://github.com/sebastianbergmann/code-unit.git",
+ "reference": "1fc9f64c0927627ef78ba436c9b17d967e68e120"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/4c92a15296e58191a4cd74cff3b34fc8e374174a",
- "reference": "4c92a15296e58191a4cd74cff3b34fc8e374174a",
+ "url": "https://api.github.com/repos/sebastianbergmann/code-unit/zipball/1fc9f64c0927627ef78ba436c9b17d967e68e120",
+ "reference": "1fc9f64c0927627ef78ba436c9b17d967e68e120",
"shasum": ""
},
"require": {
- "doctrine/instantiator": "^1.1",
- "ext-dom": "*",
- "ext-json": "*",
- "ext-libxml": "*",
- "ext-mbstring": "*",
- "ext-xml": "*",
- "myclabs/deep-copy": "^1.7",
- "phar-io/manifest": "^1.0.2",
- "phar-io/version": "^2.0",
- "php": "^7.1",
- "phpspec/prophecy": "^1.7",
- "phpunit/php-code-coverage": "^6.0.7",
- "phpunit/php-file-iterator": "^2.0.1",
- "phpunit/php-text-template": "^1.2.1",
- "phpunit/php-timer": "^2.1",
- "sebastian/comparator": "^3.0",
- "sebastian/diff": "^3.0",
- "sebastian/environment": "^4.0",
- "sebastian/exporter": "^3.1",
- "sebastian/global-state": "^2.0",
- "sebastian/object-enumerator": "^3.0.3",
- "sebastian/resource-operations": "^2.0",
- "sebastian/version": "^2.0.1"
- },
- "conflict": {
- "phpunit/phpunit-mock-objects": "*"
+ "php": ">=7.3"
},
"require-dev": {
- "ext-pdo": "*"
- },
- "suggest": {
- "ext-soap": "*",
- "ext-xdebug": "*",
- "phpunit/php-invoker": "^2.0"
+ "phpunit/phpunit": "^9.3"
},
- "bin": [
- "phpunit"
- ],
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "7.5-dev"
+ "dev-master": "1.0-dev"
}
},
"autoload": {
@@ -1190,39 +1677,44 @@
"role": "lead"
}
],
- "description": "The PHP Unit Testing framework.",
- "homepage": "https://phpunit.de/",
- "keywords": [
- "phpunit",
- "testing",
- "xunit"
+ "description": "Collection of value objects that represent the PHP code units",
+ "homepage": "https://github.com/sebastianbergmann/code-unit",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/code-unit/issues",
+ "source": "https://github.com/sebastianbergmann/code-unit/tree/1.0.8"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
],
- "time": "2019-10-28T10:37:36+00:00"
+ "time": "2020-10-26T13:08:54+00:00"
},
{
"name": "sebastian/code-unit-reverse-lookup",
- "version": "1.0.1",
+ "version": "2.0.3",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/code-unit-reverse-lookup.git",
- "reference": "4419fcdb5eabb9caa61a27c7a1db532a6b55dd18"
+ "reference": "ac91f01ccec49fb77bdc6fd1e548bc70f7faa3e5"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/code-unit-reverse-lookup/zipball/4419fcdb5eabb9caa61a27c7a1db532a6b55dd18",
- "reference": "4419fcdb5eabb9caa61a27c7a1db532a6b55dd18",
+ "url": "https://api.github.com/repos/sebastianbergmann/code-unit-reverse-lookup/zipball/ac91f01ccec49fb77bdc6fd1e548bc70f7faa3e5",
+ "reference": "ac91f01ccec49fb77bdc6fd1e548bc70f7faa3e5",
"shasum": ""
},
"require": {
- "php": "^5.6 || ^7.0"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^5.7 || ^6.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.0.x-dev"
+ "dev-master": "2.0-dev"
}
},
"autoload": {
@@ -1242,34 +1734,44 @@
],
"description": "Looks up which function or method a line of code belongs to",
"homepage": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/",
- "time": "2017-03-04T06:30:41+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/issues",
+ "source": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/tree/2.0.3"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-09-28T05:30:19+00:00"
},
{
"name": "sebastian/comparator",
- "version": "3.0.2",
+ "version": "4.0.8",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/comparator.git",
- "reference": "5de4fc177adf9bce8df98d8d141a7559d7ccf6da"
+ "reference": "fa0f136dd2334583309d32b62544682ee972b51a"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/5de4fc177adf9bce8df98d8d141a7559d7ccf6da",
- "reference": "5de4fc177adf9bce8df98d8d141a7559d7ccf6da",
+ "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/fa0f136dd2334583309d32b62544682ee972b51a",
+ "reference": "fa0f136dd2334583309d32b62544682ee972b51a",
"shasum": ""
},
"require": {
- "php": "^7.1",
- "sebastian/diff": "^3.0",
- "sebastian/exporter": "^3.1"
+ "php": ">=7.3",
+ "sebastian/diff": "^4.0",
+ "sebastian/exporter": "^4.0"
},
"require-dev": {
- "phpunit/phpunit": "^7.1"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.0-dev"
+ "dev-master": "4.0-dev"
}
},
"autoload": {
@@ -1282,6 +1784,10 @@
"BSD-3-Clause"
],
"authors": [
+ {
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de"
+ },
{
"name": "Jeff Welch",
"email": "whatthejeff@gmail.com"
@@ -1293,10 +1799,6 @@
{
"name": "Bernhard Schussek",
"email": "bschussek@2bepublished.at"
- },
- {
- "name": "Sebastian Bergmann",
- "email": "sebastian@phpunit.de"
}
],
"description": "Provides the functionality to compare PHP values for equality",
@@ -1306,33 +1808,100 @@
"compare",
"equality"
],
- "time": "2018-07-12T15:12:46+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/comparator/issues",
+ "source": "https://github.com/sebastianbergmann/comparator/tree/4.0.8"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2022-09-14T12:41:17+00:00"
+ },
+ {
+ "name": "sebastian/complexity",
+ "version": "2.0.2",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/sebastianbergmann/complexity.git",
+ "reference": "739b35e53379900cc9ac327b2147867b8b6efd88"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/739b35e53379900cc9ac327b2147867b8b6efd88",
+ "reference": "739b35e53379900cc9ac327b2147867b8b6efd88",
+ "shasum": ""
+ },
+ "require": {
+ "nikic/php-parser": "^4.7",
+ "php": ">=7.3"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^9.3"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "2.0-dev"
+ }
+ },
+ "autoload": {
+ "classmap": [
+ "src/"
+ ]
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "BSD-3-Clause"
+ ],
+ "authors": [
+ {
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
+ }
+ ],
+ "description": "Library for calculating the complexity of PHP code units",
+ "homepage": "https://github.com/sebastianbergmann/complexity",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/complexity/issues",
+ "source": "https://github.com/sebastianbergmann/complexity/tree/2.0.2"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-10-26T15:52:27+00:00"
},
{
"name": "sebastian/diff",
- "version": "3.0.2",
+ "version": "4.0.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/diff.git",
- "reference": "720fcc7e9b5cf384ea68d9d930d480907a0c1a29"
+ "reference": "74be17022044ebaaecfdf0c5cd504fc9cd5a7131"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/720fcc7e9b5cf384ea68d9d930d480907a0c1a29",
- "reference": "720fcc7e9b5cf384ea68d9d930d480907a0c1a29",
+ "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/74be17022044ebaaecfdf0c5cd504fc9cd5a7131",
+ "reference": "74be17022044ebaaecfdf0c5cd504fc9cd5a7131",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^7.5 || ^8.0",
- "symfony/process": "^2 || ^3.3 || ^4"
+ "phpunit/phpunit": "^9.3",
+ "symfony/process": "^4.2 || ^5"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.0-dev"
+ "dev-master": "4.0-dev"
}
},
"autoload": {
@@ -1345,13 +1914,13 @@
"BSD-3-Clause"
],
"authors": [
- {
- "name": "Kore Nordmann",
- "email": "mail@kore-nordmann.de"
- },
{
"name": "Sebastian Bergmann",
"email": "sebastian@phpunit.de"
+ },
+ {
+ "name": "Kore Nordmann",
+ "email": "mail@kore-nordmann.de"
}
],
"description": "Diff implementation",
@@ -1362,27 +1931,37 @@
"unidiff",
"unified diff"
],
- "time": "2019-02-04T06:01:07+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/diff/issues",
+ "source": "https://github.com/sebastianbergmann/diff/tree/4.0.5"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2023-05-07T05:35:17+00:00"
},
{
"name": "sebastian/environment",
- "version": "4.2.2",
+ "version": "5.1.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/environment.git",
- "reference": "f2a2c8e1c97c11ace607a7a667d73d47c19fe404"
+ "reference": "830c43a844f1f8d5b7a1f6d6076b784454d8b7ed"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/f2a2c8e1c97c11ace607a7a667d73d47c19fe404",
- "reference": "f2a2c8e1c97c11ace607a7a667d73d47c19fe404",
+ "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/830c43a844f1f8d5b7a1f6d6076b784454d8b7ed",
+ "reference": "830c43a844f1f8d5b7a1f6d6076b784454d8b7ed",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^7.5"
+ "phpunit/phpunit": "^9.3"
},
"suggest": {
"ext-posix": "*"
@@ -1390,7 +1969,7 @@
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "4.2-dev"
+ "dev-master": "5.1-dev"
}
},
"autoload": {
@@ -1415,34 +1994,44 @@
"environment",
"hhvm"
],
- "time": "2019-05-05T09:05:15+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/environment/issues",
+ "source": "https://github.com/sebastianbergmann/environment/tree/5.1.5"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2023-02-03T06:03:51+00:00"
},
{
"name": "sebastian/exporter",
- "version": "3.1.2",
+ "version": "4.0.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/exporter.git",
- "reference": "68609e1261d215ea5b21b7987539cbfbe156ec3e"
+ "reference": "ac230ed27f0f98f597c8a2b6eb7ac563af5e5b9d"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/68609e1261d215ea5b21b7987539cbfbe156ec3e",
- "reference": "68609e1261d215ea5b21b7987539cbfbe156ec3e",
+ "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/ac230ed27f0f98f597c8a2b6eb7ac563af5e5b9d",
+ "reference": "ac230ed27f0f98f597c8a2b6eb7ac563af5e5b9d",
"shasum": ""
},
"require": {
- "php": "^7.0",
- "sebastian/recursion-context": "^3.0"
+ "php": ">=7.3",
+ "sebastian/recursion-context": "^4.0"
},
"require-dev": {
"ext-mbstring": "*",
- "phpunit/phpunit": "^6.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.1.x-dev"
+ "dev-master": "4.0-dev"
}
},
"autoload": {
@@ -1477,32 +2066,45 @@
}
],
"description": "Provides the functionality to export PHP variables for visualization",
- "homepage": "http://www.github.com/sebastianbergmann/exporter",
+ "homepage": "https://www.github.com/sebastianbergmann/exporter",
"keywords": [
"export",
"exporter"
],
- "time": "2019-09-14T09:02:43+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/exporter/issues",
+ "source": "https://github.com/sebastianbergmann/exporter/tree/4.0.5"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2022-09-14T06:03:37+00:00"
},
{
"name": "sebastian/global-state",
- "version": "2.0.0",
+ "version": "5.0.6",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/global-state.git",
- "reference": "e8ba02eed7bbbb9e59e43dedd3dddeff4a56b0c4"
+ "reference": "bde739e7565280bda77be70044ac1047bc007e34"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/e8ba02eed7bbbb9e59e43dedd3dddeff4a56b0c4",
- "reference": "e8ba02eed7bbbb9e59e43dedd3dddeff4a56b0c4",
+ "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/bde739e7565280bda77be70044ac1047bc007e34",
+ "reference": "bde739e7565280bda77be70044ac1047bc007e34",
"shasum": ""
},
"require": {
- "php": "^7.0"
+ "php": ">=7.3",
+ "sebastian/object-reflector": "^2.0",
+ "sebastian/recursion-context": "^4.0"
},
"require-dev": {
- "phpunit/phpunit": "^6.0"
+ "ext-dom": "*",
+ "phpunit/phpunit": "^9.3"
},
"suggest": {
"ext-uopz": "*"
@@ -1510,7 +2112,7 @@
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.0-dev"
+ "dev-master": "5.0-dev"
}
},
"autoload": {
@@ -1533,34 +2135,101 @@
"keywords": [
"global state"
],
- "time": "2017-04-27T15:39:26+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/global-state/issues",
+ "source": "https://github.com/sebastianbergmann/global-state/tree/5.0.6"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2023-08-02T09:26:13+00:00"
+ },
+ {
+ "name": "sebastian/lines-of-code",
+ "version": "1.0.3",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/sebastianbergmann/lines-of-code.git",
+ "reference": "c1c2e997aa3146983ed888ad08b15470a2e22ecc"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/c1c2e997aa3146983ed888ad08b15470a2e22ecc",
+ "reference": "c1c2e997aa3146983ed888ad08b15470a2e22ecc",
+ "shasum": ""
+ },
+ "require": {
+ "nikic/php-parser": "^4.6",
+ "php": ">=7.3"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^9.3"
+ },
+ "type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "1.0-dev"
+ }
+ },
+ "autoload": {
+ "classmap": [
+ "src/"
+ ]
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "BSD-3-Clause"
+ ],
+ "authors": [
+ {
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
+ }
+ ],
+ "description": "Library for counting the lines of code in PHP source code",
+ "homepage": "https://github.com/sebastianbergmann/lines-of-code",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/lines-of-code/issues",
+ "source": "https://github.com/sebastianbergmann/lines-of-code/tree/1.0.3"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-11-28T06:42:11+00:00"
},
{
"name": "sebastian/object-enumerator",
- "version": "3.0.3",
+ "version": "4.0.4",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/object-enumerator.git",
- "reference": "7cfd9e65d11ffb5af41198476395774d4c8a84c5"
+ "reference": "5c9eeac41b290a3712d88851518825ad78f45c71"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/7cfd9e65d11ffb5af41198476395774d4c8a84c5",
- "reference": "7cfd9e65d11ffb5af41198476395774d4c8a84c5",
+ "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/5c9eeac41b290a3712d88851518825ad78f45c71",
+ "reference": "5c9eeac41b290a3712d88851518825ad78f45c71",
"shasum": ""
},
"require": {
- "php": "^7.0",
- "sebastian/object-reflector": "^1.1.1",
- "sebastian/recursion-context": "^3.0"
+ "php": ">=7.3",
+ "sebastian/object-reflector": "^2.0",
+ "sebastian/recursion-context": "^4.0"
},
"require-dev": {
- "phpunit/phpunit": "^6.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.0.x-dev"
+ "dev-master": "4.0-dev"
}
},
"autoload": {
@@ -1580,32 +2249,42 @@
],
"description": "Traverses array structures and object graphs to enumerate all referenced objects",
"homepage": "https://github.com/sebastianbergmann/object-enumerator/",
- "time": "2017-08-03T12:35:26+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/object-enumerator/issues",
+ "source": "https://github.com/sebastianbergmann/object-enumerator/tree/4.0.4"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-10-26T13:12:34+00:00"
},
{
"name": "sebastian/object-reflector",
- "version": "1.1.1",
+ "version": "2.0.4",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/object-reflector.git",
- "reference": "773f97c67f28de00d397be301821b06708fca0be"
+ "reference": "b4f479ebdbf63ac605d183ece17d8d7fe49c15c7"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/773f97c67f28de00d397be301821b06708fca0be",
- "reference": "773f97c67f28de00d397be301821b06708fca0be",
+ "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/b4f479ebdbf63ac605d183ece17d8d7fe49c15c7",
+ "reference": "b4f479ebdbf63ac605d183ece17d8d7fe49c15c7",
"shasum": ""
},
"require": {
- "php": "^7.0"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^6.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "1.1-dev"
+ "dev-master": "2.0-dev"
}
},
"autoload": {
@@ -1625,32 +2304,42 @@
],
"description": "Allows reflection of object attributes, including inherited and non-public ones",
"homepage": "https://github.com/sebastianbergmann/object-reflector/",
- "time": "2017-03-29T09:07:27+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/object-reflector/issues",
+ "source": "https://github.com/sebastianbergmann/object-reflector/tree/2.0.4"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-10-26T13:14:26+00:00"
},
{
"name": "sebastian/recursion-context",
- "version": "3.0.0",
+ "version": "4.0.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/recursion-context.git",
- "reference": "5b0cd723502bac3b006cbf3dbf7a1e3fcefe4fa8"
+ "reference": "e75bd0f07204fec2a0af9b0f3cfe97d05f92efc1"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/5b0cd723502bac3b006cbf3dbf7a1e3fcefe4fa8",
- "reference": "5b0cd723502bac3b006cbf3dbf7a1e3fcefe4fa8",
+ "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/e75bd0f07204fec2a0af9b0f3cfe97d05f92efc1",
+ "reference": "e75bd0f07204fec2a0af9b0f3cfe97d05f92efc1",
"shasum": ""
},
"require": {
- "php": "^7.0"
+ "php": ">=7.3"
},
"require-dev": {
- "phpunit/phpunit": "^6.0"
+ "phpunit/phpunit": "^9.3"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "3.0.x-dev"
+ "dev-master": "4.0-dev"
}
},
"autoload": {
@@ -1663,44 +2352,57 @@
"BSD-3-Clause"
],
"authors": [
- {
- "name": "Jeff Welch",
- "email": "whatthejeff@gmail.com"
- },
{
"name": "Sebastian Bergmann",
"email": "sebastian@phpunit.de"
},
+ {
+ "name": "Jeff Welch",
+ "email": "whatthejeff@gmail.com"
+ },
{
"name": "Adam Harvey",
"email": "aharvey@php.net"
}
],
"description": "Provides functionality to recursively process PHP variables",
- "homepage": "http://www.github.com/sebastianbergmann/recursion-context",
- "time": "2017-03-03T06:23:57+00:00"
+ "homepage": "https://github.com/sebastianbergmann/recursion-context",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/recursion-context/issues",
+ "source": "https://github.com/sebastianbergmann/recursion-context/tree/4.0.5"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2023-02-03T06:07:39+00:00"
},
{
"name": "sebastian/resource-operations",
- "version": "2.0.1",
+ "version": "3.0.3",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/resource-operations.git",
- "reference": "4d7a795d35b889bf80a0cc04e08d77cedfa917a9"
+ "reference": "0f4443cb3a1d92ce809899753bc0d5d5a8dd19a8"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/resource-operations/zipball/4d7a795d35b889bf80a0cc04e08d77cedfa917a9",
- "reference": "4d7a795d35b889bf80a0cc04e08d77cedfa917a9",
+ "url": "https://api.github.com/repos/sebastianbergmann/resource-operations/zipball/0f4443cb3a1d92ce809899753bc0d5d5a8dd19a8",
+ "reference": "0f4443cb3a1d92ce809899753bc0d5d5a8dd19a8",
"shasum": ""
},
"require": {
- "php": "^7.1"
+ "php": ">=7.3"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^9.0"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.0-dev"
+ "dev-master": "3.0-dev"
}
},
"autoload": {
@@ -1720,29 +2422,42 @@
],
"description": "Provides a list of PHP built-in functions that operate on resources",
"homepage": "https://www.github.com/sebastianbergmann/resource-operations",
- "time": "2018-10-04T04:07:39+00:00"
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/resource-operations/issues",
+ "source": "https://github.com/sebastianbergmann/resource-operations/tree/3.0.3"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-09-28T06:45:17+00:00"
},
{
- "name": "sebastian/version",
- "version": "2.0.1",
+ "name": "sebastian/type",
+ "version": "3.2.1",
"source": {
"type": "git",
- "url": "https://github.com/sebastianbergmann/version.git",
- "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019"
+ "url": "https://github.com/sebastianbergmann/type.git",
+ "reference": "75e2c2a32f5e0b3aef905b9ed0b179b953b3d7c7"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/99732be0ddb3361e16ad77b68ba41efc8e979019",
- "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019",
+ "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/75e2c2a32f5e0b3aef905b9ed0b179b953b3d7c7",
+ "reference": "75e2c2a32f5e0b3aef905b9ed0b179b953b3d7c7",
"shasum": ""
},
"require": {
- "php": ">=5.6"
+ "php": ">=7.3"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^9.5"
},
"type": "library",
"extra": {
"branch-alias": {
- "dev-master": "2.0.x-dev"
+ "dev-master": "3.2-dev"
}
},
"autoload": {
@@ -1761,31 +2476,43 @@
"role": "lead"
}
],
- "description": "Library that helps with managing the version number of Git-hosted PHP projects",
- "homepage": "https://github.com/sebastianbergmann/version",
- "time": "2016-10-03T07:35:21+00:00"
+ "description": "Collection of value objects that represent the types of the PHP type system",
+ "homepage": "https://github.com/sebastianbergmann/type",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/type/issues",
+ "source": "https://github.com/sebastianbergmann/type/tree/3.2.1"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2023-02-03T06:13:03+00:00"
},
{
- "name": "theseer/tokenizer",
- "version": "1.1.3",
+ "name": "sebastian/version",
+ "version": "3.0.2",
"source": {
"type": "git",
- "url": "https://github.com/theseer/tokenizer.git",
- "reference": "11336f6f84e16a720dae9d8e6ed5019efa85a0f9"
+ "url": "https://github.com/sebastianbergmann/version.git",
+ "reference": "c6c1022351a901512170118436c764e473f6de8c"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/theseer/tokenizer/zipball/11336f6f84e16a720dae9d8e6ed5019efa85a0f9",
- "reference": "11336f6f84e16a720dae9d8e6ed5019efa85a0f9",
+ "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/c6c1022351a901512170118436c764e473f6de8c",
+ "reference": "c6c1022351a901512170118436c764e473f6de8c",
"shasum": ""
},
"require": {
- "ext-dom": "*",
- "ext-tokenizer": "*",
- "ext-xmlwriter": "*",
- "php": "^7.0"
+ "php": ">=7.3"
},
"type": "library",
+ "extra": {
+ "branch-alias": {
+ "dev-master": "3.0-dev"
+ }
+ },
"autoload": {
"classmap": [
"src/"
@@ -1797,63 +2524,74 @@
],
"authors": [
{
- "name": "Arne Blankerts",
- "email": "arne@blankerts.de",
- "role": "Developer"
+ "name": "Sebastian Bergmann",
+ "email": "sebastian@phpunit.de",
+ "role": "lead"
}
],
- "description": "A small library for converting tokenized PHP source code into XML and potentially other formats",
- "time": "2019-06-13T22:48:21+00:00"
+ "description": "Library that helps with managing the version number of Git-hosted PHP projects",
+ "homepage": "https://github.com/sebastianbergmann/version",
+ "support": {
+ "issues": "https://github.com/sebastianbergmann/version/issues",
+ "source": "https://github.com/sebastianbergmann/version/tree/3.0.2"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/sebastianbergmann",
+ "type": "github"
+ }
+ ],
+ "time": "2020-09-28T06:39:44+00:00"
},
{
- "name": "webmozart/assert",
- "version": "1.5.0",
+ "name": "theseer/tokenizer",
+ "version": "1.2.1",
"source": {
"type": "git",
- "url": "https://github.com/webmozart/assert.git",
- "reference": "88e6d84706d09a236046d686bbea96f07b3a34f4"
+ "url": "https://github.com/theseer/tokenizer.git",
+ "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/webmozart/assert/zipball/88e6d84706d09a236046d686bbea96f07b3a34f4",
- "reference": "88e6d84706d09a236046d686bbea96f07b3a34f4",
+ "url": "https://api.github.com/repos/theseer/tokenizer/zipball/34a41e998c2183e22995f158c581e7b5e755ab9e",
+ "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e",
"shasum": ""
},
"require": {
- "php": "^5.3.3 || ^7.0",
- "symfony/polyfill-ctype": "^1.8"
- },
- "require-dev": {
- "phpunit/phpunit": "^4.8.36 || ^7.5.13"
+ "ext-dom": "*",
+ "ext-tokenizer": "*",
+ "ext-xmlwriter": "*",
+ "php": "^7.2 || ^8.0"
},
"type": "library",
- "extra": {
- "branch-alias": {
- "dev-master": "1.3-dev"
- }
- },
"autoload": {
- "psr-4": {
- "Webmozart\\Assert\\": "src/"
- }
+ "classmap": [
+ "src/"
+ ]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
- "MIT"
+ "BSD-3-Clause"
],
"authors": [
{
- "name": "Bernhard Schussek",
- "email": "bschussek@gmail.com"
+ "name": "Arne Blankerts",
+ "email": "arne@blankerts.de",
+ "role": "Developer"
}
],
- "description": "Assertions to validate method input/output with nice error messages.",
- "keywords": [
- "assert",
- "check",
- "validate"
+ "description": "A small library for converting tokenized PHP source code into XML and potentially other formats",
+ "support": {
+ "issues": "https://github.com/theseer/tokenizer/issues",
+ "source": "https://github.com/theseer/tokenizer/tree/1.2.1"
+ },
+ "funding": [
+ {
+ "url": "https://github.com/theseer",
+ "type": "github"
+ }
],
- "time": "2019-08-24T08:43:50+00:00"
+ "time": "2021-07-28T10:34:58+00:00"
}
],
"aliases": [],
@@ -1862,9 +2600,10 @@
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
- "php": "^7.1",
- "ext-json": "^1.5",
+ "php": "^8.0 || ^8.1 || ^8.2",
+ "ext-json": "*",
"ext-reflection": "*"
},
- "platform-dev": []
+ "platform-dev": [],
+ "plugin-api-version": "2.3.0"
}
diff --git a/docs/classes/BitPaySDK-Client-BillClient.html b/docs/classes/BitPaySDK-Client-BillClient.html
new file mode 100644
index 00000000..5ff27700
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-BillClient.html
@@ -0,0 +1,1111 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the bill endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ create()
+
+ : Bill
+
+Create a BitPay Bill.
+
+
+ deliver()
+
+ : bool
+
+Deliver a BitPay Bill.
+
+
+ get()
+
+ : Bill
+
+Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ getBills()
+
+ : array<string|int, Bill >
+
+Retrieve a collection of BitPay bills.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Bill Client.
+
+
+ update()
+
+ : Bill
+
+Update a BitPay Bill.
+
+
+ __construct()
+
+ : mixed
+
+
+
+ mapJsonToBillClass()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create()
+
+
+
+
+
+ Create a BitPay Bill.
+
+
+ public
+ create ( Bill $bill [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ deliver()
+
+
+
+
+
+ Deliver a BitPay Bill.
+
+
+ public
+ deliver ( string $billId , string $billToken [ , bool $signRequest = true ] ) : bool
+
+
+
+
+ Parameters
+
+
+ $billId
+ : string
+
+
+ The id of the requested bill.
+
+
+
+
+ $billToken
+ : string
+
+
+ The token of the requested bill.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ public
+ get ( $billId [ , $facade = Facade::MERCHANT ] [ , $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $billId
+ :
+
+
+ string The id of the bill to retrieve.
+
+
+
+
+ $facade
+ :
+ = Facade::MERCHANT
+
+ string The facade used to retrieve it.
+
+
+
+
+ $signRequest
+ :
+ = true
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getBills()
+
+
+
+
+
+ Retrieve a collection of BitPay bills.
+
+
+ public
+ getBills ( [ string $status = null ] ) : array<string|int, Bill >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+ = null
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Bill >
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Bill Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ update()
+
+
+
+
+
+ Update a BitPay Bill.
+
+
+ public
+ update ( Bill $bill , string $billId ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with the parameters to update defined.
+
+
+
+
+ $billId
+ : string
+
+
+ The Id of the Bill to update.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+ mapJsonToBillClass()
+
+
+
+
+
+
+
+ private
+ mapJsonToBillClass ( string|null $responseJson ) : mixed
+
+
+
+
+ Parameters
+
+
+ $responseJson
+ : string|null
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ JsonException
+
+
+
+
+ throws
+
+
+ JsonMapper_Exception
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-InvoiceClient.html b/docs/classes/BitPaySDK-Client-InvoiceClient.html
new file mode 100644
index 00000000..e064d1a6
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-InvoiceClient.html
@@ -0,0 +1,1603 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the invoice endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ cancel()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ cancelByGuid()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ create()
+
+ : Invoice
+
+Create a BitPay invoice.
+
+
+ get()
+
+ : Invoice
+
+Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ getByGuid()
+
+ : Invoice
+
+
+
+ getInstance()
+
+ : static
+
+Factory method for Invoice Client.
+
+
+ getInvoices()
+
+ : array<string|int, Invoice >
+
+Retrieve a collection of BitPay invoices.
+
+
+ pay()
+
+ : Invoice
+
+Pay an invoice with a mock transaction
+
+
+ requestNotification()
+
+ : bool
+
+Request a BitPay Invoice Webhook.
+
+
+ update()
+
+ : Invoice
+
+Update a BitPay invoice.
+
+
+ __construct()
+
+ : mixed
+
+
+
+ buyerEmailOrSms()
+
+ : bool
+
+Check if buyerEmail or buyerSms is present, and not both.
+
+
+ isSmsCodeRequired()
+
+ : bool
+
+Check if smsCode is required.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cancel()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancel ( string $invoiceId [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ cancelByGuid()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancelByGuid ( string $guid [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the invoice to cancel.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ create()
+
+
+
+
+
+ Create a BitPay invoice.
+
+
+ public
+ create ( Invoice $invoice [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : Invoice
+
+
+ An Invoice object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ public
+ get ( string $invoiceId [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to retrieve.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getByGuid()
+
+
+
+
+
+
+
+ public
+ getByGuid ( string $guid [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Invoice Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getInvoices()
+
+
+
+
+
+ Retrieve a collection of BitPay invoices.
+
+
+ public
+ getInvoices ( string $dateStart , string $dateEnd [ , string|null $status = null ] [ , string|null $orderId = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Invoice >
+
+
+
+
+ Parameters
+
+
+ $dateStart
+ : string
+
+
+ The start of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $dateEnd
+ : string
+
+
+ The end of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The invoice status you want to query on.
+
+
+
+
+ $orderId
+ : string|null
+ = null
+
+ The optional order id specified at time of invoice creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results starting
+with the 11th result).
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Invoice >
+
+
+
+
+
+ pay()
+
+
+
+
+
+ Pay an invoice with a mock transaction
+
+
+ public
+ pay ( string $invoiceId [ , string $status = 'confirmed' ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+ = 'confirmed'
+
+ Status the invoice will become. Acceptable values are confirmed (default) and complete.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoicePaymentException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Invoice object.
+
+
+
+
+
+
+
+ requestNotification()
+
+
+
+
+
+ Request a BitPay Invoice Webhook.
+
+
+ public
+ requestNotification ( string $invoiceId ) : bool
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the webhook was successfully requested, false otherwise.
+
+
+
+
+
+
+
+ update()
+
+
+
+
+
+ Update a BitPay invoice.
+
+
+ public
+ update ( string $invoiceId , string|null $buyerSms , string|null $smsCode , string|null $buyerEmail [ , false $autoVerify = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $buyerSms
+ : string|null
+
+
+ The buyer's cell number.
+
+
+
+
+ $smsCode
+ : string|null
+
+
+ The buyer's received verification code.
+
+
+
+
+ $buyerEmail
+ : string|null
+
+
+ The buyer's email address.
+
+
+
+
+ $autoVerify
+ : false
+ = false
+
+ Skip the user verification on sandbox ONLY.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoiceUpdateException
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+ buyerEmailOrSms()
+
+
+
+
+
+ Check if buyerEmail or buyerSms is present, and not both.
+
+
+ private
+ buyerEmailOrSms ( string|null $buyerEmail , string|null $buyerSms ) : bool
+
+
+
+
+ Parameters
+
+
+ $buyerEmail
+ : string|null
+
+
+ The buyer's email address.
+
+
+
+
+ $buyerSms
+ : string|null
+
+
+ The buyer's cell number.
+
+
+
+
+
+
+
+
+
+
+
+
+ isSmsCodeRequired()
+
+
+
+
+
+ Check if smsCode is required.
+
+
+ private
+ isSmsCodeRequired ( bool $autoVerify , string $buyerSms , string $smsCode ) : bool
+
+
+
+
+ Parameters
+
+
+ $autoVerify
+ : bool
+
+
+ Skip the user verification on sandbox ONLY.
+
+
+
+
+ $buyerSms
+ : string
+
+
+ The buyer's cell number.
+
+
+
+
+ $smsCode
+ : string
+
+
+ The buyer's received verification code.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-LedgerClient.html b/docs/classes/BitPaySDK-Client-LedgerClient.html
new file mode 100644
index 00000000..9c2fbc07
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-LedgerClient.html
@@ -0,0 +1,780 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the ledger endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ get()
+
+ : array<string|int, LedgerEntry >
+
+Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Ledger Client.
+
+
+ getLedgers()
+
+ : array<string|int, Ledger >
+
+Retrieve a list of ledgers using the merchant facade.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ public
+ get ( string $currency , string $startDate , string $endDate ) : array<string|int, LedgerEntry >
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $startDate
+ : string
+
+
+ The first date for the query filter.
+
+
+
+
+ $endDate
+ : string
+
+
+ The last date for the query filter.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ LedgerQueryException
+
+
+
+
+
+
+ Return values
+ array<string|int, LedgerEntry >
+ —
+ A Ledger object populated with the BitPay ledger entries list.
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Ledger Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getLedgers()
+
+
+
+
+
+ Retrieve a list of ledgers using the merchant facade.
+
+
+ public
+ getLedgers ( ) : array<string|int, Ledger >
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Ledger >
+ —
+ A list of Ledger objects populated with the currency and current balance of each one.
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-PayoutClient.html b/docs/classes/BitPaySDK-Client-PayoutClient.html
new file mode 100644
index 00000000..2454bf1e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-PayoutClient.html
@@ -0,0 +1,1239 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the payout endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ cancel()
+
+ : bool
+
+Cancel a BitPay Payout.
+
+
+ cancelGroup()
+
+ : PayoutGroup
+
+
+
+ createGroup()
+
+ : PayoutGroup
+
+
+
+ get()
+
+ : Payout
+
+Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Payout Client.
+
+
+ getPayouts()
+
+ : array<string|int, Payout >
+
+Retrieve a collection of BitPay payouts.
+
+
+ requestNotification()
+
+ : bool
+
+Notify BitPay Payout.
+
+
+ submit()
+
+ : Payout
+
+Submit a BitPay Payout.
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getPayoutGroupResponse()
+
+ : PayoutGroup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cancel()
+
+
+
+
+
+ Cancel a BitPay Payout.
+
+
+ public
+ cancel ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to cancel.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ cancelGroup()
+
+
+
+
+
+
+
+ public
+ cancelGroup ( string $groupId ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $groupId
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ createGroup()
+
+
+
+
+
+
+
+ public
+ createGroup ( array<string|int, Payout > $payouts ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $payouts
+ : array<string|int, Payout >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ public
+ get ( string $payoutId ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to retrieve.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Payout Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getPayouts()
+
+
+
+
+
+ Retrieve a collection of BitPay payouts.
+
+
+ public
+ getPayouts ( [ string|null $startDate = null ] [ , string|null $endDate = null ] [ , string|null $status = null ] [ , string|null $reference = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Payout >
+
+
+
+
+ Parameters
+
+
+ $startDate
+ : string|null
+ = null
+
+ The start date to filter the Payout Batches.
+
+
+
+
+ $endDate
+ : string|null
+ = null
+
+ The end date to filter the Payout Batches.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The status to filter the Payout Batches.
+
+
+
+
+ $reference
+ : string|null
+ = null
+
+ The optional reference specified at payout request creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+ Return values
+ array<string|int, Payout >
+
+
+
+
+
+ requestNotification()
+
+
+
+
+
+ Notify BitPay Payout.
+
+
+ public
+ requestNotification ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the Payout to notify.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutNotificationException
+
+
+
+
+
+
+
+
+
+
+
+ submit()
+
+
+
+
+
+ Submit a BitPay Payout.
+
+
+ public
+ submit ( Payout $payout ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payout
+ : Payout
+
+
+ A Payout object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutGroupResponse()
+
+
+
+
+
+
+
+ private
+ getPayoutGroupResponse ( string $responseJson , string $responseType ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $responseJson
+ : string
+
+
+
+
+
+ $responseType
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html b/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html
new file mode 100644
index 00000000..46236354
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html
@@ -0,0 +1,1092 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the recipients endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ delete()
+
+ : bool
+
+Delete a Payout Recipient.
+
+
+ get()
+
+ : PayoutRecipient
+
+Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Payout Recipients Client.
+
+
+ getPayoutRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Retrieve a collection of BitPay Payout Recipients.
+
+
+ requestNotification()
+
+ : bool
+
+Notify BitPay Payout Recipient.
+
+
+ submit()
+
+ : array<string|int, PayoutRecipients >
+
+Submit BitPay Payout Recipients.
+
+
+ update()
+
+ : PayoutRecipient
+
+Update a Payout Recipient.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ delete()
+
+
+
+
+
+ Delete a Payout Recipient.
+
+
+ public
+ delete ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be deleted.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCancellationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the recipient was successfully deleted, false otherwise.
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ public
+ get ( string $recipientId ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to retrieve.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException |PayoutRecipientQueryException
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Payout Recipients Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getPayoutRecipients()
+
+
+
+
+
+ Retrieve a collection of BitPay Payout Recipients.
+
+
+ public
+ getPayoutRecipients ( [ string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, PayoutRecipient >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string|null
+ = null
+
+ The recipient status you want to query on.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ requestNotification()
+
+
+
+
+
+ Notify BitPay Payout Recipient.
+
+
+ public
+ requestNotification ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to notify.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientNotificationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the notification was successfully sent, false otherwise.
+
+
+
+
+
+
+
+ submit()
+
+
+
+
+
+ Submit BitPay Payout Recipients.
+
+
+ public
+ submit ( PayoutRecipients $recipients ) : array<string|int, PayoutRecipients >
+
+
+
+
+ Parameters
+
+
+ $recipients
+ : PayoutRecipients
+
+
+ A PayoutRecipients object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCreationException
+
+
+
+
+
+
+ Return values
+ array<string|int, PayoutRecipients >
+ —
+ A list of BitPay PayoutRecipients objects.
+
+
+
+
+
+
+
+ update()
+
+
+
+
+
+ Update a Payout Recipient.
+
+
+ public
+ update ( string $recipientId , PayoutRecipient $recipient ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be updated.
+
+
+
+
+ $recipient
+ : PayoutRecipient
+
+
+ A PayoutRecipient object with updated parameters defined.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientUpdateException
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-RateClient.html b/docs/classes/BitPaySDK-Client-RateClient.html
new file mode 100644
index 00000000..3ea9dedc
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-RateClient.html
@@ -0,0 +1,790 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the rate endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+
+
+ Methods
+
+
+
+
+
+ getCurrencyPairRate()
+
+ : Rate
+
+Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ getCurrencyRates()
+
+ : Rates
+
+Retrieve all the rates for a given cryptocurrency
+
+
+ getInstance()
+
+ : static
+
+Factory method for Rate Client.
+
+
+ getRates()
+
+ : Rates
+
+Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getCurrencyPairRate()
+
+
+
+
+
+ Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ public
+ getCurrencyPairRate ( string $baseCurrency , string $currency ) : Rate
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the fiat-equivalent rate.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+ $currency
+ : string
+
+
+ The fiat currency for which you want to fetch the baseCurrency rate
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rate
+ —
+ A Rate object populated with the currency rate for the requested baseCurrency.
+
+
+
+
+
+
+
+ getCurrencyRates()
+
+
+
+
+
+ Retrieve all the rates for a given cryptocurrency
+
+
+ public
+ getCurrencyRates ( string $baseCurrency ) : Rates
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the rates.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+ —
+ A Rates object populated with the currency rates for the requested baseCurrency.
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Rate Client.
+
+
+ public
+ static getInstance ( RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getRates()
+
+
+
+
+
+ Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
+
+
+ public
+ getRates ( ) : Rates
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-RefundClient.html b/docs/classes/BitPaySDK-Client-RefundClient.html
new file mode 100644
index 00000000..930eee4a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-RefundClient.html
@@ -0,0 +1,1543 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the refund endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ cancel()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ cancelByGuid()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ create()
+
+ : Refund
+
+Create a refund for a BitPay invoice.
+
+
+ get()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice.
+
+
+ getByGuid()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice by guid.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Bill Client.
+
+
+ getRefunds()
+
+ : array<string|int, Refund >
+
+Retrieve all refund requests on a BitPay invoice.
+
+
+ sendNotification()
+
+ : bool
+
+Send a refund notification.
+
+
+ update()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ updateByGuid()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cancel()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancel ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+ The refund Id for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ cancelByGuid()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancelByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The refund Guid for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+ since
+
+
+ 7.2.0
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ create()
+
+
+
+
+
+ Create a refund for a BitPay invoice.
+
+
+ public
+ create ( string $invoiceId , float $amount , string $currency [ , bool $preview = false ] [ , bool $immediate = false ] [ , bool $buyerPaysRefundFee = false ] [ , string|null $guid = null ] ) : Refund
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice Id having the associated refund to be created.
+
+
+
+
+ $amount
+ : float
+
+
+ Amount to be refunded in the currency indicated.
+
+
+
+
+ $currency
+ : string
+
+
+ Reference currency used for the refund, usually the same as the currency used
+to create the invoice.
+
+
+
+
+ $preview
+ : bool
+ = false
+
+ Whether to create the refund request as a preview (which will not be acted on
+until status is updated)
+
+
+
+
+ $immediate
+ : bool
+ = false
+
+ Whether funds should be removed from merchant ledger immediately on submission
+or at time of processing
+
+
+
+
+ $buyerPaysRefundFee
+ : bool
+ = false
+
+ Whether the buyer should pay the refund fee (default is merchant)
+
+
+
+
+ $guid
+ : string|null
+ = null
+
+ Variable provided by the merchant and designed to be used by the merchant to
+correlate the refund with a refund ID in their system
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundCreationException
+
+ RefundCreationException class
+
+
+
+
+ throws
+
+
+ BitPayException
+
+ BitPayException class*@throws Exception
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+ since
+
+
+ 7.2.0)
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund An updated Refund Object
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice.
+
+
+ public
+ get ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getByGuid()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice by guid.
+
+
+ public
+ getByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The BitPay refund Guid.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+ since
+
+
+ 7.2.0
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Bill Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getRefunds()
+
+
+
+
+
+ Retrieve all refund requests on a BitPay invoice.
+
+
+ public
+ getRefunds ( string $invoiceId ) : array<string|int, Refund >
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice object having the associated refunds.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ array<string|int, Refund >
+
+
+
+
+
+ sendNotification()
+
+
+
+
+
+ Send a refund notification.
+
+
+ public
+ sendNotification ( string $refundId ) : bool
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ $result An updated Refund Object
+
+
+
+
+
+
+
+ update()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ update ( string $refundId , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ updateByGuid()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ updateByGuid ( string $guid , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+ since
+
+
+ 7.2.0
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-SettlementClient.html b/docs/classes/BitPaySDK-Client-SettlementClient.html
new file mode 100644
index 00000000..28a5ab4a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-SettlementClient.html
@@ -0,0 +1,885 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the settlement endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ get()
+
+ : Settlement
+
+Retrieves a summary of the specified settlement.
+
+
+ getInstance()
+
+ : static
+
+Factory method for Settlements Client.
+
+
+ getReconciliationReport()
+
+ : Settlement
+
+Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ getSettlements()
+
+ : array<string|int, Settlement >
+
+Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ private
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get()
+
+
+
+
+
+ Retrieves a summary of the specified settlement.
+
+
+ public
+ get ( string $settlementId ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlementId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Settlements Client.
+
+
+ public
+ static getInstance ( Tokens $tokenCache , RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getReconciliationReport()
+
+
+
+
+
+ Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ public
+ getReconciliationReport ( Settlement $settlement ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlement
+ : Settlement
+
+
+ Settlement to generate report for.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSettlements()
+
+
+
+
+
+ Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ public
+ getSettlements ( string $currency , string $dateStart , string $dateEnd [ , string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Settlement >
+
+
+
+ The limit and offset parameters
+specify pages for large query sets.
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $dateStart
+ : string
+
+
+ The start date for the query.
+
+
+
+
+ $dateEnd
+ : string
+
+
+ The end date for the query.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ string Can be processing, completed, or failed.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ int Maximum number of settlements to retrieve.
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementQueryException
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( Tokens $tokenCache , RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-TokenClient.html b/docs/classes/BitPaySDK-Client-TokenClient.html
new file mode 100644
index 00000000..40abee89
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-TokenClient.html
@@ -0,0 +1,637 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TokenClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the token endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+
+
+ Methods
+
+
+
+
+
+ getInstance()
+
+ : static
+
+Factory method for Token Client.
+
+
+ getTokens()
+
+ : array<string|int, mixed>
+
+Get Tokens.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Token Client.
+
+
+ public
+ static getInstance ( RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getTokens()
+
+
+
+
+
+ Get Tokens.
+
+
+ public
+ getTokens ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ JsonException
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client-WalletClient.html b/docs/classes/BitPaySDK-Client-WalletClient.html
new file mode 100644
index 00000000..b08a31e9
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client-WalletClient.html
@@ -0,0 +1,637 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Handles interactions with the wallet endpoints.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $instance
+
+ : self|null
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+
+
+ Methods
+
+
+
+
+
+ getInstance()
+
+ : static
+
+Factory method for Wallet Client.
+
+
+ getSupportedWallets()
+
+ : array<string|int, Wallet >
+
+Retrieve all supported wallets.
+
+
+ __construct()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $instance
+
+
+
+
+
+
+
+
+
+ private
+ static self|null
+ $instance
+ = null
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ private
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getInstance()
+
+
+
+
+
+ Factory method for Wallet Client.
+
+
+ public
+ static getInstance ( RESTcli $restCli ) : static
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ getSupportedWallets()
+
+
+
+
+
+ Retrieve all supported wallets.
+
+
+ public
+ getSupportedWallets ( ) : array<string|int, Wallet >
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ WalletQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Wallet >
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ private
+ __construct ( RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Client.html b/docs/classes/BitPaySDK-Client.html
new file mode 100644
index 00000000..df6a121f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Client.html
@@ -0,0 +1,5647 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client class to interact with the BitPay API.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Client constructor.
+
+
+ cancelInvoice()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ cancelInvoiceByGuid()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ cancelPayout()
+
+ : bool
+
+Cancel a BitPay Payout.
+
+
+ cancelPayoutGroup()
+
+ : PayoutGroup
+
+
+
+ cancelRefund()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ cancelRefundByGuid()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ createBill()
+
+ : Bill
+
+Create a BitPay Bill.
+
+
+ createInvoice()
+
+ : Invoice
+
+Create a BitPay invoice.
+
+
+ createPayoutGroup()
+
+ : PayoutGroup
+
+
+
+ createRefund()
+
+ : Refund
+
+Create a refund for a BitPay invoice.
+
+
+ createWithData()
+
+ : Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
+
+ createWithFile()
+
+ : Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
+
+ deletePayoutRecipient()
+
+ : bool
+
+Delete a Payout Recipient.
+
+
+ deliverBill()
+
+ : bool
+
+Deliver a BitPay Bill.
+
+
+ getBill()
+
+ : Bill
+
+Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ getBills()
+
+ : array<string|int, Bill >
+
+Retrieve a collection of BitPay bills.
+
+
+ getCurrencyPairRate()
+
+ : Rate
+
+Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ getCurrencyRates()
+
+ : Rates
+
+Retrieve all the rates for a given cryptocurrency
+
+
+ getInvoice()
+
+ : Invoice
+
+Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ getInvoiceByGuid()
+
+ : Invoice
+
+Retrieve a BitPay invoice by guid using the specified facade.
+
+
+ getInvoices()
+
+ : array<string|int, Invoice >
+
+Retrieve a collection of BitPay invoices.
+
+
+ getLedgerEntries()
+
+ : array<string|int, LedgerEntry >
+
+Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ getLedgers()
+
+ : array<string|int, Ledger >
+
+Retrieve a list of ledgers using the merchant facade.
+
+
+ getPayout()
+
+ : Payout
+
+Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ getPayoutRecipient()
+
+ : PayoutRecipient
+
+Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ getPayoutRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Retrieve a collection of BitPay Payout Recipients.
+
+
+ getPayouts()
+
+ : array<string|int, Payout >
+
+Retrieve a collection of BitPay payouts.
+
+
+ getRates()
+
+ : Rates
+
+Retrieve the exchange rate table maintained by BitPay.
+
+
+ getRefund()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice.
+
+
+ getRefundByGuid()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice.
+
+
+ getRefunds()
+
+ : array<string|int, Refund >
+
+Retrieve all refund requests on a BitPay invoice.
+
+
+ getSettlement()
+
+ : Settlement
+
+Retrieves a summary of the specified settlement.
+
+
+ getSettlementReconciliationReport()
+
+ : Settlement
+
+Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ getSettlements()
+
+ : array<string|int, Settlement >
+
+Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ getSupportedWallets()
+
+ : array<string|int, Wallet >
+
+Retrieve all supported wallets.
+
+
+ getTokens()
+
+ : array<string|int, mixed>
+
+Get Tokens.
+
+
+ payInvoice()
+
+ : Invoice
+
+Pay an invoice with a mock transaction
+
+
+ requestInvoiceNotification()
+
+ : bool
+
+Request a BitPay Invoice Webhook.
+
+
+ requestPayoutNotification()
+
+ : bool
+
+Notify BitPay Payout.
+
+
+ requestPayoutRecipientNotification()
+
+ : bool
+
+Notify BitPay Payout Recipient.
+
+
+ sendRefundNotification()
+
+ : bool
+
+Send a refund notification.
+
+
+ submitPayout()
+
+ : Payout
+
+Submit a BitPay Payout.
+
+
+ submitPayoutRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Submit BitPay Payout Recipients.
+
+
+ updateBill()
+
+ : Bill
+
+Update a BitPay Bill.
+
+
+ updateInvoice()
+
+ : Invoice
+
+Update a BitPay invoice.
+
+
+ updatePayoutRecipient()
+
+ : PayoutRecipient
+
+Update a Payout Recipient.
+
+
+ updateRefund()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ updateRefundByGuid()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ getBillClient()
+
+ : BillClient
+
+Gets bill client
+
+
+ getInvoiceClient()
+
+ : InvoiceClient
+
+Gets invoice client
+
+
+ getLedgerClient()
+
+ : LedgerClient
+
+Gets ledger client
+
+
+ getPayoutClient()
+
+ : PayoutClient
+
+Gets payout client
+
+
+ getPayoutRecipientsClient()
+
+ : PayoutRecipientsClient
+
+Gets payout recipients client
+
+
+ getRateClient()
+
+ : RateClient
+
+Gets rate client
+
+
+ getRefundClient()
+
+ : RefundClient
+
+Gets refund client
+
+
+ getSettlementClient()
+
+ : SettlementClient
+
+Gets settlement client
+
+
+ getWalletClient()
+
+ : WalletClient
+
+Gets wallet client
+
+
+ getConfigData()
+
+ : array<string|int, mixed>
+
+
+
+ getTokenClient()
+
+ : TokenClient
+
+Gets token client
+
+
+ initKeys()
+
+ : PrivateKey |null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ protected
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ protected
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Client constructor.
+
+
+ public
+ __construct ( RESTcli $restCli , Tokens $tokenCache ) : mixed
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+ $tokenCache
+ : Tokens
+
+
+
+
+
+
+
+
+
+
+
+
+ cancelInvoice()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancelInvoice ( string $invoiceId [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-an-invoice
+
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ cancelInvoiceByGuid()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancelInvoiceByGuid ( string $guid [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the invoice to cancel.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-an-invoice-by-guid
+
+ Cancel an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ cancelPayout()
+
+
+
+
+
+ Cancel a BitPay Payout.
+
+
+ public
+ cancelPayout ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to cancel.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ cancelPayoutGroup()
+
+
+
+
+
+
+
+ public
+ cancelPayoutGroup ( string $groupId ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $groupId
+ : string
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-payout-group
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ cancelRefund()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancelRefund ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+ The refund Id for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-refund-request
+
+ Cancel a Refund Request
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ cancelRefundByGuid()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancelRefundByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The refund Guid for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-refund-by-guid-request
+
+ Cancel a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ createBill()
+
+
+
+
+
+ Create a BitPay Bill.
+
+
+ public
+ createBill ( Bill $bill [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createInvoice()
+
+
+
+
+
+ Create a BitPay invoice.
+
+
+ public
+ createInvoice ( Invoice $invoice [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : Invoice
+
+
+ An Invoice object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-an-invoice
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createPayoutGroup()
+
+
+
+
+
+
+
+ public
+ createPayoutGroup ( array<string|int, Payout > $payouts ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $payouts
+ : array<string|int, Payout >
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-payout-group
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ createRefund()
+
+
+
+
+
+ Create a refund for a BitPay invoice.
+
+
+ public
+ createRefund ( string $invoiceId , float $amount , string $currency [ , bool $preview = false ] [ , bool $immediate = false ] [ , bool $buyerPaysRefundFee = false ] [ , string|null $guid = null ] ) : Refund
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice Id having the associated refund to be created.
+
+
+
+
+ $amount
+ : float
+
+
+ Amount to be refunded in the currency indicated.
+
+
+
+
+ $currency
+ : string
+
+
+ Reference currency used for the refund, usually the same as the currency used
+to create the invoice.
+
+
+
+
+ $preview
+ : bool
+ = false
+
+ Whether to create the refund request as a preview (which will not be acted on
+until status is updated)
+
+
+
+
+ $immediate
+ : bool
+ = false
+
+ Whether funds should be removed from merchant ledger immediately on submission
+or at time of processing
+
+
+
+
+ $buyerPaysRefundFee
+ : bool
+ = false
+
+ Whether the buyer should pay the refund fee (default is merchant)
+
+
+
+
+ $guid
+ : string|null
+ = null
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-refund-request
+
+ Create a Refund Request
+
+
+
+
+ throws
+
+
+ RefundCreationException
+
+ RefundCreationException class
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund An updated Refund Object
+
+
+
+
+
+
+
+ createWithData()
+
+
+
+
+
+ Constructor for use if the keys and SIN are managed by this library.
+
+
+ public
+ static createWithData ( string $environment , string $privateKey , Tokens $tokens [ , string|null $privateKeySecret = null ] [ , string|null $proxy = null ] ) : Client
+
+
+
+
+ Parameters
+
+
+ $environment
+ : string
+
+
+ Target environment. Options: Env.Test / Env.Prod
+
+
+
+
+ $privateKey
+ : string
+
+
+ Private Key file path or the HEX value.
+
+
+
+
+ $tokens
+ : Tokens
+
+
+ Tokens containing the available tokens.
+
+
+
+
+ $privateKeySecret
+ : string|null
+ = null
+
+ Private Key encryption password.
+
+
+
+
+ $proxy
+ : string|null
+ = null
+
+ The url of your proxy to forward requests through. Example:
+http://********.com:3128
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createWithFile()
+
+
+
+
+
+ Constructor for use if the keys and SIN are managed by this library.
+
+
+ public
+ static createWithFile ( string $configFilePath ) : Client
+
+
+
+
+ Parameters
+
+
+ $configFilePath
+ : string
+
+
+ The path to the configuration file.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+ deletePayoutRecipient()
+
+
+
+
+
+ Delete a Payout Recipient.
+
+
+ public
+ deletePayoutRecipient ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be deleted.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/remove-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCancellationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the recipient was successfully deleted, false otherwise.
+
+
+
+
+
+
+
+ deliverBill()
+
+
+
+
+
+ Deliver a BitPay Bill.
+
+
+ public
+ deliverBill ( string $billId , string $billToken [ , bool $signRequest = true ] ) : bool
+
+
+
+
+ Parameters
+
+
+ $billId
+ : string
+
+
+ The id of the requested bill.
+
+
+
+
+ $billToken
+ : string
+
+
+ The token of the requested bill.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/deliver-a-bill-via-email
+
+ Deliver a Bill Via Email
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getBill()
+
+
+
+
+
+ Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ public
+ getBill ( $billId [ , $facade = Facade::MERCHANT ] [ , $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $billId
+ :
+
+
+ string The id of the bill to retrieve.
+
+
+
+
+ $facade
+ :
+ = Facade::MERCHANT
+
+ string The facade used to retrieve it.
+
+
+
+
+ $signRequest
+ :
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getBills()
+
+
+
+
+
+ Retrieve a collection of BitPay bills.
+
+
+ public
+ getBills ( [ string $status = null ] ) : array<string|int, Bill >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+ = null
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-bills-by-status
+
+ Retrieve Bills by Status
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Bill >
+
+
+
+
+
+ getCurrencyPairRate()
+
+
+
+
+
+ Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ public
+ getCurrencyPairRate ( string $baseCurrency , string $currency ) : Rate
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the fiat-equivalent rate.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+ $currency
+ : string
+
+
+ The fiat currency for which you want to fetch the baseCurrency rate
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-the-rates-for-a-cryptocurrency-fiat-pair
+
+ Retrieve the rates for a cryptocurrency / fiat pair
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rate
+ —
+ A Rate object populated with the currency rate for the requested baseCurrency.
+
+
+
+
+
+
+
+ getCurrencyRates()
+
+
+
+
+
+ Retrieve all the rates for a given cryptocurrency
+
+
+ public
+ getCurrencyRates ( string $baseCurrency ) : Rates
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the rates.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-all-the-rates-for-a-given-cryptocurrency
+
+ Retrieve all the rates for a given cryptocurrency
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+ —
+ A Rates object populated with the currency rates for the requested baseCurrency.
+
+
+
+
+
+
+
+ getInvoice()
+
+
+
+
+
+ Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ public
+ getInvoice ( string $invoiceId [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to retrieve.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid
+
+ Retrieve an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getInvoiceByGuid()
+
+
+
+
+
+ Retrieve a BitPay invoice by guid using the specified facade.
+
+
+ public
+ getInvoiceByGuid ( string $guid [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+ The client must have been previously authorized for the specified facade.
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the invoice to retrieve.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid
+
+ Retrieve an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getInvoices()
+
+
+
+
+
+ Retrieve a collection of BitPay invoices.
+
+
+ public
+ getInvoices ( string $dateStart , string $dateEnd [ , string|null $status = null ] [ , string|null $orderId = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Invoice >
+
+
+
+
+ Parameters
+
+
+ $dateStart
+ : string
+
+
+ The start of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $dateEnd
+ : string
+
+
+ The end of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The invoice status you want to query on.
+
+
+
+
+ $orderId
+ : string|null
+ = null
+
+ The optional order id specified at time of invoice creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results starting
+with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-invoices-filtered-by-query
+
+ Retrieve Invoices Filtered by Query
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Invoice >
+
+
+
+
+
+ getLedgerEntries()
+
+
+
+
+
+ Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ public
+ getLedgerEntries ( string $currency , string $startDate , string $endDate ) : array<string|int, LedgerEntry >
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $startDate
+ : string
+
+
+ The first date for the query filter.
+
+
+
+
+ $endDate
+ : string
+
+
+ The last date for the query filter.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-ledger-entries
+
+ Retrieve Ledger Entries
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, LedgerEntry >
+ —
+ A Ledger object populated with the BitPay ledger entries list.
+
+
+
+
+
+
+
+ getLedgers()
+
+
+
+
+
+ Retrieve a list of ledgers using the merchant facade.
+
+
+ public
+ getLedgers ( ) : array<string|int, Ledger >
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-account-balances
+
+ Retrieve Account Balances
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Ledger >
+ —
+ A list of Ledger objects populated with the currency and current balance of each one.
+
+
+
+
+
+
+
+ getPayout()
+
+
+
+
+
+ Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ public
+ getPayout ( string $payoutId ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to retrieve.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipient()
+
+
+
+
+
+ Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ public
+ getPayoutRecipient ( string $recipientId ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to retrieve.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+ throws
+
+
+ PayoutRecipientQueryException
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipients()
+
+
+
+
+
+ Retrieve a collection of BitPay Payout Recipients.
+
+
+ public
+ getPayoutRecipients ( [ string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, PayoutRecipient >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string|null
+ = null
+
+ The recipient status you want to query on.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-recipients-by-status
+
+ Retrieve Recipients by Status
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getPayouts()
+
+
+
+
+
+ Retrieve a collection of BitPay payouts.
+
+
+ public
+ getPayouts ( [ string|null $startDate = null ] [ , string|null $endDate = null ] [ , string|null $status = null ] [ , string|null $reference = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Payout >
+
+
+
+
+ Parameters
+
+
+ $startDate
+ : string|null
+ = null
+
+ The start date to filter the Payout Batches.
+
+
+
+
+ $endDate
+ : string|null
+ = null
+
+ The end date to filter the Payout Batches.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The status to filter the Payout Batches.
+
+
+
+
+ $reference
+ : string|null
+ = null
+
+ The optional reference specified at payout request creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-payouts-filtered-by-query
+
+ Retrieve Payouts Filtered by Query
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+ Return values
+ array<string|int, Payout >
+
+
+
+
+
+ getRates()
+
+
+
+
+
+ Retrieve the exchange rate table maintained by BitPay.
+
+
+ public
+ getRates ( ) : Rates
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/bitcoin-exchange-rates
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+
+
+
+
+
+ getRefund()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice.
+
+
+ public
+ getRefund ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-refund-request
+
+ Retrieve a Refund Request
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getRefundByGuid()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice.
+
+
+ public
+ getRefundByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-refund-by-guid-request
+
+ Retrieve a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getRefunds()
+
+
+
+
+
+ Retrieve all refund requests on a BitPay invoice.
+
+
+ public
+ getRefunds ( string $invoiceId ) : array<string|int, Refund >
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice object having the associated refunds.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-refunds-of-an-invoice
+
+ Retrieve Refunds of an Invoice
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Refund >
+
+
+
+
+
+ getSettlement()
+
+
+
+
+
+ Retrieves a summary of the specified settlement.
+
+
+ public
+ getSettlement ( string $settlementId ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlementId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-settlement
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSettlementReconciliationReport()
+
+
+
+
+
+ Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ public
+ getSettlementReconciliationReport ( Settlement $settlement ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlement
+ : Settlement
+
+
+ Settlement to generate report for.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/fetch-a-reconciliation-report
+
+ Fetch a Reconciliation Report
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSettlements()
+
+
+
+
+
+ Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ public
+ getSettlements ( $currency , $dateStart , $dateEnd [ , string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Settlement >
+
+
+
+ The limit and offset parameters
+specify pages for large query sets.
+
+
+ Parameters
+
+
+ $currency
+ :
+
+
+ string The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $dateStart
+ :
+
+
+ string The start date for the query.
+
+
+
+
+ $dateEnd
+ :
+
+
+ string The end date for the query.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ string Can be processing, completed, or failed.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ int Maximum number of settlements to retrieve.
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-settlements
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSupportedWallets()
+
+
+
+
+
+ Retrieve all supported wallets.
+
+
+ public
+ getSupportedWallets ( ) : array<string|int, Wallet >
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-the-supported-wallets
+
+ Retrieve the Supported Wallets
+
+
+
+
+ throws
+
+
+ WalletQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Wallet >
+
+
+
+
+
+ getTokens()
+
+
+
+
+
+ Get Tokens.
+
+
+ public
+ getTokens ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ JsonException
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ payInvoice()
+
+
+
+
+
+ Pay an invoice with a mock transaction
+
+
+ public
+ payInvoice ( string $invoiceId [ , string $status = 'confirmed' ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+ = 'confirmed'
+
+ Status the invoice will become. Acceptable values are confirmed (default) and complete.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoicePaymentException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Invoice object.
+
+
+
+
+
+
+
+ requestInvoiceNotification()
+
+
+
+
+
+ Request a BitPay Invoice Webhook.
+
+
+ public
+ requestInvoiceNotification ( string $invoiceId ) : bool
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-event-token
+
+ Retrieve an Event Token
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the webhook was successfully requested, false otherwise.
+
+
+
+
+
+
+
+ requestPayoutNotification()
+
+
+
+
+
+ Notify BitPay Payout.
+
+
+ public
+ requestPayoutNotification ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the Payout to notify.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-payout-webhook-to-be-resent
+
+ Request a Payout Webhook to be Resent
+
+
+
+
+ throws
+
+
+ PayoutNotificationException
+
+
+
+
+
+
+
+
+
+
+
+ requestPayoutRecipientNotification()
+
+
+
+
+
+ Notify BitPay Payout Recipient.
+
+
+ public
+ requestPayoutRecipientNotification ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to notify.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-recipient-webhook-to-be-resent
+
+ Request a Recipient Webhook to be Resent
+
+
+
+
+ throws
+
+
+ PayoutRecipientNotificationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the notification was successfully sent, false otherwise.
+
+
+
+
+
+
+
+ sendRefundNotification()
+
+
+
+
+
+ Send a refund notification.
+
+
+ public
+ sendRefundNotification ( string $refundId ) : bool
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-refund-notification-to-be-resent
+
+ Request a Refund Notification to be Resent
+
+
+
+
+ throws
+
+
+ RefundCreationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ $result An updated Refund Object
+
+
+
+
+
+
+
+ submitPayout()
+
+
+
+
+
+ Submit a BitPay Payout.
+
+
+ public
+ submitPayout ( Payout $payout ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payout
+ : Payout
+
+
+ A Payout object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ submitPayoutRecipients()
+
+
+
+
+
+ Submit BitPay Payout Recipients.
+
+
+ public
+ submitPayoutRecipients ( PayoutRecipients $recipients ) : array<string|int, PayoutRecipient >
+
+
+
+
+ Parameters
+
+
+ $recipients
+ : PayoutRecipients
+
+
+ A PayoutRecipients object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/invite-recipients
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCreationException
+
+
+
+
+
+
+ Return values
+ array<string|int, PayoutRecipient >
+ —
+ A list of BitPay PayoutRecipients objects.
+
+
+
+
+
+
+
+ updateBill()
+
+
+
+
+
+ Update a BitPay Bill.
+
+
+ public
+ updateBill ( Bill $bill , string $billId ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with the parameters to update defined.
+
+
+
+
+ $billId
+ : string
+
+
+ The Id of the Bill to update.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ updateInvoice()
+
+
+
+
+
+ Update a BitPay invoice.
+
+
+ public
+ updateInvoice ( string $invoiceId , string|null $buyerSms , string|null $smsCode , string|null $buyerEmail [ , bool $autoVerify = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $buyerSms
+ : string|null
+
+
+ The buyer's cell number.
+
+
+
+
+ $smsCode
+ : string|null
+
+
+ The buyer's received verification code.
+
+
+
+
+ $buyerEmail
+ : string|null
+
+
+ The buyer's email address.
+
+
+
+
+ $autoVerify
+ : bool
+ = false
+
+ Skip the user verification on sandbox ONLY.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-an-invoice
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ InvoiceUpdateException
+
+
+
+
+
+
+
+
+
+
+ updatePayoutRecipient()
+
+
+
+
+
+ Update a Payout Recipient.
+
+
+ public
+ updatePayoutRecipient ( string $recipientId , PayoutRecipient $recipient ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be updated.
+
+
+
+
+ $recipient
+ : PayoutRecipient
+
+
+ A PayoutRecipient object with updated parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientUpdateException
+
+
+
+
+
+
+
+
+
+
+ updateRefund()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ updateRefund ( string $refundId , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-refund-request
+
+ Update a Refund Request
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ updateRefundByGuid()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ updateRefundByGuid ( string $guid , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-refund-by-guid-request
+
+ Update a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ getBillClient()
+
+
+
+
+
+ Gets bill client
+
+
+ protected
+ getBillClient ( ) : BillClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getInvoiceClient()
+
+
+
+
+
+ Gets invoice client
+
+
+ protected
+ getInvoiceClient ( ) : InvoiceClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getLedgerClient()
+
+
+
+
+
+ Gets ledger client
+
+
+ protected
+ getLedgerClient ( ) : LedgerClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutClient()
+
+
+
+
+
+ Gets payout client
+
+
+ protected
+ getPayoutClient ( ) : PayoutClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipientsClient()
+
+
+
+
+
+ Gets payout recipients client
+
+
+ protected
+ getPayoutRecipientsClient ( ) : PayoutRecipientsClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getRateClient()
+
+
+
+
+
+ Gets rate client
+
+
+ protected
+ getRateClient ( ) : RateClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getRefundClient()
+
+
+
+
+
+ Gets refund client
+
+
+ protected
+ getRefundClient ( ) : RefundClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getSettlementClient()
+
+
+
+
+
+ Gets settlement client
+
+
+ protected
+ getSettlementClient ( ) : SettlementClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getWalletClient()
+
+
+
+
+
+ Gets wallet client
+
+
+ protected
+ getWalletClient ( ) : WalletClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getConfigData()
+
+
+
+
+
+
+
+ private
+ static getConfigData ( string $configFilePath ) : array<string|int, mixed>
+
+
+
+
+ Parameters
+
+
+ $configFilePath
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ getTokenClient()
+
+
+
+
+
+ Gets token client
+
+
+ private
+ getTokenClient ( ) : TokenClient
+
+
+
+
+
+
+
+
+
+
+
+
+ initKeys()
+
+
+
+
+
+
+
+ private
+ static initKeys ( string|null $privateKey , string|null $privateKeySecret ) : PrivateKey |null
+
+
+
+
+ Parameters
+
+
+ $privateKey
+ : string|null
+
+
+
+
+
+ $privateKeySecret
+ : string|null
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ PrivateKey |null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Env.html b/docs/classes/BitPaySDK-Env.html
new file mode 100644
index 00000000..8bc396f5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Env.html
@@ -0,0 +1,635 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Env
+
+
+
+
+
+ Constants used throughout the SDK.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ BITPAY_API_FRAME
+
+ = "std"
+
+
+
+ BITPAY_API_FRAME_VERSION
+
+ = "1.0.0"
+
+
+
+ BITPAY_API_VERSION
+
+ = "2.0.0"
+
+
+
+ BITPAY_PLUGIN_INFO
+
+ = "BitPay_PHP_Client_v8.0.2"
+
+
+
+ PROD
+
+ = "Prod"
+
+
+
+ PROD_URL
+
+ = "https://bitpay.com/"
+
+
+
+ TEST
+
+ = "Test"
+
+
+
+ TEST_URL
+
+ = "https://test.bitpay.com/"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BITPAY_API_FRAME
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BITPAY_API_FRAME
+ = "std"
+
+
+
+
+
+
+
+
+
+
+ BITPAY_API_FRAME_VERSION
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BITPAY_API_FRAME_VERSION
+ = "1.0.0"
+
+
+
+
+
+
+
+
+
+
+ BITPAY_API_VERSION
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BITPAY_API_VERSION
+ = "2.0.0"
+
+
+
+
+
+
+
+
+
+
+ BITPAY_PLUGIN_INFO
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BITPAY_PLUGIN_INFO
+ = "BitPay_PHP_Client_v8.0.2"
+
+
+
+
+
+
+
+
+
+
+ PROD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PROD
+ = "Prod"
+
+
+
+
+
+
+
+
+
+
+ PROD_URL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PROD_URL
+ = "https://bitpay.com/"
+
+
+
+
+
+
+
+
+
+
+ TEST
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TEST
+ = "Test"
+
+
+
+
+
+
+
+
+
+
+ TEST_URL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TEST_URL
+ = "https://test.bitpay.com/"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BillCreationException.html b/docs/classes/BitPaySDK-Exceptions-BillCreationException.html
new file mode 100644
index 00000000..5eb57def
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BillCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillCreationException
+
+
+ extends BillException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BillCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-BILL-CREATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create bill"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BillCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 112 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 112
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BillDeliveryException.html b/docs/classes/BitPaySDK-Exceptions-BillDeliveryException.html
new file mode 100644
index 00000000..047cbd7f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BillDeliveryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillDeliveryException
+
+
+ extends BillException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill delivery exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BillDeliveryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-BILL-DELIVERY"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to deliver bill"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BillDeliveryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 115 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 115
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BillException.html b/docs/classes/BitPaySDK-Exceptions-BillException.html
new file mode 100644
index 00000000..58384679
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BillException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BillException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-BILL-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the bill"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BillException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 111 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 111
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BillQueryException.html b/docs/classes/BitPaySDK-Exceptions-BillQueryException.html
new file mode 100644
index 00000000..b019623c
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BillQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillQueryException
+
+
+ extends BillException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BillQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-BILL-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve bill"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BillQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 113 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 113
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BillUpdateException.html b/docs/classes/BitPaySDK-Exceptions-BillUpdateException.html
new file mode 100644
index 00000000..79397c8c
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BillUpdateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillUpdateException
+
+
+ extends BillException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill update exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BillUpdateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-BILL-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to update bill"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BillUpdateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 114 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 114
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayException.html b/docs/classes/BitPaySDK-Exceptions-BitPayException.html
new file mode 100644
index 00000000..3dd371b2
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-BitPayException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPayException
+
+
+ extends Exception
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the BitPayException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Unexpected Bitpay exeption."
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the BitPayException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 100 ] [ , Exception $previous = null ] [ , string|null $apiCode = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 100
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = null
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-CurrencyException.html b/docs/classes/BitPaySDK-Exceptions-CurrencyException.html
new file mode 100644
index 00000000..a9047dd3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-CurrencyException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyException
+
+
+ extends BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic currency exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the CurrencyException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-CURRENCY-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the currencies"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the CurrencyException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 181 ] [ , Exception |null $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 181
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception |null
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-CurrencyQueryException.html b/docs/classes/BitPaySDK-Exceptions-CurrencyQueryException.html
new file mode 100644
index 00000000..767d64e1
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-CurrencyQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQueryException
+
+
+ extends CurrencyException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currency query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the CurrencyQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-CURRENCY-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve currencies"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the CurrencyQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 182 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 182
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoiceCancellationException.html b/docs/classes/BitPaySDK-Exceptions-InvoiceCancellationException.html
new file mode 100644
index 00000000..5b94a21a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoiceCancellationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCancellationException
+
+
+ extends InvoiceException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice cancellation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoiceCancellationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-CANCEL"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to cancel invoice object"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoiceCancellationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 105 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 105
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoiceCreationException.html b/docs/classes/BitPaySDK-Exceptions-InvoiceCreationException.html
new file mode 100644
index 00000000..7581b1f0
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoiceCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCreationException
+
+
+ extends InvoiceException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoiceCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-CREATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create invoice"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoiceCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 102 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 102
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoiceException.html b/docs/classes/BitPaySDK-Exceptions-InvoiceException.html
new file mode 100644
index 00000000..6e12dd81
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoiceException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceException
+
+
+ extends BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic invoice exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoiceException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the invoice"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoiceException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 101 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 101
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoicePaymentException.html b/docs/classes/BitPaySDK-Exceptions-InvoicePaymentException.html
new file mode 100644
index 00000000..d96551e4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoicePaymentException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoicePaymentException
+
+
+ extends InvoiceException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice payment exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoicePaymentException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-PAY-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to pay invoice"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoicePaymentException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 107 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 107
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoiceQueryException.html b/docs/classes/BitPaySDK-Exceptions-InvoiceQueryException.html
new file mode 100644
index 00000000..c7a7af3b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoiceQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceQueryException
+
+
+ extends InvoiceException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoiceQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve invoice"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoiceQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 103 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 103
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-InvoiceUpdateException.html b/docs/classes/BitPaySDK-Exceptions-InvoiceUpdateException.html
new file mode 100644
index 00000000..52da5e13
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-InvoiceUpdateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceUpdateException
+
+
+ extends InvoiceException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice update exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the InvoiceUpdateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-INVOICE-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to update invoice"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the InvoiceUpdateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 104 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 104
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-LedgerException.html b/docs/classes/BitPaySDK-Exceptions-LedgerException.html
new file mode 100644
index 00000000..43b5c888
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-LedgerException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic ledger exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the LedgerException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-LEDGER-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the ledger"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the LedgerException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 131 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 131
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-LedgerQueryException.html b/docs/classes/BitPaySDK-Exceptions-LedgerQueryException.html
new file mode 100644
index 00000000..5588c6b5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-LedgerQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerQueryException
+
+
+ extends LedgerException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ledger query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the LedgerQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-LEDGER-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve ledger"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the LedgerQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 132 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 132
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html
new file mode 100644
index 00000000..1f8ee0d5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCancellationException
+
+
+ extends PayoutBatchException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout batch cancellation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutBatchCancellationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-CANCEL"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to cancel payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutBatchCancellationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 204 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 204
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html
new file mode 100644
index 00000000..d3a91d51
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCreationException
+
+
+ extends PayoutBatchException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout batch creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutBatchCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-SUBMIT"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutBatchCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 202 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 202
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutBatchException.html b/docs/classes/BitPaySDK-Exceptions-PayoutBatchException.html
new file mode 100644
index 00000000..b0422b51
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutBatchException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchException
+
+
+ extends BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic payout batch exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutBatchException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutBatchException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 201 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 201
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html
new file mode 100644
index 00000000..7ee5a7a4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchNotificationException
+
+
+ extends PayoutBatchException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout batch notification exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutBatchNotificationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-NOTIFICATION"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to send payout batch notification"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutBatchNotificationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 205 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 205
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html b/docs/classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html
new file mode 100644
index 00000000..a6ec5a37
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout batch query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutBatchQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutBatchQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 203 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 203
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutCancellationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutCancellationException.html
new file mode 100644
index 00000000..3fa8e155
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutCancellationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCancellationException
+
+
+ extends PayoutException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout cancellation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutCancellationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-CANCEL"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to cancel payout"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutCancellationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 124 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 124
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutCreationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutCreationException.html
new file mode 100644
index 00000000..abe7549f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCreationException
+
+
+ extends PayoutException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic payout creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-SUBMIT"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create payout"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 122 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 122
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutException.html b/docs/classes/BitPaySDK-Exceptions-PayoutException.html
new file mode 100644
index 00000000..c68552f3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic payout batch exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the payout"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 121 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 121
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutNotificationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutNotificationException.html
new file mode 100644
index 00000000..74c1d5e8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutNotificationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutNotificationException
+
+
+ extends PayoutException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout notification exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutNotificationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-NOTIFICATION"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to send payout notification"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutNotificationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 126 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 126
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutQueryException.html b/docs/classes/BitPaySDK-Exceptions-PayoutQueryException.html
new file mode 100644
index 00000000..34860fa9
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutQueryException
+
+
+ extends PayoutException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 123 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 123
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html
new file mode 100644
index 00000000..1211fd63
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCancellationException
+
+
+ extends PayoutRecipientException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout recipient cancellation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientCancellationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-CANCEL"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to cancel payout recipient"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientCancellationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 194 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 194
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html
new file mode 100644
index 00000000..68d3145b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout recipient creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-SUBMIT"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create payout recipient"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 192 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 192
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientException.html
new file mode 100644
index 00000000..ffe13654
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientException
+
+
+ extends BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic recipient exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the payout recipient"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 191 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 191
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html
new file mode 100644
index 00000000..3b0fde56
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientNotificationException
+
+
+ extends PayoutRecipientException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout recipient notification exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientNotificationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-NOTIFICATION"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to send payout recipient notification"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientNotificationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 196 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 196
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html
new file mode 100644
index 00000000..f1fd321d
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout recipient query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve payout recipient"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 193 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 193
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html
new file mode 100644
index 00000000..e3c7fb0a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout recipient update exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutRecipientUpdateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-RECIPIENT-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to update payout recipient"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutRecipientUpdateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 195 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 195
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-PayoutUpdateException.html b/docs/classes/BitPaySDK-Exceptions-PayoutUpdateException.html
new file mode 100644
index 00000000..75049ab5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-PayoutUpdateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutUpdateException
+
+
+ extends PayoutException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout update exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the PayoutUpdateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-PAYOUT-BATCH-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to update payout batch"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the PayoutUpdateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 125 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 125
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RateException.html b/docs/classes/BitPaySDK-Exceptions-RateException.html
new file mode 100644
index 00000000..997e6783
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic rate exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-RATES-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the rates"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 141 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 141
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RateQueryException.html b/docs/classes/BitPaySDK-Exceptions-RateQueryException.html
new file mode 100644
index 00000000..05923f03
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RateQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateQueryException
+
+
+ extends RateException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RateQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-RATES-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve rates"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RateQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 142 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 142
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundCancellationException.html b/docs/classes/BitPaySDK-Exceptions-RefundCancellationException.html
new file mode 100644
index 00000000..29292845
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundCancellationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCancellationException
+
+
+ extends RefundException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund cancellation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundCancellationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-CANCEL"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to cancel refund object"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundCancellationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 165 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 165
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundCreationException.html b/docs/classes/BitPaySDK-Exceptions-RefundCreationException.html
new file mode 100644
index 00000000..7a81bbd7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundCreationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCreationException
+
+
+ extends RefundException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund creation exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundCreationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-CREATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to create refund"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundCreationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 162 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 162
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundException.html b/docs/classes/BitPaySDK-Exceptions-RefundException.html
new file mode 100644
index 00000000..363b4120
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic refund exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the refund"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 161 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 161
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundNotificationException.html b/docs/classes/BitPaySDK-Exceptions-RefundNotificationException.html
new file mode 100644
index 00000000..66862263
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundNotificationException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundNotificationException
+
+
+ extends RefundException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund notification exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundNotificationException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-NOTIFICATION"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to send refund notification"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundNotificationException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 166 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 166
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundQueryException.html b/docs/classes/BitPaySDK-Exceptions-RefundQueryException.html
new file mode 100644
index 00000000..a420969a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundQueryException
+
+
+ extends RefundException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve refund"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 163 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 163
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-RefundUpdateException.html b/docs/classes/BitPaySDK-Exceptions-RefundUpdateException.html
new file mode 100644
index 00000000..53b379c8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-RefundUpdateException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundUpdateException
+
+
+ extends RefundException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund update exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the RefundUpdateException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-REFUND-UPDATE"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to update refund"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the RefundUpdateException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 164 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 164
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-SettlementException.html b/docs/classes/BitPaySDK-Exceptions-SettlementException.html
new file mode 100644
index 00000000..d02507ea
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-SettlementException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementException
+
+
+ extends BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic settlement exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the SettlementException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-SETTLEMENTS-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the settlements"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the SettlementException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 151 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 151
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-SettlementQueryException.html b/docs/classes/BitPaySDK-Exceptions-SettlementQueryException.html
new file mode 100644
index 00000000..87c6f3a6
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-SettlementQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementQueryException
+
+
+ extends SettlementException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the SettlementQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-SETTLEMENTS-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve settlements"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the SettlementQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 152 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 152
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-WalletException.html b/docs/classes/BitPaySDK-Exceptions-WalletException.html
new file mode 100644
index 00000000..80b64a53
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-WalletException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic wallet exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the WalletException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-WALLET-GENERIC"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "An unexpected error occurred while trying to manage the wallet"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the WalletException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 181 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 181
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Exceptions-WalletQueryException.html b/docs/classes/BitPaySDK-Exceptions-WalletQueryException.html
new file mode 100644
index 00000000..f28dd91a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Exceptions-WalletQueryException.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletQueryException
+
+
+ extends WalletException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Wallet query exception.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $apiCode
+
+ : string|null
+
+
+
+ $bitPayCode
+
+ : string
+
+
+
+ $bitPayMessage
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Construct the WalletQueryException.
+
+
+ getApiCode()
+
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $apiCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $apiCode
+
+
+
+
+
+
+
+
+
+ $bitPayCode
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayCode
+ = "BITPAY-WALLET-GET"
+
+
+
+
+
+
+
+
+ $bitPayMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $bitPayMessage
+ = "Failed to retrieve supported wallets"
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Construct the WalletQueryException.
+
+
+ public
+ __construct ( [ string $message = "" ] [ , int $code = 183 ] [ , Exception $previous = null ] [ , string|null $apiCode = "000000" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $message
+ : string
+ = ""
+
+ [optional] The Exception message to throw.
+
+
+
+
+ $code
+ : int
+ = 183
+
+ [optional] The Exception code to throw.
+
+
+
+
+ $previous
+ : Exception
+ = null
+
+
+
+
+ $apiCode
+ : string|null
+ = "000000"
+
+ [optional] The API Exception code to throw.
+
+
+
+
+
+
+
+
+
+
+
+ getApiCode()
+
+
+
+
+
+
+
+ public
+ getApiCode ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+ Error code provided by the BitPay REST API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-AbstractClientTestCase.html b/docs/classes/BitPaySDK-Functional-AbstractClientTestCase.html
new file mode 100644
index 00000000..5b9423f0
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-AbstractClientTestCase.html
@@ -0,0 +1,475 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AbstractClientTestCase
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-BillClientTest.html b/docs/classes/BitPaySDK-Functional-BillClientTest.html
new file mode 100644
index 00000000..9c53d070
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-BillClientTest.html
@@ -0,0 +1,705 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testCreate()
+
+ : void
+
+
+
+ testDeliverBill()
+
+ : void
+
+
+
+ testGetBill()
+
+ : void
+
+
+
+ testGetBills()
+
+ : void
+
+
+
+ testUpdateBill()
+
+ : void
+
+
+
+ getBillExample()
+
+ : Bill
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testCreate()
+
+
+
+
+
+
+
+ public
+ testCreate ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testDeliverBill()
+
+
+
+
+
+
+
+ public
+ testDeliverBill ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetBill()
+
+
+
+
+
+
+
+ public
+ testGetBill ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetBills()
+
+
+
+
+
+
+
+ public
+ testGetBills ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateBill()
+
+
+
+
+
+
+
+ public
+ testUpdateBill ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ getBillExample()
+
+
+
+
+
+
+
+ private
+ getBillExample ( ) : Bill
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-Config.html b/docs/classes/BitPaySDK-Functional-Config.html
new file mode 100644
index 00000000..a57f5fc3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-Config.html
@@ -0,0 +1,427 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ BITPAY_CONFIG_FILE
+
+ = 'BitPay.config.yml'
+
+
+
+ FUNCTIONAL_TEST_PATH
+
+ = 'test/functional/BitPaySDK'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BITPAY_CONFIG_FILE
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BITPAY_CONFIG_FILE
+ = 'BitPay.config.yml'
+
+
+
+
+
+
+
+
+
+
+ FUNCTIONAL_TEST_PATH
+
+
+
+
+
+
+
+
+ public
+ mixed
+ FUNCTIONAL_TEST_PATH
+ = 'test/functional/BitPaySDK'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-InvoiceClientTest.html b/docs/classes/BitPaySDK-Functional-InvoiceClientTest.html
new file mode 100644
index 00000000..4ace4741
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-InvoiceClientTest.html
@@ -0,0 +1,819 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testCancel()
+
+ : void
+
+
+
+ testCancelInvoiceByGuid()
+
+ : mixed
+
+
+
+ testCreateInvoice()
+
+ : void
+
+
+
+ testGetInvoice()
+
+ : void
+
+
+
+ testGetInvoiceByGuid()
+
+ : void
+
+
+
+ testGetInvoices()
+
+ : void
+
+
+
+ testPayInvoice()
+
+ : void
+
+
+
+ testUpdateInvoice()
+
+ : void
+
+
+
+ getInvoiceExample()
+
+ : Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testCancel()
+
+
+
+
+
+
+
+ public
+ testCancel ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceByGuid()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateInvoice()
+
+
+
+
+
+
+
+ public
+ testCreateInvoice ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoice()
+
+
+
+
+
+
+
+ public
+ testGetInvoice ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceByGuid()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceByGuid ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoices()
+
+
+
+
+
+
+
+ public
+ testGetInvoices ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testPayInvoice()
+
+
+
+
+
+
+
+ public
+ testPayInvoice ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoice()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoice ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ getInvoiceExample()
+
+
+
+
+
+
+
+ private
+ getInvoiceExample ( ) : Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-LedgerClientTest.html b/docs/classes/BitPaySDK-Functional-LedgerClientTest.html
new file mode 100644
index 00000000..3ba405cf
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-LedgerClientTest.html
@@ -0,0 +1,587 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testGetLedger()
+
+ : void
+
+
+
+ testGetLedgers()
+
+ : void
+
+
+
+ testGetLedgerShouldCatchRestCliException()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetLedger()
+
+
+
+
+
+
+
+ public
+ testGetLedger ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgers()
+
+
+
+
+
+
+
+ public
+ testGetLedgers ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetLedgerShouldCatchRestCliException ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-PayoutClientTest.html b/docs/classes/BitPaySDK-Functional-PayoutClientTest.html
new file mode 100644
index 00000000..c1848568
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-PayoutClientTest.html
@@ -0,0 +1,709 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testPayoutGroupRequests()
+
+ : void
+
+
+
+ testPayoutRequests()
+
+ : mixed
+
+
+
+ getEmailFromFile()
+
+ : string
+
+
+
+ submitPayout()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testPayoutGroupRequests()
+
+
+
+
+
+
+
+ public
+ testPayoutGroupRequests ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+ testPayoutRequests()
+
+
+
+
+
+
+
+ public
+ testPayoutRequests ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getEmailFromFile()
+
+
+
+
+
+
+
+ private
+ getEmailFromFile ( string $path ) : string
+
+
+
+
+ Parameters
+
+
+ $path
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ submitPayout()
+
+
+
+
+
+
+
+ private
+ submitPayout ( string $currency , string $ledgerCurrency , int $amount ) : mixed
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+ $ledgerCurrency
+ : string
+
+
+
+
+
+ $amount
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-PayoutRecipientsClientTest.html b/docs/classes/BitPaySDK-Functional-PayoutRecipientsClientTest.html
new file mode 100644
index 00000000..1762ce4d
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-PayoutRecipientsClientTest.html
@@ -0,0 +1,754 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testDeletePayoutRecipient()
+
+ : void
+
+
+
+ testGetPayoutRecipient()
+
+ : mixed
+
+
+
+ testGetPayoutRecipients()
+
+ : void
+
+
+
+ testPayoutRecipientRequestNotification()
+
+ : void
+
+
+
+ testPayoutRecipientShouldCatchRestCliException()
+
+ : void
+
+
+
+ testSubmitPayoutRecipients()
+
+ : void
+
+
+
+ testUpdatePayoutRecipients()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testDeletePayoutRecipient()
+
+
+
+
+
+
+
+ public
+ testDeletePayoutRecipient ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipient()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipient ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipients()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipients ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testPayoutRecipientRequestNotification()
+
+
+
+
+
+
+
+ public
+ testPayoutRecipientRequestNotification ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testPayoutRecipientShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testPayoutRecipientShouldCatchRestCliException ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutRecipients()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutRecipients ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCreationException
+
+
+
+
+
+
+
+
+
+ testUpdatePayoutRecipients()
+
+
+
+
+
+
+
+ public
+ testUpdatePayoutRecipients ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-RateClientTest.html b/docs/classes/BitPaySDK-Functional-RateClientTest.html
new file mode 100644
index 00000000..5fb4408a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-RateClientTest.html
@@ -0,0 +1,587 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testGetCurrencyPairRate()
+
+ : void
+
+
+
+ testGetCurrencyRates()
+
+ : mixed
+
+
+
+ testGetRates()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetCurrencyPairRate()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyPairRate ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyRates()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRates()
+
+
+
+
+
+
+
+ public
+ testGetRates ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-RefundClientTest.html b/docs/classes/BitPaySDK-Functional-RefundClientTest.html
new file mode 100644
index 00000000..9c5467a7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-RefundClientTest.html
@@ -0,0 +1,743 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testCancelRefund()
+
+ : void
+
+
+
+ testCreateRefund()
+
+ : void
+
+
+
+ testCreateRefundShouldCatchRestCliException()
+
+ : void
+
+
+
+ testGetRefund()
+
+ : void
+
+
+
+ testGetRefunds()
+
+ : void
+
+
+
+ testSendNotification()
+
+ : void
+
+
+
+ getInvoiceExample()
+
+ : Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testCancelRefund()
+
+
+
+
+
+
+
+ public
+ testCancelRefund ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefund()
+
+
+
+
+
+
+
+ public
+ testCreateRefund ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefundShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCreateRefundShouldCatchRestCliException ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefund()
+
+
+
+
+
+
+
+ public
+ testGetRefund ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefunds()
+
+
+
+
+
+
+
+ public
+ testGetRefunds ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testSendNotification()
+
+
+
+
+
+
+
+ public
+ testSendNotification ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ getInvoiceExample()
+
+
+
+
+
+
+
+ private
+ getInvoiceExample ( ) : Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-SettlementsClientTest.html b/docs/classes/BitPaySDK-Functional-SettlementsClientTest.html
new file mode 100644
index 00000000..4406072a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-SettlementsClientTest.html
@@ -0,0 +1,587 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementsClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testGetReconciliationReport()
+
+ : void
+
+
+
+ testGetSettlement()
+
+ : void
+
+
+
+ testGetSettlements()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetReconciliationReport()
+
+
+
+
+
+
+
+ public
+ testGetReconciliationReport ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlement()
+
+
+
+
+
+
+
+ public
+ testGetSettlement ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlements()
+
+
+
+
+
+
+
+ public
+ testGetSettlements ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-TokenClientTest.html b/docs/classes/BitPaySDK-Functional-TokenClientTest.html
new file mode 100644
index 00000000..57c7ebae
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-TokenClientTest.html
@@ -0,0 +1,511 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testGetTokens()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetTokens()
+
+
+
+
+
+
+
+ public
+ testGetTokens ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Functional-WalletClientTest.html b/docs/classes/BitPaySDK-Functional-WalletClientTest.html
new file mode 100644
index 00000000..d1c20368
--- /dev/null
+++ b/docs/classes/BitPaySDK-Functional-WalletClientTest.html
@@ -0,0 +1,511 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletClientTest
+
+
+ extends AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $client
+
+ : Client
+
+
+
+
+
+ Methods
+
+
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testGetSupportedWallets()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetSupportedWallets()
+
+
+
+
+
+
+
+ public
+ testGetSupportedWallets ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Bill-Bill.html b/docs/classes/BitPaySDK-Model-Bill-Bill.html
new file mode 100644
index 00000000..3e74d8cc
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Bill-Bill.html
@@ -0,0 +1,3563 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $address1
+
+ : string|null
+
+
+
+ $address2
+
+ : string|null
+
+
+
+ $cc
+
+ : array<string|int, mixed>|null
+
+
+
+ $city
+
+ : string|null
+
+
+
+ $country
+
+ : string|null
+
+
+
+ $createDate
+
+ : string|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $dueDate
+
+ : string|null
+
+
+
+ $email
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $items
+
+ : array<string|int, mixed>
+
+
+
+ $merchant
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $number
+
+ : string|null
+
+
+
+ $passProcessingFee
+
+ : bool|null
+
+
+
+ $phone
+
+ : string|null
+
+
+
+ $state
+
+ : string|null
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $token
+
+ : string|null
+
+
+
+ $url
+
+ : string|null
+
+
+
+ $zip
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create a minimal request Bill object.
+
+
+ getAddress1()
+
+ : string|null
+
+Gets Bill recipient's address
+
+
+ getAddress2()
+
+ : string|null
+
+Gets Bill recipient's address
+
+
+ getCc()
+
+ : array<string|int, mixed>|null
+
+Gets Bill cc
+
+
+ getCity()
+
+ : string|null
+
+Gets Bill recipient's city
+
+
+ getCountry()
+
+ : string|null
+
+Gets Bill recipient's country
+
+
+ getCreateDate()
+
+ : string|null
+
+Gets bill create date
+
+
+ getCurrency()
+
+ : string|null
+
+Gets bill currency
+
+
+ getDueDate()
+
+ : string|null
+
+Gets Bill due date
+
+
+ getEmail()
+
+ : string|null
+
+Gets bill email
+
+
+ getId()
+
+ : string|null
+
+Gets bill id
+
+
+ getItems()
+
+ : array<string|int, mixed>
+
+Gets items from bill
+
+
+ getItemsAsArray()
+
+ : array<string|int, mixed>|null
+
+Gets items as array from bill
+
+
+ getMerchant()
+
+ : string|null
+
+Gets bill merchant
+
+
+ getName()
+
+ : string|null
+
+Gets Bill recipient's name
+
+
+ getNumber()
+
+ : string|null
+
+Gets bill number
+
+
+ getPassProcessingFee()
+
+ : bool|null
+
+Gets bill pass processing fee
+
+
+ getPhone()
+
+ : string|null
+
+Gets Bill recipient's phone number
+
+
+ getState()
+
+ : string|null
+
+Gets Bill recipient's state or province
+
+
+ getStatus()
+
+ : string|null
+
+Gets bill status
+
+
+ getToken()
+
+ : string|null
+
+Gets token
+
+
+ getUrl()
+
+ : string|null
+
+Gets bill url
+
+
+ getZip()
+
+ : string|null
+
+Gets Bill recipient's ZIP code
+
+
+ setAddress1()
+
+ : void
+
+Sets Bill recipient's address
+
+
+ setAddress2()
+
+ : void
+
+Sets Bill recipient's address
+
+
+ setCc()
+
+ : void
+
+Sets Bill's cc
+
+
+ setCity()
+
+ : void
+
+Sets Bill recipient's city
+
+
+ setCountry()
+
+ : void
+
+Sets Bill recipient's country
+
+
+ setCreateDate()
+
+ : void
+
+Sets Bill's create date
+
+
+ setCurrency()
+
+ : void
+
+Sets Bill's currency
+
+
+ setDueDate()
+
+ : void
+
+Sets Bill's due date
+
+
+ setEmail()
+
+ : void
+
+Sets Bill's email
+
+
+ setId()
+
+ : void
+
+Sets Bill's id
+
+
+ setItems()
+
+ : void
+
+Sets Bill's items
+
+
+ setMerchant()
+
+ : void
+
+Sets Bill's merchant
+
+
+ setName()
+
+ : void
+
+Sets Bill recipient's name
+
+
+ setNumber()
+
+ : void
+
+Sets Bill's number
+
+
+ setPassProcessingFee()
+
+ : void
+
+Sets Bill's pass processing fee
+
+
+ setPhone()
+
+ : void
+
+Sets Bill recipient's phone number
+
+
+ setState()
+
+ : void
+
+Sets Bill recipient's state or province
+
+
+ setStatus()
+
+ : void
+
+Sets Bill's status
+
+
+ setToken()
+
+ : void
+
+Sets Bill's token
+
+
+ setUrl()
+
+ : void
+
+Sets Bill's url
+
+
+ setZip()
+
+ : void
+
+Sets Bill recipient's ZIP code
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Get bill data as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $address1
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address1
+ = null
+
+
+
+
+
+
+
+
+ $address2
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address2
+ = null
+
+
+
+
+
+
+
+
+ $cc
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $cc
+ = null
+
+
+
+
+
+
+
+
+ $city
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $city
+ = null
+
+
+
+
+
+
+
+
+ $country
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $country
+ = null
+
+
+
+
+
+
+
+
+ $createDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $createDate
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $dueDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $dueDate
+ = null
+
+
+
+
+
+
+
+
+ $email
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $email
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $items
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $items
+ = []
+
+
+
+
+
+
+
+
+ $merchant
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $merchant
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $number
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $number
+ = null
+
+
+
+
+
+
+
+
+ $passProcessingFee
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $passProcessingFee
+ = null
+
+
+
+
+
+
+
+
+ $phone
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $phone
+ = null
+
+
+
+
+
+
+
+
+ $state
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $state
+ = null
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $token
+ = null
+
+
+
+
+
+
+
+
+ $url
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $url
+ = null
+
+
+
+
+
+
+
+
+ $zip
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $zip
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create a minimal request Bill object.
+
+
+ public
+ __construct ( [ string|null $number = null ] [ , string|null $currency = null ] [ , string|null $email = null ] [ , array<string|int, mixed>|null $items = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $number
+ : string|null
+ = null
+
+ string A string for tracking purposes.
+
+
+
+
+ $currency
+ : string|null
+ = null
+
+ string The three digit currency type used to compute the bill's amount.
+
+
+
+
+ $email
+ : string|null
+ = null
+
+ string The email address of the receiver for this bill.
+
+
+
+
+ $items
+ : array<string|int, mixed>|null
+ = null
+
+ array The list of items to add to this bill.
+
+
+
+
+
+
+
+
+
+
+
+ getAddress1()
+
+
+
+
+
+ Gets Bill recipient's address
+
+
+ public
+ getAddress1 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getAddress2()
+
+
+
+
+
+ Gets Bill recipient's address
+
+
+ public
+ getAddress2 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCc()
+
+
+
+
+
+ Gets Bill cc
+
+
+ public
+ getCc ( ) : array<string|int, mixed>|null
+
+
+
+ Email addresses to which a copy of the bill must be sent
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getCity()
+
+
+
+
+
+ Gets Bill recipient's city
+
+
+ public
+ getCity ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCountry()
+
+
+
+
+
+ Gets Bill recipient's country
+
+
+ public
+ getCountry ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCreateDate()
+
+
+
+
+
+ Gets bill create date
+
+
+ public
+ getCreateDate ( ) : string|null
+
+
+
+ Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets bill currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the price field
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getDueDate()
+
+
+
+
+
+ Gets Bill due date
+
+
+ public
+ getDueDate ( ) : string|null
+
+
+
+ Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getEmail()
+
+
+
+
+
+ Gets bill email
+
+
+ public
+ getEmail ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets bill id
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getItems()
+
+
+
+
+
+ Gets items from bill
+
+
+ public
+ getItems ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+ getItemsAsArray()
+
+
+
+
+
+ Gets items as array from bill
+
+
+ public
+ getItemsAsArray ( ) : array<string|int, mixed>|null
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+ items as array from bill
+
+
+
+
+
+
+
+ getMerchant()
+
+
+
+
+
+ Gets bill merchant
+
+
+ public
+ getMerchant ( ) : string|null
+
+
+
+ Internal identifier for BitPay, this field can be ignored by the merchants.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets Bill recipient's name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getNumber()
+
+
+
+
+
+ Gets bill number
+
+
+ public
+ getNumber ( ) : string|null
+
+
+
+ Bill identifier, specified by merchant
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPassProcessingFee()
+
+
+
+
+
+ Gets bill pass processing fee
+
+
+ public
+ getPassProcessingFee ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+ the pass processing fee
+
+
+
+
+
+
+
+ getPhone()
+
+
+
+
+
+ Gets Bill recipient's phone number
+
+
+ public
+ getPhone ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getState()
+
+
+
+
+
+ Gets Bill recipient's state or province
+
+
+ public
+ getState ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets bill status
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+ Can "draft", "sent", "new", "paid", or "complete"
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets token
+
+
+ public
+ getToken ( ) : string|null
+
+
+
+ API token for bill resource. This token is actually derived from the API token used to
+create the bill and is tied to the specific resource id created.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getUrl()
+
+
+
+
+
+ Gets bill url
+
+
+ public
+ getUrl ( ) : string|null
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getZip()
+
+
+
+
+
+ Gets Bill recipient's ZIP code
+
+
+ public
+ getZip ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAddress1()
+
+
+
+
+
+ Sets Bill recipient's address
+
+
+ public
+ setAddress1 ( string $address1 ) : void
+
+
+
+
+ Parameters
+
+
+ $address1
+ : string
+
+
+ Bill recipient's address
+
+
+
+
+
+
+
+
+
+
+
+ setAddress2()
+
+
+
+
+
+ Sets Bill recipient's address
+
+
+ public
+ setAddress2 ( string $address2 ) : void
+
+
+
+
+ Parameters
+
+
+ $address2
+ : string
+
+
+ Bill recipient's address
+
+
+
+
+
+
+
+
+
+
+
+ setCc()
+
+
+
+
+
+ Sets Bill's cc
+
+
+ public
+ setCc ( array<string|int, mixed> $cc ) : void
+
+
+
+ Email addresses to which a copy of the bill must be sent
+
+
+ Parameters
+
+
+ $cc
+ : array<string|int, mixed>
+
+
+ Email addresses to which a copy of the bill must be sent
+
+
+
+
+
+
+
+
+
+
+
+ setCity()
+
+
+
+
+
+ Sets Bill recipient's city
+
+
+ public
+ setCity ( string $city ) : void
+
+
+
+
+ Parameters
+
+
+ $city
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCountry()
+
+
+
+
+
+ Sets Bill recipient's country
+
+
+ public
+ setCountry ( string $country ) : void
+
+
+
+
+ Parameters
+
+
+ $country
+ : string
+
+
+ Bill recipient's country
+
+
+
+
+
+
+
+
+
+
+
+ setCreateDate()
+
+
+
+
+
+ Sets Bill's create date
+
+
+ public
+ setCreateDate ( string $createDate ) : void
+
+
+
+ Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+
+
+ Parameters
+
+
+ $createDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets Bill's currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the price field
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ 3-character currency code
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ setDueDate()
+
+
+
+
+
+ Sets Bill's due date
+
+
+ public
+ setDueDate ( string $dueDate ) : void
+
+
+
+ Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+
+
+ Parameters
+
+
+ $dueDate
+ : string
+
+
+ Date and time at which a bill is due
+
+
+
+
+
+
+
+
+
+
+
+ setEmail()
+
+
+
+
+
+ Sets Bill's email
+
+
+ public
+ setEmail ( string $email ) : void
+
+
+
+
+ Parameters
+
+
+ $email
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets Bill's id
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setItems()
+
+
+
+
+
+ Sets Bill's items
+
+
+ public
+ setItems ( array<string|int, mixed> $items ) : void
+
+
+
+
+ Parameters
+
+
+ $items
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setMerchant()
+
+
+
+
+
+ Sets Bill's merchant
+
+
+ public
+ setMerchant ( string $merchant ) : void
+
+
+
+ Internal identifier for BitPay, this field can be ignored by the merchants.
+
+
+ Parameters
+
+
+ $merchant
+ : string
+
+
+ Internal identifier for BitPay
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets Bill recipient's name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setNumber()
+
+
+
+
+
+ Sets Bill's number
+
+
+ public
+ setNumber ( string $number ) : void
+
+
+
+ Bill identifier, specified by merchant
+
+
+ Parameters
+
+
+ $number
+ : string
+
+
+ Bill identifier, specified by merchant
+
+
+
+
+
+
+
+
+
+
+
+ setPassProcessingFee()
+
+
+
+
+
+ Sets Bill's pass processing fee
+
+
+ public
+ setPassProcessingFee ( bool $passProcessingFee ) : void
+
+
+
+ If set to true, BitPay's processing fee will be included in the amount charged on the invoice
+
+
+ Parameters
+
+
+ $passProcessingFee
+ : bool
+
+
+ Bill's pass processing fee
+
+
+
+
+
+
+
+
+
+
+
+ setPhone()
+
+
+
+
+
+ Sets Bill recipient's phone number
+
+
+ public
+ setPhone ( string $phone ) : void
+
+
+
+
+ Parameters
+
+
+ $phone
+ : string
+
+
+ Bill recipient's phone number
+
+
+
+
+
+
+
+
+
+
+
+ setState()
+
+
+
+
+
+ Sets Bill recipient's state or province
+
+
+ public
+ setState ( string $state ) : void
+
+
+
+
+ Parameters
+
+
+ $state
+ : string
+
+
+ Bill recipient's state or province
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets Bill's status
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+ Can "draft", "sent", "new", "paid", or "complete"
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets Bill's token
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+ API token for bill resource. This token is actually derived from the API token used to
+create the bill and is tied to the specific resource id created.
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+ API token for bill resource
+
+
+
+
+
+
+
+
+
+
+
+ setUrl()
+
+
+
+
+
+ Sets Bill's url
+
+
+ public
+ setUrl ( string $url ) : void
+
+
+
+
+
+ Parameters
+
+
+ $url
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setZip()
+
+
+
+
+
+ Sets Bill recipient's ZIP code
+
+
+ public
+ setZip ( string $zip ) : void
+
+
+
+
+ Parameters
+
+
+ $zip
+ : string
+
+
+ Bill recipient's ZIP code
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Get bill data as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Bill-BillStatus.html b/docs/classes/BitPaySDK-Model-Bill-BillStatus.html
new file mode 100644
index 00000000..85829b4b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Bill-BillStatus.html
@@ -0,0 +1,544 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/bills
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ COMPLETE
+
+ = "complete"
+
+
+
+ DRAFT
+
+ = "draft"
+
+
+
+ NEW
+
+ = "new"
+
+
+
+ PAID
+
+ = "paid"
+
+
+
+ SENT
+
+ = "sent"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ COMPLETE
+
+
+
+
+
+
+
+
+ public
+ mixed
+ COMPLETE
+ = "complete"
+
+
+
+
+
+
+
+
+
+
+ DRAFT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DRAFT
+ = "draft"
+
+
+
+
+
+
+
+
+
+
+ NEW
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NEW
+ = "new"
+
+
+
+
+
+
+
+
+
+
+ PAID
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PAID
+ = "paid"
+
+
+
+
+
+
+
+
+
+
+ SENT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SENT
+ = "sent"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Bill-Item.html b/docs/classes/BitPaySDK-Model-Bill-Item.html
new file mode 100644
index 00000000..41ee4421
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Bill-Item.html
@@ -0,0 +1,1099 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Item
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/bills
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $description
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $price
+
+ : float|null
+
+
+
+ $quantity
+
+ : int|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ createFromArray()
+
+ : Item
+
+
+
+ getDescription()
+
+ : string|null
+
+Gets Line item description
+
+
+ getId()
+
+ : string|null
+
+Gets id.
+
+
+ getPrice()
+
+ : float|null
+
+Gets Line item unit price for the corresponding currency
+
+
+ getQuantity()
+
+ : int|null
+
+Gets Line item number of units
+
+
+ setDescription()
+
+ : void
+
+Sets Line item description
+
+
+ setId()
+
+ : void
+
+Sets id.
+
+
+ setPrice()
+
+ : void
+
+Sets Line item unit price for the corresponding currency
+
+
+ setQuantity()
+
+ : void
+
+Sets Line item number of units
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Item data as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $description
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $description
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $price
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $price
+ = null
+
+
+
+
+
+
+
+
+ $quantity
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $quantity
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createFromArray()
+
+
+
+
+
+
+
+ public
+ static createFromArray ( array<string|int, mixed> $item ) : Item
+
+
+
+
+ Parameters
+
+
+ $item
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getDescription()
+
+
+
+
+
+ Gets Line item description
+
+
+ public
+ getDescription ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets id.
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPrice()
+
+
+
+
+
+ Gets Line item unit price for the corresponding currency
+
+
+ public
+ getPrice ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getQuantity()
+
+
+
+
+
+ Gets Line item number of units
+
+
+ public
+ getQuantity ( ) : int|null
+
+
+
+
+
+
+
+
+ Return values
+ int|null
+ —
+
+
+
+
+
+
+
+ setDescription()
+
+
+
+
+
+ Sets Line item description
+
+
+ public
+ setDescription ( string $description ) : void
+
+
+
+
+ Parameters
+
+
+ $description
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets id.
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPrice()
+
+
+
+
+
+ Sets Line item unit price for the corresponding currency
+
+
+ public
+ setPrice ( float $price ) : void
+
+
+
+
+ Parameters
+
+
+ $price
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setQuantity()
+
+
+
+
+
+ Sets Line item number of units
+
+
+ public
+ setQuantity ( int $quantity ) : void
+
+
+
+
+ Parameters
+
+
+ $quantity
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Item data as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Currency.html b/docs/classes/BitPaySDK-Model-Currency.html
new file mode 100644
index 00000000..b93ef441
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Currency.html
@@ -0,0 +1,8487 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currency
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing currency information.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ AED
+
+ = "AED"
+
+
+
+ AFN
+
+ = "AFN"
+
+
+
+ ALL
+
+ = "ALL"
+
+
+
+ AMD
+
+ = "AMD"
+
+
+
+ ANG
+
+ = "ANG"
+
+
+
+ AOA
+
+ = "AOA"
+
+
+
+ ARS
+
+ = "ARS"
+
+
+
+ AUD
+
+ = "AUD"
+
+
+
+ AWG
+
+ = "AWG"
+
+
+
+ AZN
+
+ = "AZN"
+
+
+
+ BAM
+
+ = "BAM"
+
+
+
+ BBD
+
+ = "BBD"
+
+
+
+ BCH
+
+ = "BCH"
+
+
+
+ BDT
+
+ = "BDT"
+
+
+
+ BGN
+
+ = "BGN"
+
+
+
+ BHD
+
+ = "BHD"
+
+
+
+ BIF
+
+ = "BIF"
+
+
+
+ BMD
+
+ = "BMD"
+
+
+
+ BND
+
+ = "BND"
+
+
+
+ BOB
+
+ = "BOB"
+
+
+
+ BOV
+
+ = "BOV"
+
+
+
+ BRL
+
+ = "BRL"
+
+
+
+ BSD
+
+ = "BSD"
+
+
+
+ BTC
+
+ = "BTC"
+
+
+
+ BTN
+
+ = "BTN"
+
+
+
+ BUSD
+
+ = "BUSD"
+
+
+
+ BWP
+
+ = "BWP"
+
+
+
+ BYR
+
+ = "BYR"
+
+
+
+ BZD
+
+ = "BZD"
+
+
+
+ CAD
+
+ = "CAD"
+
+
+
+ CDF
+
+ = "CDF"
+
+
+
+ CHE
+
+ = "CHE"
+
+
+
+ CHF
+
+ = "CHF"
+
+
+
+ CHW
+
+ = "CHW"
+
+
+
+ CLF
+
+ = "CLF"
+
+
+
+ CLP
+
+ = "CLP"
+
+
+
+ CNY
+
+ = "CNY"
+
+
+
+ COP
+
+ = "COP"
+
+
+
+ COU
+
+ = "COU"
+
+
+
+ CRC
+
+ = "CRC"
+
+
+
+ CUC
+
+ = "CUC"
+
+
+
+ CUP
+
+ = "CUP"
+
+
+
+ CVE
+
+ = "CVE"
+
+
+
+ CZK
+
+ = "CZK"
+
+
+
+ DJF
+
+ = "DJF"
+
+
+
+ DKK
+
+ = "DKK"
+
+
+
+ DOGE
+
+ = "DOGE"
+
+
+
+ DOP
+
+ = "DOP"
+
+
+
+ DZD
+
+ = "DZD"
+
+
+
+ EGP
+
+ = "EGP"
+
+
+
+ ERN
+
+ = "ERN"
+
+
+
+ ETB
+
+ = "ETB"
+
+
+
+ ETH
+
+ = "ETH"
+
+
+
+ EUR
+
+ = "EUR"
+
+
+
+ FJD
+
+ = "FJD"
+
+
+
+ FKP
+
+ = "FKP"
+
+
+
+ GBP
+
+ = "GBP"
+
+
+
+ GEL
+
+ = "GEL"
+
+
+
+ GHS
+
+ = "GHS"
+
+
+
+ GIP
+
+ = "GIP"
+
+
+
+ GMD
+
+ = "GMD"
+
+
+
+ GNF
+
+ = "GNF"
+
+
+
+ GTQ
+
+ = "GTQ"
+
+
+
+ GUSD
+
+ = "GUSD"
+
+
+
+ GYD
+
+ = "GYD"
+
+
+
+ HKD
+
+ = "HKD"
+
+
+
+ HNL
+
+ = "HNL"
+
+
+
+ HRK
+
+ = "HRK"
+
+
+
+ HTG
+
+ = "HTG"
+
+
+
+ HUF
+
+ = "HUF"
+
+
+
+ IDR
+
+ = "IDR"
+
+
+
+ ILS
+
+ = "ILS"
+
+
+
+ INR
+
+ = "INR"
+
+
+
+ IQD
+
+ = "IQD"
+
+
+
+ IRR
+
+ = "IRR"
+
+
+
+ ISK
+
+ = "ISK"
+
+
+
+ JMD
+
+ = "JMD"
+
+
+
+ JOD
+
+ = "JOD"
+
+
+
+ JPY
+
+ = "JPY"
+
+
+
+ KES
+
+ = "KES"
+
+
+
+ KGS
+
+ = "KGS"
+
+
+
+ KHR
+
+ = "KHR"
+
+
+
+ KMF
+
+ = "KMF"
+
+
+
+ KPW
+
+ = "KPW"
+
+
+
+ KRW
+
+ = "KRW"
+
+
+
+ KWD
+
+ = "KWD"
+
+
+
+ KYD
+
+ = "KYD"
+
+
+
+ KZT
+
+ = "KZT"
+
+
+
+ LAK
+
+ = "LAK"
+
+
+
+ LBP
+
+ = "LBP"
+
+
+
+ LKR
+
+ = "LKR"
+
+
+
+ LRD
+
+ = "LRD"
+
+
+
+ LSL
+
+ = "LSL"
+
+
+
+ LTC
+
+ = "LTC"
+
+
+
+ LYD
+
+ = "LYD"
+
+
+
+ MAD
+
+ = "MAD"
+
+
+
+ MDL
+
+ = "MDL"
+
+
+
+ MGA
+
+ = "MGA"
+
+
+
+ MKD
+
+ = "MKD"
+
+
+
+ MMK
+
+ = "MMK"
+
+
+
+ MNT
+
+ = "MNT"
+
+
+
+ MOP
+
+ = "MOP"
+
+
+
+ MRU
+
+ = "MRU"
+
+
+
+ MUR
+
+ = "MUR"
+
+
+
+ MVR
+
+ = "MVR"
+
+
+
+ MWK
+
+ = "MWK"
+
+
+
+ MXN
+
+ = "MXN"
+
+
+
+ MXV
+
+ = "MXV"
+
+
+
+ MYR
+
+ = "MYR"
+
+
+
+ MZN
+
+ = "MZN"
+
+
+
+ NAD
+
+ = "NAD"
+
+
+
+ NGN
+
+ = "NGN"
+
+
+
+ NIO
+
+ = "NIO"
+
+
+
+ NOK
+
+ = "NOK"
+
+
+
+ NPR
+
+ = "NPR"
+
+
+
+ NZD
+
+ = "NZD"
+
+
+
+ OMR
+
+ = "OMR"
+
+
+
+ PAB
+
+ = "PAB"
+
+
+
+ PAX
+
+ = "PAX"
+
+
+
+ PEN
+
+ = "PEN"
+
+
+
+ PGK
+
+ = "PGK"
+
+
+
+ PHP
+
+ = "PHP"
+
+
+
+ PKR
+
+ = "PKR"
+
+
+
+ PLN
+
+ = "PLN"
+
+
+
+ PYG
+
+ = "PYG"
+
+
+
+ QAR
+
+ = "QAR"
+
+
+
+ RON
+
+ = "RON"
+
+
+
+ RSD
+
+ = "RSD"
+
+
+
+ RUB
+
+ = "RUB"
+
+
+
+ RWF
+
+ = "RWF"
+
+
+
+ SAR
+
+ = "SAR"
+
+
+
+ SBD
+
+ = "SBD"
+
+
+
+ SCR
+
+ = "SCR"
+
+
+
+ SDG
+
+ = "SDG"
+
+
+
+ SEK
+
+ = "SEK"
+
+
+
+ SGD
+
+ = "SGD"
+
+
+
+ SHIB
+
+ = "SHIB"
+
+
+
+ SHP
+
+ = "SHP"
+
+
+
+ SLL
+
+ = "SLL"
+
+
+
+ SOS
+
+ = "SOS"
+
+
+
+ SRD
+
+ = "SRD"
+
+
+
+ SSP
+
+ = "SSP"
+
+
+
+ STN
+
+ = "STN"
+
+
+
+ SVC
+
+ = "SVC"
+
+
+
+ SYP
+
+ = "SYP"
+
+
+
+ SZL
+
+ = "SZL"
+
+
+
+ THB
+
+ = "THB"
+
+
+
+ TJS
+
+ = "TJS"
+
+
+
+ TMT
+
+ = "TMT"
+
+
+
+ TND
+
+ = "TND"
+
+
+
+ TOP
+
+ = "TOP"
+
+
+
+ TRY
+
+ = "TRY"
+
+
+
+ TTD
+
+ = "TTD"
+
+
+
+ TWD
+
+ = "TWD"
+
+
+
+ TZS
+
+ = "TZS"
+
+
+
+ UAH
+
+ = "UAH"
+
+
+
+ UGX
+
+ = "UGX"
+
+
+
+ USD
+
+ = "USD"
+
+
+
+ USDC
+
+ = "USDC"
+
+
+
+ USN
+
+ = "USN"
+
+
+
+ UYI
+
+ = "UYI"
+
+
+
+ UYU
+
+ = "UYU"
+
+
+
+ UZS
+
+ = "UZS"
+
+
+
+ VEF
+
+ = "VEF"
+
+
+
+ VND
+
+ = "VND"
+
+
+
+ VUV
+
+ = "VUV"
+
+
+
+ WST
+
+ = "WST"
+
+
+
+ XAF
+
+ = "XAF"
+
+
+
+ XCD
+
+ = "XCD"
+
+
+
+ XDR
+
+ = "XDR"
+
+
+
+ XOF
+
+ = "XOF"
+
+
+
+ XPF
+
+ = "XPF"
+
+
+
+ XRP
+
+ = "XRP"
+
+
+
+ XSU
+
+ = "XSU"
+
+
+
+ XUA
+
+ = "XUA"
+
+
+
+ YER
+
+ = "YER"
+
+
+
+ ZAR
+
+ = "ZAR"
+
+
+
+ ZMW
+
+ = "ZMW"
+
+
+
+ ZWL
+
+ = "ZWL"
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $alts
+
+ : string|null
+
+
+
+ $code
+
+ : string|null
+
+
+
+ $currentlySettled
+
+ : bool|null
+
+
+
+ $decimals
+
+ : string|null
+
+
+
+ $minimum
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $payoutFields
+
+ : array<string|int, mixed>
+
+
+
+ $plural
+
+ : string|null
+
+
+
+ $precision
+
+ : int|null
+
+
+
+ $sanctioned
+
+ : bool|null
+
+
+
+ $settlementMinimum
+
+ : array<string|int, mixed>
+
+
+
+ $symbol
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAlts()
+
+ : string|null
+
+Gets alternative currency name(s)
+
+
+ getCode()
+
+ : string|null
+
+Get ISO 4217 3-character currency code
+
+
+ getCurrentlySettled()
+
+ : bool|null
+
+Gets currently settled value
+
+
+ getDecimals()
+
+ : string|null
+
+Gets decimal precision
+
+
+ getMinimum()
+
+ : string|null
+
+Gets minimum supported value when creating an invoice, bill or payout for instance
+
+
+ getName()
+
+ : string|null
+
+Gets currency name
+
+
+ getPayoutFields()
+
+ : array<string|int, mixed>
+
+Gets payout fields
+
+
+ getPlural()
+
+ : string|null
+
+Gets English plural form
+
+
+ getPrecision()
+
+ : int|null
+
+Number of decimal places
+
+
+ getSanctioned()
+
+ : bool|null
+
+Gets if the currency is linked to a sanctionned country
+
+
+ getSettlementMinimum()
+
+ : array<string|int, mixed>
+
+Gets settlement minimum
+
+
+ getSymbol()
+
+ : string|null
+
+Display symbol
+
+
+ isValid()
+
+ : bool
+
+Currency validation
+
+
+ setAlts()
+
+ : void
+
+Sets alternative currency name(s)
+
+
+ setCode()
+
+ : void
+
+Sets ISO 4217 3-character currency code
+
+
+ setCurrentlySettled()
+
+ : void
+
+Sets currently settled value
+
+
+ setDecimals()
+
+ : void
+
+Sets decimal precision
+
+
+ setMinimum()
+
+ : void
+
+Sets minimum supported value when creating an invoice, bill or payout for instance
+
+
+ setName()
+
+ : void
+
+Sets currency name
+
+
+ setPayoutFields()
+
+ : void
+
+Sets payout fields
+
+
+ setPlural()
+
+ : void
+
+Sets English plural form
+
+
+ setPrecision()
+
+ : void
+
+Sets number of decimal places
+
+
+ setSanctioned()
+
+ : void
+
+Sets if the currency is linked to a sanctionned country
+
+
+ setSettlementMinimum()
+
+ : void
+
+Sets settlement minimum
+
+
+ setSymbol()
+
+ : void
+
+Sets symbol
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets currency data as array
+
+
+
+
+
+
+
+
+
+
+
+ AED
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AED
+ = "AED"
+
+
+
+
+
+
+
+
+
+
+ AFN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AFN
+ = "AFN"
+
+
+
+
+
+
+
+
+
+
+ ALL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ALL
+ = "ALL"
+
+
+
+
+
+
+
+
+
+
+ AMD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AMD
+ = "AMD"
+
+
+
+
+
+
+
+
+
+
+ ANG
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ANG
+ = "ANG"
+
+
+
+
+
+
+
+
+
+
+ AOA
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AOA
+ = "AOA"
+
+
+
+
+
+
+
+
+
+
+ ARS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ARS
+ = "ARS"
+
+
+
+
+
+
+
+
+
+
+ AUD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AUD
+ = "AUD"
+
+
+
+
+
+
+
+
+
+
+ AWG
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AWG
+ = "AWG"
+
+
+
+
+
+
+
+
+
+
+ AZN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ AZN
+ = "AZN"
+
+
+
+
+
+
+
+
+
+
+ BAM
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BAM
+ = "BAM"
+
+
+
+
+
+
+
+
+
+
+ BBD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BBD
+ = "BBD"
+
+
+
+
+
+
+
+
+
+
+ BCH
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BCH
+ = "BCH"
+
+
+
+
+
+
+
+
+
+
+ BDT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BDT
+ = "BDT"
+
+
+
+
+
+
+
+
+
+
+ BGN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BGN
+ = "BGN"
+
+
+
+
+
+
+
+
+
+
+ BHD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BHD
+ = "BHD"
+
+
+
+
+
+
+
+
+
+
+ BIF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BIF
+ = "BIF"
+
+
+
+
+
+
+
+
+
+
+ BMD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BMD
+ = "BMD"
+
+
+
+
+
+
+
+
+
+
+ BND
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BND
+ = "BND"
+
+
+
+
+
+
+
+
+
+
+ BOB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BOB
+ = "BOB"
+
+
+
+
+
+
+
+
+
+
+ BOV
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BOV
+ = "BOV"
+
+
+
+
+
+
+
+
+
+
+ BRL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BRL
+ = "BRL"
+
+
+
+
+
+
+
+
+
+
+ BSD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BSD
+ = "BSD"
+
+
+
+
+
+
+
+
+
+
+ BTC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BTC
+ = "BTC"
+
+
+
+
+
+
+
+
+
+
+ BTN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BTN
+ = "BTN"
+
+
+
+
+
+
+
+
+
+
+ BUSD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BUSD
+ = "BUSD"
+
+
+
+
+
+
+
+
+
+
+ BWP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BWP
+ = "BWP"
+
+
+
+
+
+
+
+
+
+
+ BYR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BYR
+ = "BYR"
+
+
+
+
+
+
+
+
+
+
+ BZD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ BZD
+ = "BZD"
+
+
+
+
+
+
+
+
+
+
+ CAD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CAD
+ = "CAD"
+
+
+
+
+
+
+
+
+
+
+ CDF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CDF
+ = "CDF"
+
+
+
+
+
+
+
+
+
+
+ CHE
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CHE
+ = "CHE"
+
+
+
+
+
+
+
+
+
+
+ CHF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CHF
+ = "CHF"
+
+
+
+
+
+
+
+
+
+
+ CHW
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CHW
+ = "CHW"
+
+
+
+
+
+
+
+
+
+
+ CLF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CLF
+ = "CLF"
+
+
+
+
+
+
+
+
+
+
+ CLP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CLP
+ = "CLP"
+
+
+
+
+
+
+
+
+
+
+ CNY
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CNY
+ = "CNY"
+
+
+
+
+
+
+
+
+
+
+ COP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ COP
+ = "COP"
+
+
+
+
+
+
+
+
+
+
+ COU
+
+
+
+
+
+
+
+
+ public
+ mixed
+ COU
+ = "COU"
+
+
+
+
+
+
+
+
+
+
+ CRC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CRC
+ = "CRC"
+
+
+
+
+
+
+
+
+
+
+ CUC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CUC
+ = "CUC"
+
+
+
+
+
+
+
+
+
+
+ CUP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CUP
+ = "CUP"
+
+
+
+
+
+
+
+
+
+
+ CVE
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CVE
+ = "CVE"
+
+
+
+
+
+
+
+
+
+
+ CZK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ CZK
+ = "CZK"
+
+
+
+
+
+
+
+
+
+
+ DJF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DJF
+ = "DJF"
+
+
+
+
+
+
+
+
+
+
+ DKK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DKK
+ = "DKK"
+
+
+
+
+
+
+
+
+
+
+ DOGE
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DOGE
+ = "DOGE"
+
+
+
+
+
+
+
+
+
+
+ DOP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DOP
+ = "DOP"
+
+
+
+
+
+
+
+
+
+
+ DZD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ DZD
+ = "DZD"
+
+
+
+
+
+
+
+
+
+
+ EGP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ EGP
+ = "EGP"
+
+
+
+
+
+
+
+
+
+
+ ERN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ERN
+ = "ERN"
+
+
+
+
+
+
+
+
+
+
+ ETB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ETB
+ = "ETB"
+
+
+
+
+
+
+
+
+
+
+ ETH
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ETH
+ = "ETH"
+
+
+
+
+
+
+
+
+
+
+ EUR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ EUR
+ = "EUR"
+
+
+
+
+
+
+
+
+
+
+ FJD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ FJD
+ = "FJD"
+
+
+
+
+
+
+
+
+
+
+ FKP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ FKP
+ = "FKP"
+
+
+
+
+
+
+
+
+
+
+ GBP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GBP
+ = "GBP"
+
+
+
+
+
+
+
+
+
+
+ GEL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GEL
+ = "GEL"
+
+
+
+
+
+
+
+
+
+
+ GHS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GHS
+ = "GHS"
+
+
+
+
+
+
+
+
+
+
+ GIP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GIP
+ = "GIP"
+
+
+
+
+
+
+
+
+
+
+ GMD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GMD
+ = "GMD"
+
+
+
+
+
+
+
+
+
+
+ GNF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GNF
+ = "GNF"
+
+
+
+
+
+
+
+
+
+
+ GTQ
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GTQ
+ = "GTQ"
+
+
+
+
+
+
+
+
+
+
+ GUSD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GUSD
+ = "GUSD"
+
+
+
+
+
+
+
+
+
+
+ GYD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ GYD
+ = "GYD"
+
+
+
+
+
+
+
+
+
+
+ HKD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ HKD
+ = "HKD"
+
+
+
+
+
+
+
+
+
+
+ HNL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ HNL
+ = "HNL"
+
+
+
+
+
+
+
+
+
+
+ HRK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ HRK
+ = "HRK"
+
+
+
+
+
+
+
+
+
+
+ HTG
+
+
+
+
+
+
+
+
+ public
+ mixed
+ HTG
+ = "HTG"
+
+
+
+
+
+
+
+
+
+
+ HUF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ HUF
+ = "HUF"
+
+
+
+
+
+
+
+
+
+
+ IDR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ IDR
+ = "IDR"
+
+
+
+
+
+
+
+
+
+
+ ILS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ILS
+ = "ILS"
+
+
+
+
+
+
+
+
+
+
+ INR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ INR
+ = "INR"
+
+
+
+
+
+
+
+
+
+
+ IQD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ IQD
+ = "IQD"
+
+
+
+
+
+
+
+
+
+
+ IRR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ IRR
+ = "IRR"
+
+
+
+
+
+
+
+
+
+
+ ISK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ISK
+ = "ISK"
+
+
+
+
+
+
+
+
+
+
+ JMD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ JMD
+ = "JMD"
+
+
+
+
+
+
+
+
+
+
+ JOD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ JOD
+ = "JOD"
+
+
+
+
+
+
+
+
+
+
+ JPY
+
+
+
+
+
+
+
+
+ public
+ mixed
+ JPY
+ = "JPY"
+
+
+
+
+
+
+
+
+
+
+ KES
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KES
+ = "KES"
+
+
+
+
+
+
+
+
+
+
+ KGS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KGS
+ = "KGS"
+
+
+
+
+
+
+
+
+
+
+ KHR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KHR
+ = "KHR"
+
+
+
+
+
+
+
+
+
+
+ KMF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KMF
+ = "KMF"
+
+
+
+
+
+
+
+
+
+
+ KPW
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KPW
+ = "KPW"
+
+
+
+
+
+
+
+
+
+
+ KRW
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KRW
+ = "KRW"
+
+
+
+
+
+
+
+
+
+
+ KWD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KWD
+ = "KWD"
+
+
+
+
+
+
+
+
+
+
+ KYD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KYD
+ = "KYD"
+
+
+
+
+
+
+
+
+
+
+ KZT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ KZT
+ = "KZT"
+
+
+
+
+
+
+
+
+
+
+ LAK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LAK
+ = "LAK"
+
+
+
+
+
+
+
+
+
+
+ LBP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LBP
+ = "LBP"
+
+
+
+
+
+
+
+
+
+
+ LKR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LKR
+ = "LKR"
+
+
+
+
+
+
+
+
+
+
+ LRD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LRD
+ = "LRD"
+
+
+
+
+
+
+
+
+
+
+ LSL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LSL
+ = "LSL"
+
+
+
+
+
+
+
+
+
+
+ LTC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LTC
+ = "LTC"
+
+
+
+
+
+
+
+
+
+
+ LYD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ LYD
+ = "LYD"
+
+
+
+
+
+
+
+
+
+
+ MAD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MAD
+ = "MAD"
+
+
+
+
+
+
+
+
+
+
+ MDL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MDL
+ = "MDL"
+
+
+
+
+
+
+
+
+
+
+ MGA
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MGA
+ = "MGA"
+
+
+
+
+
+
+
+
+
+
+ MKD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MKD
+ = "MKD"
+
+
+
+
+
+
+
+
+
+
+ MMK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MMK
+ = "MMK"
+
+
+
+
+
+
+
+
+
+
+ MNT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MNT
+ = "MNT"
+
+
+
+
+
+
+
+
+
+
+ MOP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MOP
+ = "MOP"
+
+
+
+
+
+
+
+
+
+
+ MRU
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MRU
+ = "MRU"
+
+
+
+
+
+
+
+
+
+
+ MUR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MUR
+ = "MUR"
+
+
+
+
+
+
+
+
+
+
+ MVR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MVR
+ = "MVR"
+
+
+
+
+
+
+
+
+
+
+ MWK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MWK
+ = "MWK"
+
+
+
+
+
+
+
+
+
+
+ MXN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MXN
+ = "MXN"
+
+
+
+
+
+
+
+
+
+
+ MXV
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MXV
+ = "MXV"
+
+
+
+
+
+
+
+
+
+
+ MYR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MYR
+ = "MYR"
+
+
+
+
+
+
+
+
+
+
+ MZN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ MZN
+ = "MZN"
+
+
+
+
+
+
+
+
+
+
+ NAD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NAD
+ = "NAD"
+
+
+
+
+
+
+
+
+
+
+ NGN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NGN
+ = "NGN"
+
+
+
+
+
+
+
+
+
+
+ NIO
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NIO
+ = "NIO"
+
+
+
+
+
+
+
+
+
+
+ NOK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NOK
+ = "NOK"
+
+
+
+
+
+
+
+
+
+
+ NPR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NPR
+ = "NPR"
+
+
+
+
+
+
+
+
+
+
+ NZD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ NZD
+ = "NZD"
+
+
+
+
+
+
+
+
+
+
+ OMR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ OMR
+ = "OMR"
+
+
+
+
+
+
+
+
+
+
+ PAB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PAB
+ = "PAB"
+
+
+
+
+
+
+
+
+
+
+ PAX
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PAX
+ = "PAX"
+
+
+
+
+
+
+
+
+
+
+ PEN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PEN
+ = "PEN"
+
+
+
+
+
+
+
+
+
+
+ PGK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PGK
+ = "PGK"
+
+
+
+
+
+
+
+
+
+
+ PHP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PHP
+ = "PHP"
+
+
+
+
+
+
+
+
+
+
+ PKR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PKR
+ = "PKR"
+
+
+
+
+
+
+
+
+
+
+ PLN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PLN
+ = "PLN"
+
+
+
+
+
+
+
+
+
+
+ PYG
+
+
+
+
+
+
+
+
+ public
+ mixed
+ PYG
+ = "PYG"
+
+
+
+
+
+
+
+
+
+
+ QAR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ QAR
+ = "QAR"
+
+
+
+
+
+
+
+
+
+
+ RON
+
+
+
+
+
+
+
+
+ public
+ mixed
+ RON
+ = "RON"
+
+
+
+
+
+
+
+
+
+
+ RSD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ RSD
+ = "RSD"
+
+
+
+
+
+
+
+
+
+
+ RUB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ RUB
+ = "RUB"
+
+
+
+
+
+
+
+
+
+
+ RWF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ RWF
+ = "RWF"
+
+
+
+
+
+
+
+
+
+
+ SAR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SAR
+ = "SAR"
+
+
+
+
+
+
+
+
+
+
+ SBD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SBD
+ = "SBD"
+
+
+
+
+
+
+
+
+
+
+ SCR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SCR
+ = "SCR"
+
+
+
+
+
+
+
+
+
+
+ SDG
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SDG
+ = "SDG"
+
+
+
+
+
+
+
+
+
+
+ SEK
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SEK
+ = "SEK"
+
+
+
+
+
+
+
+
+
+
+ SGD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SGD
+ = "SGD"
+
+
+
+
+
+
+
+
+
+
+ SHIB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SHIB
+ = "SHIB"
+
+
+
+
+
+
+
+
+
+
+ SHP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SHP
+ = "SHP"
+
+
+
+
+
+
+
+
+
+
+ SLL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SLL
+ = "SLL"
+
+
+
+
+
+
+
+
+
+
+ SOS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SOS
+ = "SOS"
+
+
+
+
+
+
+
+
+
+
+ SRD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SRD
+ = "SRD"
+
+
+
+
+
+
+
+
+
+
+ SSP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SSP
+ = "SSP"
+
+
+
+
+
+
+
+
+
+
+ STN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ STN
+ = "STN"
+
+
+
+
+
+
+
+
+
+
+ SVC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SVC
+ = "SVC"
+
+
+
+
+
+
+
+
+
+
+ SYP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SYP
+ = "SYP"
+
+
+
+
+
+
+
+
+
+
+ SZL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ SZL
+ = "SZL"
+
+
+
+
+
+
+
+
+
+
+ THB
+
+
+
+
+
+
+
+
+ public
+ mixed
+ THB
+ = "THB"
+
+
+
+
+
+
+
+
+
+
+ TJS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TJS
+ = "TJS"
+
+
+
+
+
+
+
+
+
+
+ TMT
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TMT
+ = "TMT"
+
+
+
+
+
+
+
+
+
+
+ TND
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TND
+ = "TND"
+
+
+
+
+
+
+
+
+
+
+ TOP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TOP
+ = "TOP"
+
+
+
+
+
+
+
+
+
+
+ TRY
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TRY
+ = "TRY"
+
+
+
+
+
+
+
+
+
+
+ TTD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TTD
+ = "TTD"
+
+
+
+
+
+
+
+
+
+
+ TWD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TWD
+ = "TWD"
+
+
+
+
+
+
+
+
+
+
+ TZS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ TZS
+ = "TZS"
+
+
+
+
+
+
+
+
+
+
+ UAH
+
+
+
+
+
+
+
+
+ public
+ mixed
+ UAH
+ = "UAH"
+
+
+
+
+
+
+
+
+
+
+ UGX
+
+
+
+
+
+
+
+
+ public
+ mixed
+ UGX
+ = "UGX"
+
+
+
+
+
+
+
+
+
+
+ USD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ USD
+ = "USD"
+
+
+
+
+
+
+
+
+
+
+ USDC
+
+
+
+
+
+
+
+
+ public
+ mixed
+ USDC
+ = "USDC"
+
+
+
+
+
+
+
+
+
+
+ USN
+
+
+
+
+
+
+
+
+ public
+ mixed
+ USN
+ = "USN"
+
+
+
+
+
+
+
+
+
+
+ UYI
+
+
+
+
+
+
+
+
+ public
+ mixed
+ UYI
+ = "UYI"
+
+
+
+
+
+
+
+
+
+
+ UYU
+
+
+
+
+
+
+
+
+ public
+ mixed
+ UYU
+ = "UYU"
+
+
+
+
+
+
+
+
+
+
+ UZS
+
+
+
+
+
+
+
+
+ public
+ mixed
+ UZS
+ = "UZS"
+
+
+
+
+
+
+
+
+
+
+ VEF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ VEF
+ = "VEF"
+
+
+
+
+
+
+
+
+
+
+ VND
+
+
+
+
+
+
+
+
+ public
+ mixed
+ VND
+ = "VND"
+
+
+
+
+
+
+
+
+
+
+ VUV
+
+
+
+
+
+
+
+
+ public
+ mixed
+ VUV
+ = "VUV"
+
+
+
+
+
+
+
+
+
+
+ WST
+
+
+
+
+
+
+
+
+ public
+ mixed
+ WST
+ = "WST"
+
+
+
+
+
+
+
+
+
+
+ XAF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XAF
+ = "XAF"
+
+
+
+
+
+
+
+
+
+
+ XCD
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XCD
+ = "XCD"
+
+
+
+
+
+
+
+
+
+
+ XDR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XDR
+ = "XDR"
+
+
+
+
+
+
+
+
+
+
+ XOF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XOF
+ = "XOF"
+
+
+
+
+
+
+
+
+
+
+ XPF
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XPF
+ = "XPF"
+
+
+
+
+
+
+
+
+
+
+ XRP
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XRP
+ = "XRP"
+
+
+
+
+
+
+
+
+
+
+ XSU
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XSU
+ = "XSU"
+
+
+
+
+
+
+
+
+
+
+ XUA
+
+
+
+
+
+
+
+
+ public
+ mixed
+ XUA
+ = "XUA"
+
+
+
+
+
+
+
+
+
+
+ YER
+
+
+
+
+
+
+
+
+ public
+ mixed
+ YER
+ = "YER"
+
+
+
+
+
+
+
+
+
+
+ ZAR
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ZAR
+ = "ZAR"
+
+
+
+
+
+
+
+
+
+
+ ZMW
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ZMW
+ = "ZMW"
+
+
+
+
+
+
+
+
+
+
+ ZWL
+
+
+
+
+
+
+
+
+ public
+ mixed
+ ZWL
+ = "ZWL"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $alts
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $alts
+ = null
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $currentlySettled
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $currentlySettled
+ = null
+
+
+
+
+
+
+
+
+ $decimals
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $decimals
+ = null
+
+
+
+
+
+
+
+
+ $minimum
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $minimum
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $payoutFields
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $payoutFields
+ = []
+
+
+
+
+
+
+
+
+ $plural
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $plural
+ = null
+
+
+
+
+
+
+
+
+ $precision
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $precision
+ = null
+
+
+
+
+
+
+
+
+ $sanctioned
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $sanctioned
+ = null
+
+
+
+
+
+
+
+
+ $settlementMinimum
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $settlementMinimum
+ = []
+
+
+
+
+
+
+
+
+ $symbol
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $symbol
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAlts()
+
+
+
+
+
+ Gets alternative currency name(s)
+
+
+ public
+ getAlts ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Get ISO 4217 3-character currency code
+
+
+ public
+ getCode ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrentlySettled()
+
+
+
+
+
+ Gets currently settled value
+
+
+ public
+ getCurrentlySettled ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getDecimals()
+
+
+
+
+
+ Gets decimal precision
+
+
+ public
+ getDecimals ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getMinimum()
+
+
+
+
+
+ Gets minimum supported value when creating an invoice, bill or payout for instance
+
+
+ public
+ getMinimum ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets currency name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPayoutFields()
+
+
+
+
+
+ Gets payout fields
+
+
+ public
+ getPayoutFields ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+ getPlural()
+
+
+
+
+
+ Gets English plural form
+
+
+ public
+ getPlural ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPrecision()
+
+
+
+
+
+ Number of decimal places
+
+
+ public
+ getPrecision ( ) : int|null
+
+
+
+
+
+
+
+
+ Return values
+ int|null
+ —
+
+
+
+
+
+
+
+ getSanctioned()
+
+
+
+
+
+ Gets if the currency is linked to a sanctionned country
+
+
+ public
+ getSanctioned ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getSettlementMinimum()
+
+
+
+
+
+ Gets settlement minimum
+
+
+ public
+ getSettlementMinimum ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+ getSymbol()
+
+
+
+
+
+ Display symbol
+
+
+ public
+ getSymbol ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ isValid()
+
+
+
+
+
+ Currency validation
+
+
+ public
+ static isValid ( string $value ) : bool
+
+
+
+
+ Parameters
+
+
+ $value
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setAlts()
+
+
+
+
+
+ Sets alternative currency name(s)
+
+
+ public
+ setAlts ( string $alts ) : void
+
+
+
+
+ Parameters
+
+
+ $alts
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets ISO 4217 3-character currency code
+
+
+ public
+ setCode ( string $code ) : void
+
+
+
+
+ Parameters
+
+
+ $code
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrentlySettled()
+
+
+
+
+
+ Sets currently settled value
+
+
+ public
+ setCurrentlySettled ( bool $currentlySettled ) : void
+
+
+
+
+ Parameters
+
+
+ $currentlySettled
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setDecimals()
+
+
+
+
+
+ Sets decimal precision
+
+
+ public
+ setDecimals ( string $decimals ) : void
+
+
+
+
+ Parameters
+
+
+ $decimals
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setMinimum()
+
+
+
+
+
+ Sets minimum supported value when creating an invoice, bill or payout for instance
+
+
+ public
+ setMinimum ( string $minimum ) : void
+
+
+
+
+ Parameters
+
+
+ $minimum
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets currency name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayoutFields()
+
+
+
+
+
+ Sets payout fields
+
+
+ public
+ setPayoutFields ( array<string|int, mixed> $payoutFields ) : void
+
+
+
+
+ Parameters
+
+
+ $payoutFields
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPlural()
+
+
+
+
+
+ Sets English plural form
+
+
+ public
+ setPlural ( string $plural ) : void
+
+
+
+
+ Parameters
+
+
+ $plural
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPrecision()
+
+
+
+
+
+ Sets number of decimal places
+
+
+ public
+ setPrecision ( int $precision ) : void
+
+
+
+
+ Parameters
+
+
+ $precision
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSanctioned()
+
+
+
+
+
+ Sets if the currency is linked to a sanctionned country
+
+
+ public
+ setSanctioned ( bool $sanctioned ) : void
+
+
+
+
+ Parameters
+
+
+ $sanctioned
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSettlementMinimum()
+
+
+
+
+
+ Sets settlement minimum
+
+
+ public
+ setSettlementMinimum ( array<string|int, mixed> $settlementMinimum ) : void
+
+
+
+
+ Parameters
+
+
+ $settlementMinimum
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSymbol()
+
+
+
+
+
+ Sets symbol
+
+
+ public
+ setSymbol ( [ string|null $symbol = null ] ) : void
+
+
+
+
+ Parameters
+
+
+ $symbol
+ : string|null
+ = null
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets currency data as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Facade.html b/docs/classes/BitPaySDK-Model-Facade.html
new file mode 100644
index 00000000..2dfc3e34
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Facade.html
@@ -0,0 +1,487 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Facade
+
+
+
+
+
+ Facades are named collections of capabilities that can be granted,
+such as the ability to create invoices or grant refunds.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/concepts#facades
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ MERCHANT
+
+ = "merchant"
+
+The broadest set of capabilities against a merchant organization. Allows for create, search,
+and view actions for Invoices and Bills; ledger download,
+as well as the creation of new merchant or pos tokens associated with the account.
+
+
+ PAYOUT
+
+ = "payout"
+
+This is the facade which allows merchant to access the Payouts related resources and corresponding endpoints.
+
+
+ POS
+
+ = "pos"
+
+Limited to creating new invoice or bills and search specific invoices
+or bills based on their id for the merchant's organization
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MERCHANT
+
+
+
+
+
+
+ The broadest set of capabilities against a merchant organization. Allows for create, search,
+and view actions for Invoices and Bills; ledger download,
+as well as the creation of new merchant or pos tokens associated with the account.
+
+
+ public
+ mixed
+ MERCHANT
+ = "merchant"
+
+
+
+
+
+
+
+
+
+
+ PAYOUT
+
+
+
+
+
+
+ This is the facade which allows merchant to access the Payouts related resources and corresponding endpoints.
+
+
+ public
+ mixed
+ PAYOUT
+ = "payout"
+
+
+
+ Access to this facade is not enabled by default.
+
+
+
+
+
+
+
+
+ POS
+
+
+
+
+
+
+ Limited to creating new invoice or bills and search specific invoices
+or bills based on their id for the merchant's organization
+
+
+ public
+ mixed
+ POS
+ = "pos"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-Buyer.html b/docs/classes/BitPaySDK-Model-Invoice-Buyer.html
new file mode 100644
index 00000000..851f6d5a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-Buyer.html
@@ -0,0 +1,1896 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows merchant to pass buyer related information in the invoice object
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $address1
+
+ : string|null
+
+
+
+ $address2
+
+ : string|null
+
+
+
+ $country
+
+ : string|null
+
+
+
+ $email
+
+ : string|null
+
+
+
+ $locality
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $notify
+
+ : bool|null
+
+
+
+ $phone
+
+ : string|null
+
+
+
+ $postalCode
+
+ : string|null
+
+
+
+ $region
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAddress1()
+
+ : string|null
+
+Gets Buyer's address
+
+
+ getAddress2()
+
+ : string|null
+
+Gets Buyer's appartment or suite number
+
+
+ getCountry()
+
+ : string|null
+
+Gets Buyer's Country code
+
+
+ getEmail()
+
+ : string|null
+
+Gets Buyer's email address.
+
+
+ getLocality()
+
+ : string|null
+
+Gets Buyer's city or locality
+
+
+ getName()
+
+ : string|null
+
+Gets Buyer's name
+
+
+ getNotify()
+
+ : bool|null
+
+Gets Buyer's notify
+
+
+ getPhone()
+
+ : string|null
+
+Gets Buyer's phone number
+
+
+ getPostalCode()
+
+ : string|null
+
+Gets Buyer's Zip or Postal Code
+
+
+ getRegion()
+
+ : string|null
+
+Buyer's state or province
+
+
+ setAddress1()
+
+ : void
+
+Sets Buyer's address
+
+
+ setAddress2()
+
+ : void
+
+Sets Buyer's appartment or suite number
+
+
+ setCountry()
+
+ : void
+
+Sets Buyer's Country code
+
+
+ setEmail()
+
+ : void
+
+Sets Buyer's email address
+
+
+ setLocality()
+
+ : void
+
+Sets Buyer's city or locality
+
+
+ setName()
+
+ : void
+
+Sets Buyer's name
+
+
+ setNotify()
+
+ : void
+
+Sets Buyer's notify
+
+
+ setPhone()
+
+ : void
+
+Sets Buyer's phone number
+
+
+ setPostalCode()
+
+ : void
+
+Sets Buyer's Zip or Postal Code
+
+
+ setRegion()
+
+ : void
+
+Sets Buyer's state or province
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Buyer as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $address1
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address1
+ = null
+
+
+
+
+
+
+
+
+ $address2
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address2
+ = null
+
+
+
+
+
+
+
+
+ $country
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $country
+ = null
+
+
+
+
+
+
+
+
+ $email
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $email
+ = null
+
+
+
+
+
+
+
+
+ $locality
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $locality
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $notify
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $notify
+ = null
+
+
+
+
+
+
+
+
+ $phone
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $phone
+ = null
+
+
+
+
+
+
+
+
+ $postalCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $postalCode
+ = null
+
+
+
+
+
+
+
+
+ $region
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $region
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAddress1()
+
+
+
+
+
+ Gets Buyer's address
+
+
+ public
+ getAddress1 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getAddress2()
+
+
+
+
+
+ Gets Buyer's appartment or suite number
+
+
+ public
+ getAddress2 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ Buyer's appartment or suite number
+
+
+
+
+
+
+
+ getCountry()
+
+
+
+
+
+ Gets Buyer's Country code
+
+
+ public
+ getCountry ( ) : string|null
+
+
+
+ Format ISO 3166-1 alpha-2
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getEmail()
+
+
+
+
+
+ Gets Buyer's email address.
+
+
+ public
+ getEmail ( ) : string|null
+
+
+
+ If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getLocality()
+
+
+
+
+
+ Gets Buyer's city or locality
+
+
+ public
+ getLocality ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ Buyer's city or locality
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets Buyer's name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getNotify()
+
+
+
+
+
+ Gets Buyer's notify
+
+
+ public
+ getNotify ( ) : bool|null
+
+
+
+ Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getPhone()
+
+
+
+
+
+ Gets Buyer's phone number
+
+
+ public
+ getPhone ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPostalCode()
+
+
+
+
+
+ Gets Buyer's Zip or Postal Code
+
+
+ public
+ getPostalCode ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ Buyer's Zip or Postal Code
+
+
+
+
+
+
+
+ getRegion()
+
+
+
+
+
+ Buyer's state or province
+
+
+ public
+ getRegion ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ Buyer's state or province
+
+
+
+
+
+
+
+ setAddress1()
+
+
+
+
+
+ Sets Buyer's address
+
+
+ public
+ setAddress1 ( string $address1 ) : void
+
+
+
+
+ Parameters
+
+
+ $address1
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setAddress2()
+
+
+
+
+
+ Sets Buyer's appartment or suite number
+
+
+ public
+ setAddress2 ( string $address2 ) : void
+
+
+
+
+ Parameters
+
+
+ $address2
+ : string
+
+
+ Buyer's appartment or suite number
+
+
+
+
+
+
+
+
+
+
+
+ setCountry()
+
+
+
+
+
+ Sets Buyer's Country code
+
+
+ public
+ setCountry ( string $country ) : void
+
+
+
+
+ Parameters
+
+
+ $country
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setEmail()
+
+
+
+
+
+ Sets Buyer's email address
+
+
+ public
+ setEmail ( string $email ) : void
+
+
+
+ If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+
+
+ Parameters
+
+
+ $email
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setLocality()
+
+
+
+
+
+ Sets Buyer's city or locality
+
+
+ public
+ setLocality ( string $locality ) : void
+
+
+
+
+ Parameters
+
+
+ $locality
+ : string
+
+
+ Buyer's city or locality
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets Buyer's name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotify()
+
+
+
+
+
+ Sets Buyer's notify
+
+
+ public
+ setNotify ( bool $notify ) : void
+
+
+
+ Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
+
+
+ Parameters
+
+
+ $notify
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPhone()
+
+
+
+
+
+ Sets Buyer's phone number
+
+
+ public
+ setPhone ( string $phone ) : void
+
+
+
+
+ Parameters
+
+
+ $phone
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPostalCode()
+
+
+
+
+
+ Sets Buyer's Zip or Postal Code
+
+
+ public
+ setPostalCode ( string $postalCode ) : void
+
+
+
+
+ Parameters
+
+
+ $postalCode
+ : string
+
+
+ Buyer's Zip or Postal Code
+
+
+
+
+
+
+
+
+
+
+
+ setRegion()
+
+
+
+
+
+ Sets Buyer's state or province
+
+
+ public
+ setRegion ( string $region ) : void
+
+
+
+
+ Parameters
+
+
+ $region
+ : string
+
+
+ Buyer's state or province
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Buyer as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html b/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html
new file mode 100644
index 00000000..f946553e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html
@@ -0,0 +1,1498 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerProvidedInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information collected from the buyer during the process of paying an invoice. Initially this object is empty.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $emailAddress
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $phoneNumber
+
+ : string|null
+
+
+
+ $selectedTransactionCurrency
+
+ : string|null
+
+
+
+ $selectedWallet
+
+ : string|null
+
+
+
+ $sms
+
+ : string|null
+
+
+
+ $smsVerified
+
+ : bool|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getEmailAddress()
+
+ : string|null
+
+Gets email address
+
+
+ getName()
+
+ : string|null
+
+Gets name
+
+
+ getPhoneNumber()
+
+ : string|null
+
+Gets phone number
+
+
+ getSelectedTransactionCurrency()
+
+ : string|null
+
+Gets selected transaction currency
+
+
+ getSelectedWallet()
+
+ : string|null
+
+Gets selected wallet
+
+
+ getSms()
+
+ : string|null
+
+Gets sms
+
+
+ getSmsVerified()
+
+ : bool|null
+
+Gets verification status of SMS (ie. have they passed the challenge).
+
+
+ setEmailAddress()
+
+ : void
+
+Sets email address
+
+
+ setName()
+
+ : void
+
+Sets name
+
+
+ setPhoneNumber()
+
+ : void
+
+Sets phone number
+
+
+ setSelectedTransactionCurrency()
+
+ : void
+
+Sets selected transaction currency
+
+
+ setSelectedWallet()
+
+ : void
+
+Sets selected wallet
+
+
+ setSms()
+
+ : void
+
+Sets sms
+
+
+ setSmsVerified()
+
+ : void
+
+Sets verification status of SMS (ie. have they passed the challenge).
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets BuyerProvidedInfo as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $emailAddress
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $emailAddress
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $phoneNumber
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $phoneNumber
+ = null
+
+
+
+
+
+
+
+
+ $selectedTransactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $selectedTransactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $selectedWallet
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $selectedWallet
+ = null
+
+
+
+
+
+
+
+
+ $sms
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $sms
+ = null
+
+
+
+
+
+
+
+
+ $smsVerified
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $smsVerified
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getEmailAddress()
+
+
+
+
+
+ Gets email address
+
+
+ public
+ getEmailAddress ( ) : string|null
+
+
+
+ Populated with the buyer's email address if passed in the buyer object,
+otherwise this field is not returned in the response.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+ Populated with the buyer's name address if passed in the buyer object by the merchant
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPhoneNumber()
+
+
+
+
+
+ Gets phone number
+
+
+ public
+ getPhoneNumber ( ) : string|null
+
+
+
+ Populated with the buyer's phone number if passed in the buyer object by the merchant
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSelectedTransactionCurrency()
+
+
+
+
+
+ Gets selected transaction currency
+
+
+ public
+ getSelectedTransactionCurrency ( ) : string|null
+
+
+
+ This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+If not yet selected, this field will not be returned.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the selected transaction currency
+
+
+
+
+
+
+
+ getSelectedWallet()
+
+
+
+
+
+ Gets selected wallet
+
+
+ public
+ getSelectedWallet ( ) : string|null
+
+
+
+ This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSms()
+
+
+
+
+
+ Gets sms
+
+
+ public
+ getSms ( ) : string|null
+
+
+
+ SMS provided by user for communications. This is only used for instances where a buyers email
+(primary form of buyer communication) is can not be gathered.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSmsVerified()
+
+
+
+
+
+ Gets verification status of SMS (ie. have they passed the challenge).
+
+
+ public
+ getSmsVerified ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ setEmailAddress()
+
+
+
+
+
+ Sets email address
+
+
+ public
+ setEmailAddress ( string $emailAddress ) : void
+
+
+
+ Populated with the buyer's email address if passed in the buyer object,
+otherwise this field is not returned in the response.
+
+
+ Parameters
+
+
+ $emailAddress
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+ Populated with the buyer's name address if passed in the buyer object by the merchant
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPhoneNumber()
+
+
+
+
+
+ Sets phone number
+
+
+ public
+ setPhoneNumber ( string $phoneNumber ) : void
+
+
+
+ Populated with the buyer's phone number if passed in the buyer object by the merchant
+
+
+ Parameters
+
+
+ $phoneNumber
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSelectedTransactionCurrency()
+
+
+
+
+
+ Sets selected transaction currency
+
+
+ public
+ setSelectedTransactionCurrency ( string $selectedTransactionCurrency ) : void
+
+
+
+ This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+If not yet selected, this field will not be returned.
+
+
+ Parameters
+
+
+ $selectedTransactionCurrency
+ : string
+
+
+ the selected transaction currency
+
+
+
+
+
+
+
+
+
+
+
+ setSelectedWallet()
+
+
+
+
+
+ Sets selected wallet
+
+
+ public
+ setSelectedWallet ( string|null $selectedWallet ) : void
+
+
+
+ This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.
+
+
+ Parameters
+
+
+ $selectedWallet
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSms()
+
+
+
+
+
+ Sets sms
+
+
+ public
+ setSms ( string $sms ) : void
+
+
+
+ SMS provided by user for communications. This is only used for instances where a buyers email
+(primary form of buyer communication) is can not be gathered.
+
+
+ Parameters
+
+
+ $sms
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSmsVerified()
+
+
+
+
+
+ Sets verification status of SMS (ie. have they passed the challenge).
+
+
+ public
+ setSmsVerified ( bool $smsVerified ) : void
+
+
+
+
+ Parameters
+
+
+ $smsVerified
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets BuyerProvidedInfo as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ BuyerProvidedInfo as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-Invoice.html b/docs/classes/BitPaySDK-Model-Invoice-Invoice.html
new file mode 100644
index 00000000..1472e4de
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-Invoice.html
@@ -0,0 +1,9653 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $acceptanceWindow
+
+ : float|null
+
+
+
+ $amountPaid
+
+ : int|null
+
+
+
+ $autoRedirect
+
+ : bool
+
+
+
+ $billId
+
+ : string|null
+
+
+
+ $bitpayIdRequired
+
+ : bool|null
+
+
+
+ $buyer
+
+ : Buyer |null
+
+
+
+ $buyerEmail
+
+ : string|null
+
+
+
+ $buyerProvidedEmail
+
+ : string|null
+
+
+
+ $buyerProvidedInfo
+
+ : BuyerProvidedInfo |null
+
+
+
+ $buyerSms
+
+ : string|null
+
+
+
+ $closeURL
+
+ : string|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $currentTime
+
+ : string|null
+
+
+
+ $displayAmountPaid
+
+ : string|null
+
+
+
+ $exceptionStatus
+
+ : bool|null
+
+
+
+ $exchangeRates
+
+ : array<string|int, mixed>|null
+
+
+
+ $expirationTime
+
+ : string|null
+
+
+
+ $extendedNotifications
+
+ : bool
+
+
+
+ $forcedBuyerSelectedTransactionCurrency
+
+ : string|null
+
+
+
+ $forcedBuyerSelectedWallet
+
+ : string|null
+
+
+
+ $fullNotifications
+
+ : bool
+
+
+
+ $guid
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $invoiceTime
+
+ : int|null
+
+
+
+ $isCancelled
+
+ : bool|null
+
+
+
+ $itemCode
+
+ : string|null
+
+
+
+ $itemDesc
+
+ : string|null
+
+
+
+ $itemizedDetails
+
+ : array<string|int, ItemizedDetails >
+
+
+
+ $jsonPayProRequired
+
+ : bool|null
+
+
+
+ $lowFeeDetected
+
+ : bool|null
+
+
+
+ $merchantName
+
+ : string|null
+
+
+
+ $minerFees
+
+ : MinerFees |null
+
+
+
+ $nonPayProPaymentReceived
+
+ : bool|null
+
+
+
+ $notificationEmail
+
+ : string|null
+
+
+
+ $notificationURL
+
+ : string|null
+
+
+
+ $orderId
+
+ : string|null
+
+
+
+ $overpaidAmount
+
+ : int|null
+
+
+
+ $paymentCodes
+
+ : array<string|int, mixed>|null
+
+
+
+ $paymentCurrencies
+
+ : array<string|int, mixed>|null
+
+
+
+ $paymentDisplaySubTotals
+
+ : array<string|int, mixed>|null
+
+
+
+ $paymentDisplayTotals
+
+ : array<string|int, mixed>|null
+
+
+
+ $paymentSubtotals
+
+ : array<string|int, mixed>|null
+
+
+
+ $paymentTotals
+
+ : array<string|int, mixed>|null
+
+
+
+ $physical
+
+ : bool
+
+
+
+ $posData
+
+ : string|null
+
+
+
+ $price
+
+ : float|null
+
+
+
+ $redirectURL
+
+ : string|null
+
+
+
+ $refundAddresses
+
+ : array<string|int, mixed>|null
+
+
+
+ $refundAddressRequestPending
+
+ : bool|null
+
+
+
+ $refundInfo
+
+ : RefundInfo |null
+
+
+
+ $selectedTransactionCurrency
+
+ : string|null
+
+
+
+ $shopper
+
+ : Shopper |null
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $supportedTransactionCurrencies
+
+ : SupportedTransactionCurrencies |null
+
+
+
+ $targetConfirmations
+
+ : int|null
+
+
+
+ $token
+
+ : string|null
+
+
+
+ $transactionCurrency
+
+ : string|null
+
+
+
+ $transactions
+
+ : array<string|int, mixed>|null
+
+
+
+ $transactionSpeed
+
+ : string|null
+
+
+
+ $underpaidAmount
+
+ : int|null
+
+
+
+ $universalCodes
+
+ : UniversalCodes |null
+
+
+
+ $url
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create a minimal request Invoice object.
+
+
+ getAcceptanceWindow()
+
+ : float|null
+
+Gets acceptanceWindow
+
+
+ getAmountPaid()
+
+ : int|null
+
+Gets amountPaid
+
+
+ getAutoRedirect()
+
+ : bool|null
+
+Gets autoRedirect
+
+
+ getBillId()
+
+ : string|null
+
+Gets billId
+
+
+ getBitpayIdRequired()
+
+ : bool|null
+
+Gets bitpayIdRequired
+
+
+ getBuyer()
+
+ : Buyer |null
+
+Gets buyer
+
+
+ getBuyerEmail()
+
+ : string|null
+
+Gets buyerEmail
+
+
+ getBuyerProvidedEmail()
+
+ : string|null
+
+Gets buyerProvidedEmail
+
+
+ getBuyerProvidedInfo()
+
+ : BuyerProvidedInfo |null
+
+Gets buyerProvidedEmail
+
+
+ getBuyerSms()
+
+ : string|null
+
+Gets buyerSms
+
+
+ getCloseURL()
+
+ : string|null
+
+Gets closeURL
+
+
+ getCurrency()
+
+ : string|null
+
+Gets currency
+
+
+ getCurrentTime()
+
+ : string|null
+
+Gets currentTime - UNIX time of API call, in milliseconds
+
+
+ getDisplayAmountPaid()
+
+ : string|null
+
+Gets displayAmountPaid
+
+
+ getExceptionStatus()
+
+ : bool|null
+
+Gets exceptionStatus
+
+
+ getExchangeRates()
+
+ : array<string|int, mixed>|null
+
+Gets exchangeRates
+
+
+ getExpirationTime()
+
+ : string|null
+
+Gets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+
+
+ getExtendedNotifications()
+
+ : bool|null
+
+Gets extendedNotifications
+
+
+ getForcedBuyerSelectedTransactionCurrency()
+
+ : string|null
+
+Gets forcedBuyerSelectedWallet
+
+
+ getForcedBuyerSelectedWallet()
+
+ : string|null
+
+Gets forcedBuyerSelectedWallet
+
+
+ getFullNotifications()
+
+ : bool|null
+
+Gets fullNotifications
+
+
+ getGuid()
+
+ : string|null
+
+Gets guid
+
+
+ getId()
+
+ : string|null
+
+Gets invoice resource id
+
+
+ getInvoiceTime()
+
+ : int|null
+
+Gets invoiceTime - UNIX time of invoice creation, in milliseconds
+
+
+ getIsCancelled()
+
+ : bool|null
+
+Gets isCancelled
+
+
+ getItemCode()
+
+ : string|null
+
+Gets itemCode
+
+
+ getItemDesc()
+
+ : string|null
+
+Gets itemDesc
+
+
+ getItemizedDetails()
+
+ : array<string|int, ItemizedDetails >
+
+Gets itemizedDetails
+
+
+ getJsonPayProRequired()
+
+ : bool|null
+
+Gets jsonPayProRequired
+
+
+ getLowFeeDetected()
+
+ : bool|null
+
+Gets lowFeeDetected
+
+
+ getMerchantName()
+
+ : string|null
+
+Gets merchantName
+
+
+ getMinerFees()
+
+ : MinerFees |null
+
+Gets minerFees
+
+
+ getNonPayProPaymentReceived()
+
+ : bool|null
+
+Gets nonPayProPaymentReceived
+
+
+ getNotificationEmail()
+
+ : string|null
+
+Gets NotificationEmail
+
+
+ getNotificationURL()
+
+ : string|null
+
+Gets notificationURL
+
+
+ getOrderId()
+
+ : string|null
+
+Gets orderId
+
+
+ getOverpaidAmount()
+
+ : int|null
+
+Gets overpaidAmount
+
+
+ getPaymentCodes()
+
+ : array<string|int, mixed>|null
+
+Gets paymentCodes
+
+
+ getPaymentCurrencies()
+
+ : array<string|int, mixed>|null
+
+Gets paymentCurrencies
+
+
+ getPaymentDisplaySubTotals()
+
+ : array<string|int, mixed>|null
+
+Gets paymentDisplaySubtotals
+
+
+ getPaymentDisplayTotals()
+
+ : array<string|int, mixed>|null
+
+Gets paymentDisplayTotals
+
+
+ getPaymentSubtotals()
+
+ : array<string|int, mixed>|null
+
+Gets paymentSubtotals
+
+
+ getPaymentTotals()
+
+ : array<string|int, mixed>|null
+
+Gets paymentTotals
+
+
+ getPhysical()
+
+ : bool|null
+
+Gets physical.
+
+
+ getPosData()
+
+ : string|null
+
+Gets posData
+
+
+ getPrice()
+
+ : float|null
+
+Gets price
+
+
+ getRedirectURL()
+
+ : string|null
+
+Gets RedirectURL
+
+
+ getRefundAddresses()
+
+ : array<string|int, mixed>|null
+
+Gets refundAddresses
+
+
+ getRefundAddressRequestPending()
+
+ : bool|null
+
+Gets refundAddressRequestPending
+
+
+ getRefundInfo()
+
+ : RefundInfo |null
+
+Gets refundInfo
+
+
+ getSelectedTransactionCurrency()
+
+ : string|null
+
+Gets selectedTransactionCurrency
+
+
+ getShopper()
+
+ : Shopper |null
+
+Gets shopper
+
+
+ getStatus()
+
+ : string|null
+
+Gets status
+
+
+ getSupportedTransactionCurrencies()
+
+ : SupportedTransactionCurrencies |null
+
+Gets supportedTransactionCurrencies
+
+
+ getTargetConfirmations()
+
+ : int|null
+
+Gets targetConfirmations
+
+
+ getToken()
+
+ : string|null
+
+Gets token
+
+
+ getTransactionCurrency()
+
+ : string|null
+
+Gets transactionCurrency
+
+
+ getTransactions()
+
+ : array<string|int, mixed>|null
+
+Gets transactions
+
+
+ getTransactionSpeed()
+
+ : string|null
+
+Gets transactionSpeed.
+
+
+ getUnderpaidAmount()
+
+ : int|null
+
+Gets underpaidAmount
+
+
+ getUniversalCodes()
+
+ : UniversalCodes |null
+
+Gets universalCodes
+
+
+ getUrl()
+
+ : string|null
+
+Gets url
+
+
+ setAcceptanceWindow()
+
+ : void
+
+Sets acceptanceWindow
+
+
+ setAmountPaid()
+
+ : void
+
+Sets amountPaid
+
+
+ setAutoRedirect()
+
+ : void
+
+Sets autoRedirect
+
+
+ setBillId()
+
+ : void
+
+Sets billId
+
+
+ setBitpayIdRequired()
+
+ : void
+
+Sets bitpayIdRequired
+
+
+ setBuyer()
+
+ : void
+
+Sets buyer
+
+
+ setBuyerEmail()
+
+ : void
+
+Sets buyerEmail
+
+
+ setBuyerProvidedEmail()
+
+ : void
+
+Sets buyerProvidedEmail
+
+
+ setBuyerProvidedInfo()
+
+ : mixed
+
+Sets buyerProvidedEmail
+
+
+ setBuyerSms()
+
+ : void
+
+Sets buyerSms
+
+
+ setCloseURL()
+
+ : void
+
+Gets closeURL
+
+
+ setCurrency()
+
+ : void
+
+Sets currency
+
+
+ setCurrentTime()
+
+ : void
+
+Sets currentTime - UNIX time of API call, in milliseconds
+
+
+ setDisplayAmountPaid()
+
+ : void
+
+Sets displayAmountPaid
+
+
+ setExceptionStatus()
+
+ : void
+
+Sets exceptionStatus
+
+
+ setExchangeRates()
+
+ : void
+
+Sets exchangeRates
+
+
+ setExpirationTime()
+
+ : void
+
+Sets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+
+
+ setExtendedNotifications()
+
+ : void
+
+Sets extendedNotifications
+
+
+ setForcedBuyerSelectedTransactionCurrency()
+
+ : mixed
+
+Sets forcedBuyerSelectedWallet
+
+
+ setForcedBuyerSelectedWallet()
+
+ : mixed
+
+Sets forcedBuyerSelectedWallet
+
+
+ setFullNotifications()
+
+ : void
+
+Sets fullNotifications
+
+
+ setGuid()
+
+ : void
+
+Sets guid
+
+
+ setId()
+
+ : void
+
+Sets invoice resource id
+
+
+ setInvoiceTime()
+
+ : mixed
+
+Sets invoiceTime - UNIX time of invoice creation, in milliseconds
+
+
+ setIsCancelled()
+
+ : void
+
+Sets isCancelled
+
+
+ setItemCode()
+
+ : void
+
+Sets itemCode
+
+
+ setItemDesc()
+
+ : void
+
+Sets itemDesc
+
+
+ setItemizedDetails()
+
+ : void
+
+Sets itemizedDetails
+
+
+ setJsonPayProRequired()
+
+ : void
+
+Sets jsonPayProRequired
+
+
+ setLowFeeDetected()
+
+ : mixed
+
+Sets lowFeeDetected
+
+
+ setMerchantName()
+
+ : void
+
+Sets merchantName
+
+
+ setMinerFees()
+
+ : void
+
+Sets minerFees
+
+
+ setNonPayProPaymentReceived()
+
+ : void
+
+Sets nonPayProPaymentReceived
+
+
+ setNotificationEmail()
+
+ : void
+
+Sets NotificationEmail
+
+
+ setNotificationURL()
+
+ : void
+
+Sets notificationURL
+
+
+ setOrderId()
+
+ : void
+
+Sets orderId
+
+
+ setOverpaidAmount()
+
+ : void
+
+Sets overpaidAmount
+
+
+ setPaymentCodes()
+
+ : mixed
+
+Sets paymentCodes
+
+
+ setPaymentCurrencies()
+
+ : void
+
+Sets paymentCurrencies
+
+
+ setPaymentDisplaySubTotals()
+
+ : mixed
+
+Sets paymentDisplaySubtotals
+
+
+ setPaymentDisplayTotals()
+
+ : mixed
+
+Sets paymentDisplayTotals
+
+
+ setPaymentSubtotals()
+
+ : mixed
+
+Sets paymentSubtotals
+
+
+ setPaymentTotals()
+
+ : mixed
+
+Sets paymentTotals
+
+
+ setPhysical()
+
+ : void
+
+Sets physical.
+
+
+ setPosData()
+
+ : void
+
+Sets posData
+
+
+ setPrice()
+
+ : void
+
+Sets price
+
+
+ setRedirectURL()
+
+ : void
+
+Sets RedirectURL
+
+
+ setRefundAddresses()
+
+ : void
+
+Sets refundAddresses
+
+
+ setRefundAddressRequestPending()
+
+ : void
+
+Sets refundAddressRequestPending
+
+
+ setRefundInfo()
+
+ : void
+
+Sets refundInfo
+
+
+ setSelectedTransactionCurrency()
+
+ : void
+
+Sets selectedTransactionCurrency
+
+
+ setShopper()
+
+ : mixed
+
+Sets shopper
+
+
+ setStatus()
+
+ : void
+
+Sets status
+
+
+ setSupportedTransactionCurrencies()
+
+ : void
+
+Sets supportedTransactionCurrencies
+
+
+ setTargetConfirmations()
+
+ : void
+
+Sets targetConfirmations
+
+
+ setToken()
+
+ : void
+
+Sets token
+
+
+ setTransactionCurrency()
+
+ : void
+
+Sets transactionCurrency
+
+
+ setTransactions()
+
+ : void
+
+Sets transactions
+
+
+ setTransactionSpeed()
+
+ : void
+
+Sets transactionSpeed.
+
+
+ setUnderpaidAmount()
+
+ : void
+
+Sets underpaidAmount
+
+
+ setUniversalCodes()
+
+ : mixed
+
+Sets universalCodes
+
+
+ setUrl()
+
+ : void
+
+Sets url
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Returns the Invoice object as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $acceptanceWindow
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $acceptanceWindow
+ = null
+
+
+
+
+
+
+
+
+ $amountPaid
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $amountPaid
+ = null
+
+
+
+
+
+
+
+
+ $autoRedirect
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $autoRedirect
+ = false
+
+
+
+
+
+
+
+
+ $billId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $billId
+ = null
+
+
+
+
+
+
+
+
+ $bitpayIdRequired
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $bitpayIdRequired
+ = null
+
+
+
+
+
+
+
+
+ $buyer
+
+
+
+
+
+
+
+
+
+ protected
+ Buyer |null
+ $buyer
+ = null
+
+
+
+
+
+
+
+
+ $buyerEmail
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $buyerEmail
+ = null
+
+
+
+
+
+
+
+
+ $buyerProvidedEmail
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $buyerProvidedEmail
+ = null
+
+
+
+
+
+
+
+
+ $buyerProvidedInfo
+
+
+
+
+
+
+
+
+
+ protected
+ BuyerProvidedInfo |null
+ $buyerProvidedInfo
+ = null
+
+
+
+
+
+
+
+
+ $buyerSms
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $buyerSms
+ = null
+
+
+
+
+
+
+
+
+ $closeURL
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $closeURL
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $currentTime
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currentTime
+ = null
+
+
+
+
+
+
+
+
+ $displayAmountPaid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $displayAmountPaid
+ = null
+
+
+
+
+
+
+
+
+ $exceptionStatus
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $exceptionStatus
+ = null
+
+
+
+
+
+
+
+
+ $exchangeRates
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $exchangeRates
+ = null
+
+
+
+
+
+
+
+
+ $expirationTime
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $expirationTime
+ = null
+
+
+
+
+
+
+
+
+ $extendedNotifications
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $extendedNotifications
+ = false
+
+
+
+
+
+
+
+
+ $forcedBuyerSelectedTransactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $forcedBuyerSelectedTransactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $forcedBuyerSelectedWallet
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $forcedBuyerSelectedWallet
+ = null
+
+
+
+
+
+
+
+
+ $fullNotifications
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $fullNotifications
+ = false
+
+
+
+
+
+
+
+
+ $guid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $guid
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $invoiceTime
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $invoiceTime
+ = null
+
+
+
+
+
+
+
+
+ $isCancelled
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $isCancelled
+ = null
+
+
+
+
+
+
+
+
+ $itemCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $itemCode
+ = null
+
+
+
+
+
+
+
+
+ $itemDesc
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $itemDesc
+ = null
+
+
+
+
+
+
+
+
+ $itemizedDetails
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, ItemizedDetails >
+ $itemizedDetails
+ = []
+
+
+
+
+
+
+
+
+ $jsonPayProRequired
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $jsonPayProRequired
+ = null
+
+
+
+
+
+
+
+
+ $lowFeeDetected
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $lowFeeDetected
+ = null
+
+
+
+
+
+
+
+
+ $merchantName
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $merchantName
+ = null
+
+
+
+
+
+
+
+
+ $minerFees
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFees |null
+ $minerFees
+ = null
+
+
+
+
+
+
+
+
+ $nonPayProPaymentReceived
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $nonPayProPaymentReceived
+ = null
+
+
+
+
+
+
+
+
+ $notificationEmail
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $notificationEmail
+ = null
+
+
+
+
+
+
+
+
+ $notificationURL
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $notificationURL
+ = null
+
+
+
+
+
+
+
+
+ $orderId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $orderId
+ = null
+
+
+
+
+
+
+
+
+ $overpaidAmount
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $overpaidAmount
+ = null
+
+
+
+
+
+
+
+
+ $paymentCodes
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentCodes
+ = null
+
+
+
+
+
+
+
+
+ $paymentCurrencies
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentCurrencies
+ = null
+
+
+
+
+
+
+
+
+ $paymentDisplaySubTotals
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentDisplaySubTotals
+ = null
+
+
+
+
+
+
+
+
+ $paymentDisplayTotals
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentDisplayTotals
+ = null
+
+
+
+
+
+
+
+
+ $paymentSubtotals
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentSubtotals
+ = null
+
+
+
+
+
+
+
+
+ $paymentTotals
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $paymentTotals
+ = null
+
+
+
+
+
+
+
+
+ $physical
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $physical
+ = false
+
+
+
+
+
+
+
+
+ $posData
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $posData
+ = null
+
+
+
+
+
+
+
+
+ $price
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $price
+ = null
+
+
+
+
+
+
+
+
+ $redirectURL
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $redirectURL
+ = null
+
+
+
+
+
+
+
+
+ $refundAddresses
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $refundAddresses
+ = null
+
+
+
+
+
+
+
+
+ $refundAddressRequestPending
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $refundAddressRequestPending
+ = null
+
+
+
+
+
+
+
+
+ $refundInfo
+
+
+
+
+
+
+
+
+
+ protected
+ RefundInfo |null
+ $refundInfo
+ = null
+
+
+
+
+
+
+
+
+ $selectedTransactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $selectedTransactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $shopper
+
+
+
+
+
+
+
+
+
+ protected
+ Shopper |null
+ $shopper
+ = null
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $supportedTransactionCurrencies
+
+
+
+
+
+
+
+
+
+ protected
+ SupportedTransactionCurrencies |null
+ $supportedTransactionCurrencies
+ = null
+
+
+
+
+
+
+
+
+ $targetConfirmations
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $targetConfirmations
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $token
+ = null
+
+
+
+
+
+
+
+
+ $transactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $transactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $transactions
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $transactions
+ = null
+
+
+
+
+
+
+
+
+ $transactionSpeed
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $transactionSpeed
+ = null
+
+
+
+
+
+
+
+
+ $underpaidAmount
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $underpaidAmount
+ = null
+
+
+
+
+
+
+
+
+ $universalCodes
+
+
+
+
+
+
+
+
+
+ protected
+ UniversalCodes |null
+ $universalCodes
+ = null
+
+
+
+
+
+
+
+
+ $url
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $url
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create a minimal request Invoice object.
+
+
+ public
+ __construct ( [ float|null $price = null ] [ , string|null $currency = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $price
+ : float|null
+ = null
+
+ float The amount for which the invoice will be created.
+
+
+
+
+ $currency
+ : string|null
+ = null
+
+ string three digit currency type used to compute the invoice bitcoin amount.
+
+
+
+
+
+
+
+
+
+
+
+ getAcceptanceWindow()
+
+
+
+
+
+ Gets acceptanceWindow
+
+
+ public
+ getAcceptanceWindow ( ) : float|null
+
+
+
+ Number of milliseconds that a user has to pay an invoice before it expires (0-900000).
+If not set, invoice will default to the account acceptanceWindow.
+If account acceptanceWindow is not set, invoice will default to 15 minutes (900,000 milliseconds).
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getAmountPaid()
+
+
+
+
+
+ Gets amountPaid
+
+
+ public
+ getAmountPaid ( ) : int|null
+
+
+
+ The total amount paid to the invoice in terms of the invoice transactionCurrency indicated
+in the smallest possible unit for the corresponding transactionCurrency (e.g satoshis for BTC and BCH)
+
+
+
+
+
+
+ Return values
+ int|null
+
+
+
+
+
+ getAutoRedirect()
+
+
+
+
+
+ Gets autoRedirect
+
+
+ public
+ getAutoRedirect ( ) : bool|null
+
+
+
+ Set to false by default,
+merchant can setup automatic redirect to their website by setting this parameter to true.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getBillId()
+
+
+
+
+
+ Gets billId
+
+
+ public
+ getBillId ( ) : string|null
+
+
+
+ This field will be in the invoice object only if the invoice was generated from a bill,
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/api/#rest-api-resources-bills
+
+ resource for more information
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getBitpayIdRequired()
+
+
+
+
+
+ Gets bitpayIdRequired
+
+
+ public
+ getBitpayIdRequired ( ) : bool|null
+
+
+
+ BitPay ID is a verification process that is required when a user is making payments
+or receiving a refund over a given threshold, which may vary by region.
+This Boolean forces the invoice to require BitPay ID regardless of the price.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getBuyer()
+
+
+
+
+
+ Gets buyer
+
+
+ public
+ getBuyer ( ) : Buyer |null
+
+
+
+ Allows merchant to pass buyer related information in the invoice object
+
+
+
+
+
+
+ Return values
+ Buyer |null
+ —
+
+
+
+
+
+
+
+ getBuyerEmail()
+
+
+
+
+
+ Gets buyerEmail
+
+
+ public
+ getBuyerEmail ( ) : string|null
+
+
+
+ Buyer's email address.
+If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBuyerProvidedEmail()
+
+
+
+
+
+ Gets buyerProvidedEmail
+
+
+ public
+ getBuyerProvidedEmail ( ) : string|null
+
+
+
+ Populated with the buyer's email address if passed in the buyer object by the merchant,
+otherwise this field is not returned for newly created invoices.
+If the merchant does not pass the buyer email in the invoice request,
+the bitpay invoice UI will prompt the user to enter his
+email address and this field will be populated with the email submitted.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the buyer provided email
+
+
+
+
+
+
+
+ getBuyerProvidedInfo()
+
+
+
+
+
+ Gets buyerProvidedEmail
+
+
+ public
+ getBuyerProvidedInfo ( ) : BuyerProvidedInfo |null
+
+
+
+ Information collected from the buyer during the process of paying an invoice.
+Initially this object is empty.
+
+
+
+
+
+
+ Return values
+ BuyerProvidedInfo |null
+ —
+ Information collected from the buyer
+
+
+
+
+
+
+
+ getBuyerSms()
+
+
+
+
+
+ Gets buyerSms
+
+
+ public
+ getBuyerSms ( ) : string|null
+
+
+
+ SMS provided by user for communications.
+This is only used for instances where a buyers email
+(primary form of buyer communication) is can not be gathered.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCloseURL()
+
+
+
+
+
+ Gets closeURL
+
+
+ public
+ getCloseURL ( ) : string|null
+
+
+
+ URL to redirect if the shopper does not pay the invoice and click on the Close button instead.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the price field,
+supported currencies are available via the
+Currencies resource
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrentTime()
+
+
+
+
+
+ Gets currentTime - UNIX time of API call, in milliseconds
+
+
+ public
+ getCurrentTime ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getDisplayAmountPaid()
+
+
+
+
+
+ Gets displayAmountPaid
+
+
+ public
+ getDisplayAmountPaid ( ) : string|null
+
+
+
+ Initially set to "0" when creating the invoice.
+It will be updated with the total amount paid to the invoice
+indicated in the base unit for the corresponding transactionCurrency
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getExceptionStatus()
+
+
+
+
+
+ Gets exceptionStatus
+
+
+ public
+ getExceptionStatus ( ) : bool|null
+
+
+
+ Initially a boolean false, this parameter will indicate if the purchaser sent too much ("paidOver")
+or not enough funds ("paidPartial") in the transaction to pay the BitPay invoice. Possible values are:
+false: default value (boolean) unless an exception is triggered.
+"paidPartial": (string) if the consumer did not send enough funds when paying the invoice.
+"paidOver": (string) if the consumer sent to much funds when paying the invoice.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getExchangeRates()
+
+
+
+
+
+ Gets exchangeRates
+
+
+ public
+ getExchangeRates ( ) : array<string|int, mixed>|null
+
+
+
+ Exchange rates keyed by source and target currencies.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+
+
+
+
+
+ getExpirationTime()
+
+
+
+
+
+ Gets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+
+
+ public
+ getExpirationTime ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getExtendedNotifications()
+
+
+
+
+
+ Gets extendedNotifications
+
+
+ public
+ getExtendedNotifications ( ) : bool|null
+
+
+
+ Allows merchants to get access to additional webhooks.
+For instance when an invoice expires without receiving a payment or when it is refunded.
+If set to true, then fullNotifications is automatically set to true.
+When using the extendedNotifications parameter,
+the webhook also have a payload slightly different from the standard webhooks.
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getForcedBuyerSelectedTransactionCurrency()
+
+
+
+
+
+ Gets forcedBuyerSelectedWallet
+
+
+ public
+ getForcedBuyerSelectedTransactionCurrency ( ) : string|null
+
+
+
+ Merchant pre-selects transaction currency on behalf of buyer.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ Merchant pre-selects transaction currency
+
+
+
+
+
+
+
+ getForcedBuyerSelectedWallet()
+
+
+
+
+
+ Gets forcedBuyerSelectedWallet
+
+
+ public
+ getForcedBuyerSelectedWallet ( ) : string|null
+
+
+
+ Merchant pre-selects transaction currency on behalf of buyer.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the forced buyer selected wallet
+
+
+
+
+
+
+
+ getFullNotifications()
+
+
+
+
+
+ Gets fullNotifications
+
+
+ public
+ getFullNotifications ( ) : bool|null
+
+
+
+ This parameter is set to true by default, meaning all standard notifications
+are being sent for a payment made to an invoice.
+If you decide to set it to false instead, only 1 webhook will be sent for each
+invoice paid by the consumer.
+This webhook will be for the "confirmed" or "complete" invoice status,
+depending on the transactionSpeed selected.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getGuid()
+
+
+
+
+
+ Gets guid
+
+
+ public
+ getGuid ( ) : string|null
+
+
+
+ A passthru variable provided by the merchant and designed to be used by the merchant
+to correlate the invoice with an order ID in their system,
+which can be used as a lookup variable in Retrieve Invoice by GUID.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets invoice resource id
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getInvoiceTime()
+
+
+
+
+
+ Gets invoiceTime - UNIX time of invoice creation, in milliseconds
+
+
+ public
+ getInvoiceTime ( ) : int|null
+
+
+
+
+
+
+
+
+ Return values
+ int|null
+ —
+ UNIX time of invoice creation, in milliseconds
+
+
+
+
+
+
+
+ getIsCancelled()
+
+
+
+
+
+ Gets isCancelled
+
+
+ public
+ getIsCancelled ( ) : bool|null
+
+
+
+ Indicates whether or not the invoice was cancelled.
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getItemCode()
+
+
+
+
+
+ Gets itemCode
+
+
+ public
+ getItemCode ( ) : string|null
+
+
+
+ "bitcoindonation" for donations, otherwise do not include the field in the request.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getItemDesc()
+
+
+
+
+
+ Gets itemDesc
+
+
+ public
+ getItemDesc ( ) : string|null
+
+
+
+ Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getItemizedDetails()
+
+
+
+
+
+ Gets itemizedDetails
+
+
+ public
+ getItemizedDetails ( ) : array<string|int, ItemizedDetails >
+
+
+
+ Object containing line item details for display.
+
+
+
+
+
+
+
+
+
+
+ getJsonPayProRequired()
+
+
+
+
+
+ Gets jsonPayProRequired
+
+
+ public
+ getJsonPayProRequired ( ) : bool|null
+
+
+
+ Boolean set to false by default.
+If set to true, this means that the invoice will only accept payments
+from wallets which have implemented the
+BitPay JSON Payment Protocol
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+ the json pay pro required
+
+
+
+
+
+
+
+ getLowFeeDetected()
+
+
+
+
+
+ Gets lowFeeDetected
+
+
+ public
+ getLowFeeDetected ( ) : bool|null
+
+
+
+ Flag to indicate if the miner fee used by the buyer is too low.
+Initially set to false when the invoice is created.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+ Flag to indicate if the miner fee used by the buyer is too low
+
+
+
+
+
+
+
+ getMerchantName()
+
+
+
+
+
+ Gets merchantName
+
+
+ public
+ getMerchantName ( ) : string|null
+
+
+
+ A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getMinerFees()
+
+
+
+
+
+ Gets minerFees
+
+
+ public
+ getMinerFees ( ) : MinerFees |null
+
+
+
+ The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+The key is the currency and the value is an object containing
+the satoshis per byte, the total fee, and the fiat amount.
+This is referenced as "Network Cost" on an invoice, see
+
+this support article
+ for more information
+
+
+
+
+
+
+
+
+
+
+ getNonPayProPaymentReceived()
+
+
+
+
+
+ Gets nonPayProPaymentReceived
+
+
+ public
+ getNonPayProPaymentReceived ( ) : bool|null
+
+
+
+ This boolean will be available on an invoice object once an invoice is paid
+and indicate if the transaction was made with a wallet using the payment protocol (true) or peer to peer (false).
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getNotificationEmail()
+
+
+
+
+
+ Gets NotificationEmail
+
+
+ public
+ getNotificationEmail ( ) : string|null
+
+
+
+ Merchant email address for notification of payout status change.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getNotificationURL()
+
+
+
+
+
+ Gets notificationURL
+
+
+ public
+ getNotificationURL ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+
+
+
+
+
+
+ getOrderId()
+
+
+
+
+
+ Gets orderId
+
+
+ public
+ getOrderId ( ) : string|null
+
+
+
+ Can be used by the merchant to assign their own internal Id to an invoice.
+If used, there should be a direct match between an orderId and an invoice id.
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getOverpaidAmount()
+
+
+
+
+
+ Gets overpaidAmount
+
+
+ public
+ getOverpaidAmount ( ) : int|null
+
+
+
+ This parameter will be returned on the invoice object
+if the invoice was overpaid ("exceptionStatus": "paidOver").
+It equals to the absolute difference between amountPaid
+and paymentTotals for the corresponding transactionCurrency used.
+
+
+
+
+
+
+ Return values
+ int|null
+
+
+
+
+
+ getPaymentCodes()
+
+
+
+
+
+ Gets paymentCodes
+
+
+ public
+ getPaymentCodes ( ) : array<string|int, mixed>|null
+
+
+
+ The URIs for sending a transaction to the invoice. The first key is the transaction currency.
+The transaction currency maps to an object containing the payment URIs.
+The key of this object is the BIP number and the value is the payment URI.
+For "BTC", "BCH" and "DOGE" - BIP72b and BIP73 are supported.
+For "ETH", "GUSD", "PAX", "BUSD", "USDC", "DAI" and "WBTC"- EIP681 is supported
+For "XRP" - RIP681, BIP72b and BIP73 is supported
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+
+
+
+
+
+ getPaymentCurrencies()
+
+
+
+
+
+ Gets paymentCurrencies
+
+
+ public
+ getPaymentCurrencies ( ) : array<string|int, mixed>|null
+
+
+
+ Allow the merchant to select the cryptocurrencies available as payment option on the BitPay invoice.
+Possible values are currently "BTC", "BCH", "ETH", "GUSD",
+"PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+For instance "paymentCurrencies": ["BTC"] will create an invoice with only XRP available as transaction currency,
+thus bypassing the currency selection step on the invoice.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getPaymentDisplaySubTotals()
+
+
+
+
+
+ Gets paymentDisplaySubtotals
+
+
+ public
+ getPaymentDisplaySubTotals ( ) : array<string|int, mixed>|null
+
+
+
+ Equivalent to price for each supported transactionCurrency, excluding minerFees.
+The key is the currency and the value is an amount indicated in the base unit
+for each supported transactionCurrency.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+ Equivalent to price for each supported transactionCurrency
+
+
+
+
+
+
+
+ getPaymentDisplayTotals()
+
+
+
+
+
+ Gets paymentDisplayTotals
+
+
+ public
+ getPaymentDisplayTotals ( ) : array<string|int, mixed>|null
+
+
+
+ The total amount that the purchaser should pay as displayed on the invoice UI.
+This is like paymentDisplaySubTotals but with the minerFees included.
+The key is the currency and the value is an amount
+indicated in the base unit for each supported transactionCurrency.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+ The total amount that the purchaser should pay
+
+
+
+
+
+
+
+ getPaymentSubtotals()
+
+
+
+
+
+ Gets paymentSubtotals
+
+
+ public
+ getPaymentSubtotals ( ) : array<string|int, mixed>|null
+
+
+
+ For internal use. This field can be ignored in merchant implementations.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getPaymentTotals()
+
+
+
+
+
+ Gets paymentTotals
+
+
+ public
+ getPaymentTotals ( ) : array<string|int, mixed>|null
+
+
+
+ For internal use - This field can be ignored in merchant implementations.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getPhysical()
+
+
+
+
+
+ Gets physical.
+
+
+ public
+ getPhysical ( ) : bool|null
+
+
+
+ Indicates whether items are physical goods. Alternatives include digital goods and services.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getPosData()
+
+
+
+
+
+ Gets posData
+
+
+ public
+ getPosData ( ) : string|null
+
+
+
+ A passthru variable provided by the merchant during invoice creation and designed to be
+used by the merchant to correlate the invoice with an order or other object in their system.
+This passthru variable can be a serialized object.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPrice()
+
+
+
+
+
+ Gets price
+
+
+ public
+ getPrice ( ) : float|null
+
+
+
+ Fixed price amount for the checkout, in the "currency" of the invoice object.
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getRedirectURL()
+
+
+
+
+
+ Gets RedirectURL
+
+
+ public
+ getRedirectURL ( ) : string|null
+
+
+
+ The shopper will be redirected to this URL when clicking on the Return button
+after a successful payment or when clicking on the Close button if a separate closeURL is not specified.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getRefundAddresses()
+
+
+
+
+
+ Gets refundAddresses
+
+
+ public
+ getRefundAddresses ( ) : array<string|int, mixed>|null
+
+
+
+ Initially empty when the invoice is created.
+This field will be populated with the refund address
+provided by the customer if you request a refund of the specific invoice.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+ Refund address provided by the customer
+
+
+
+
+
+
+
+ getRefundAddressRequestPending()
+
+
+
+
+
+ Gets refundAddressRequestPending
+
+
+ public
+ getRefundAddressRequestPending ( ) : bool|null
+
+
+
+ Initially set to false when the invoice is created,
+this field will be set to true once a refund request has been issued by the merchant.
+This flag is here to indicate that the refund request is pending action
+from the buyer to provide an address for the refund,
+via the secure link which has been automatically emailed to him.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+ the refund address request pending
+
+
+
+
+
+
+
+ getRefundInfo()
+
+
+
+
+
+ Gets refundInfo
+
+
+ public
+ getRefundInfo ( ) : RefundInfo |null
+
+
+
+ For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+
+
+
+
+
+
+
+
+
+
+ getSelectedTransactionCurrency()
+
+
+
+
+
+ Gets selectedTransactionCurrency
+
+
+ public
+ getSelectedTransactionCurrency ( ) : string|null
+
+
+
+ This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+"USDC", "XRP", "DOGE", "DAI" and "WBTC".
+If not yet selected, this field will not be returned.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the selected transaction currency
+
+
+
+
+
+
+
+ getShopper()
+
+
+
+
+
+ Gets shopper
+
+
+ public
+ getShopper ( ) : Shopper |null
+
+
+
+ This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+
+
+
+
+
+
+
+ see
+
+
+ https://blog.bitpay.com/bitpay-dashboard-id
+
+
+
+
+
+
+
+ Return values
+ Shopper |null
+ —
+
+
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets status
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSupportedTransactionCurrencies()
+
+
+
+
+
+ Gets supportedTransactionCurrencies
+
+
+ public
+ getSupportedTransactionCurrencies ( ) : SupportedTransactionCurrencies |null
+
+
+
+ The currencies that may be used to pay this invoice.
+The object is keyed by currency code.
+The values are objects with an "enabled" boolean and option.
+An extra "reason" parameter is added in the object if a cryptocurrency is disabled on a specific invoice.
+If you disable a currency via the invoice parameter "paymentCurrencies",
+this parameter will be set to "merchantDisabledByParam"
+
+
+
+
+
+
+
+
+
+
+ getTargetConfirmations()
+
+
+
+
+
+ Gets targetConfirmations
+
+
+ public
+ getTargetConfirmations ( ) : int|null
+
+
+
+ Indicates the number of block confirmation of the crypto currency
+transaction which are required to credit a paid invoice to the merchant account.
+Currently, the value set is set to 6 by default for BTC/BCH/XRP,
+40 for DOGE and 50 for ETH/GUSD/PAX/USDC/BUSD/DAI/WBTC
+
+
+
+
+
+
+ Return values
+ int|null
+ —
+ the target confirmations
+
+
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets token
+
+
+ public
+ getToken ( ) : string|null
+
+
+
+ Invoice resource token. This token is derived from the API token initially used
+to create the invoice and is tied to the specific resource id created.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+Invoice resource token.
+
+
+
+
+
+
+
+
+ getTransactionCurrency()
+
+
+
+
+
+ Gets transactionCurrency
+
+
+ public
+ getTransactionCurrency ( ) : string|null
+
+
+
+ The cryptocurrency used to pay the invoice.
+This field will only be available after a transaction is applied to the invoice.
+Possible values are currently "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+"USDC", "XRP", "DOGE", "DAI" and "WBTC".
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getTransactions()
+
+
+
+
+
+ Gets transactions
+
+
+ public
+ getTransactions ( ) : array<string|int, mixed>|null
+
+
+
+ Contains the cryptocurrency transaction details for the executed payout.
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getTransactionSpeed()
+
+
+
+
+
+ Gets transactionSpeed.
+
+
+ public
+ getTransactionSpeed ( ) : string|null
+
+
+
+ This is a risk mitigation parameter for the merchant to configure how they want
+to fulfill orders depending on the number of block confirmations for the transaction
+made by the consumer on the selected cryptocurrency.
+If not set on the invoice, transactionSpeed will default to the account-level Order Settings.
+Note : orders are only credited to your BitPay Account Summary for settlement after
+the invoice reaches the status "complete" (regardless of this setting).
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getUnderpaidAmount()
+
+
+
+
+
+ Gets underpaidAmount
+
+
+ public
+ getUnderpaidAmount ( ) : int|null
+
+
+
+ This parameter will be returned on the invoice object
+if the invoice was underpaid ("exceptionStatus": "paidPartial").
+It equals to the absolute difference between amountPaid
+and paymentTotals for the corresponding transactionCurrency used.
+
+
+
+
+
+
+ Return values
+ int|null
+
+
+
+
+
+ getUniversalCodes()
+
+
+
+
+
+ Gets universalCodes
+
+
+ public
+ getUniversalCodes ( ) : UniversalCodes |null
+
+
+
+ Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+
+
+
+
+ getUrl()
+
+
+
+
+
+ Gets url
+
+
+ public
+ getUrl ( ) : string|null
+
+
+
+ Web address of invoice, expires at expirationTime
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAcceptanceWindow()
+
+
+
+
+
+ Sets acceptanceWindow
+
+
+ public
+ setAcceptanceWindow ( float $acceptanceWindow ) : void
+
+
+
+ Number of milliseconds that a user has to pay an invoice before it expires (0-900000).
+If not set, invoice will default to the account acceptanceWindow.
+If account acceptanceWindow is not set, invoice will default to 15 minutes (900,000 milliseconds).
+
+
+ Parameters
+
+
+ $acceptanceWindow
+ : float
+
+
+ Number of milliseconds that a user has to pay an invoice before it expire
+
+
+
+
+
+
+
+
+
+
+
+ setAmountPaid()
+
+
+
+
+
+ Sets amountPaid
+
+
+ public
+ setAmountPaid ( int $amountPaid ) : void
+
+
+
+ The total amount paid to the invoice in terms of the invoice transactionCurrency indicated
+in the smallest possible unit for the corresponding transactionCurrency (e.g satoshis for BTC and BCH)
+
+
+ Parameters
+
+
+ $amountPaid
+ : int
+
+
+ The total amount paid to the invoice
+
+
+
+
+
+
+
+
+
+
+
+ setAutoRedirect()
+
+
+
+
+
+ Sets autoRedirect
+
+
+ public
+ setAutoRedirect ( bool $autoRedirect ) : void
+
+
+
+ Set to false by default,
+merchant can setup automatic redirect to their website by setting this parameter to true.
+
+
+ Parameters
+
+
+ $autoRedirect
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBillId()
+
+
+
+
+
+ Sets billId
+
+
+ public
+ setBillId ( string $billId ) : void
+
+
+
+ This field will be in the invoice object only if the invoice was generated from a bill,
+
+
+ Parameters
+
+
+ $billId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/api/#rest-api-resources-bills
+
+ resource for more information
+
+
+
+
+
+
+
+
+
+ setBitpayIdRequired()
+
+
+
+
+
+ Sets bitpayIdRequired
+
+
+ public
+ setBitpayIdRequired ( bool $bitpayIdRequired ) : void
+
+
+
+ BitPay ID is a verification process that is required when a user is making payments
+or receiving a refund over a given threshold, which may vary by region.
+This Boolean forces the invoice to require BitPay ID regardless of the price.
+
+
+ Parameters
+
+
+ $bitpayIdRequired
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyer()
+
+
+
+
+
+ Sets buyer
+
+
+ public
+ setBuyer ( Buyer $buyer ) : void
+
+
+
+ Allows merchant to pass buyer related information in the invoice object
+
+
+ Parameters
+
+
+ $buyer
+ : Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerEmail()
+
+
+
+
+
+ Sets buyerEmail
+
+
+ public
+ setBuyerEmail ( string $buyerEmail ) : void
+
+
+
+ Buyer's email address.
+If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+
+
+ Parameters
+
+
+ $buyerEmail
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerProvidedEmail()
+
+
+
+
+
+ Sets buyerProvidedEmail
+
+
+ public
+ setBuyerProvidedEmail ( string $buyerProvidedEmail ) : void
+
+
+
+ Populated with the buyer's email address if passed in the buyer object by the merchant,
+otherwise this field is not returned for newly created invoices.
+If the merchant does not pass the buyer email in the invoice request,
+the bitpay invoice UI will prompt the user to enter his
+email address and this field will be populated with the email submitted.
+
+
+ Parameters
+
+
+ $buyerProvidedEmail
+ : string
+
+
+ Populated with the buyer's email address if passed in the buyer object
+by the merchant
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerProvidedInfo()
+
+
+
+
+
+ Sets buyerProvidedEmail
+
+
+ public
+ setBuyerProvidedInfo ( BuyerProvidedInfo $buyerProvidedInfo ) : mixed
+
+
+
+ Information collected from the buyer during the process of paying an invoice.
+Initially this object is empty.
+
+
+ Parameters
+
+
+ $buyerProvidedInfo
+ : BuyerProvidedInfo
+
+
+ Information collected from the buyer
+during the process of paying an invoice
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerSms()
+
+
+
+
+
+ Sets buyerSms
+
+
+ public
+ setBuyerSms ( string $buyerSms ) : void
+
+
+
+ SMS provided by user for communications.
+This is only used for instances where a buyers email
+(primary form of buyer communication) is can not be gathered.
+
+
+ Parameters
+
+
+ $buyerSms
+ : string
+
+
+ SMS provided by user for communication
+
+
+
+
+
+
+
+
+
+
+
+ setCloseURL()
+
+
+
+
+
+ Gets closeURL
+
+
+ public
+ setCloseURL ( string $closeURL ) : void
+
+
+
+ URL to redirect if the shopper does not pay the invoice and click on the Close button instead.
+Be sure to include "http://" or "https://" in the url.
+
+
+ Parameters
+
+
+ $closeURL
+ : string
+
+
+ URL to redirect if the shopper does not pay the invoice
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the price field,
+supported currencies are available via the
+Currencies resource
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ 3-character currency code
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ setCurrentTime()
+
+
+
+
+
+ Sets currentTime - UNIX time of API call, in milliseconds
+
+
+ public
+ setCurrentTime ( string $currentTime ) : void
+
+
+
+
+ Parameters
+
+
+ $currentTime
+ : string
+
+
+ UNIX time of API call, in milliseconds
+
+
+
+
+
+
+
+
+
+
+
+ setDisplayAmountPaid()
+
+
+
+
+
+ Sets displayAmountPaid
+
+
+ public
+ setDisplayAmountPaid ( string $displayAmountPaid ) : void
+
+
+
+ Initially set to "0" when creating the invoice.
+It will be updated with the total amount paid to the invoice
+indicated in the base unit for the corresponding transactionCurrency
+
+
+ Parameters
+
+
+ $displayAmountPaid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setExceptionStatus()
+
+
+
+
+
+ Sets exceptionStatus
+
+
+ public
+ setExceptionStatus ( bool $exceptionStatus ) : void
+
+
+
+ Initially a boolean false, this parameter will indicate if the purchaser sent too much ("paidOver")
+or not enough funds ("paidPartial") in the transaction to pay the BitPay invoice. Possible values are:
+false: default value (boolean) unless an exception is triggered.
+"paidPartial": (string) if the consumer did not send enough funds when paying the invoice.
+"paidOver": (string) if the consumer sent to much funds when paying the invoice.
+
+
+ Parameters
+
+
+ $exceptionStatus
+ : bool
+
+
+ this parameter will indicate if the purchaser sent too much or not enough funds
+
+
+
+
+
+
+
+
+
+
+
+ setExchangeRates()
+
+
+
+
+
+ Sets exchangeRates
+
+
+ public
+ setExchangeRates ( array<string|int, mixed>|null $exchangeRates ) : void
+
+
+
+ Exchange rates keyed by source and target currencies.
+
+
+ Parameters
+
+
+ $exchangeRates
+ : array<string|int, mixed>|null
+
+
+ Exchange rates keyed by source and target currencies.
+
+
+
+
+
+
+
+
+
+
+
+ setExpirationTime()
+
+
+
+
+
+ Sets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+
+
+ public
+ setExpirationTime ( string $expirationTime ) : void
+
+
+
+
+ Parameters
+
+
+ $expirationTime
+ : string
+
+
+ UNIX time when invoice is last available to be paid, in milliseconds
+
+
+
+
+
+
+
+
+
+
+
+ setExtendedNotifications()
+
+
+
+
+
+ Sets extendedNotifications
+
+
+ public
+ setExtendedNotifications ( bool $extendedNotifications ) : void
+
+
+
+ Allows merchants to get access to additional webhooks.
+For instance when an invoice expires without receiving a payment or when it is refunded.
+If set to true, then fullNotifications is automatically set to true.
+When using the extendedNotifications parameter,
+the webhook also have a payload slightly different from the standard webhooks.
+
+
+ Parameters
+
+
+ $extendedNotifications
+ : bool
+
+
+ Allows merchants to get access to additional webhooks
+
+
+
+
+
+
+
+
+
+
+
+ setForcedBuyerSelectedTransactionCurrency()
+
+
+
+
+
+ Sets forcedBuyerSelectedWallet
+
+
+ public
+ setForcedBuyerSelectedTransactionCurrency ( string $forcedBuyerSelectedTransactionCurrency ) : mixed
+
+
+
+ Merchant pre-selects transaction currency on behalf of buyer.
+
+
+ Parameters
+
+
+ $forcedBuyerSelectedTransactionCurrency
+ : string
+
+
+ Merchant pre-selects transaction currency
+
+
+
+
+
+
+
+
+
+
+
+ setForcedBuyerSelectedWallet()
+
+
+
+
+
+ Sets forcedBuyerSelectedWallet
+
+
+ public
+ setForcedBuyerSelectedWallet ( string $forcedBuyerSelectedWallet ) : mixed
+
+
+
+ Merchant pre-selects transaction currency on behalf of buyer.
+
+
+ Parameters
+
+
+ $forcedBuyerSelectedWallet
+ : string
+
+
+ Merchant pre-selects wallet on behalf of buyer
+
+
+
+
+
+
+
+
+
+
+
+ setFullNotifications()
+
+
+
+
+
+ Sets fullNotifications
+
+
+ public
+ setFullNotifications ( bool $fullNotifications ) : void
+
+
+
+ This parameter is set to true by default, meaning all standard notifications
+are being sent for a payment made to an invoice.
+If you decide to set it to false instead, only 1 webhook will be sent for each
+invoice paid by the consumer.
+This webhook will be for the "confirmed" or "complete" invoice status,
+depending on the transactionSpeed selected.
+
+
+ Parameters
+
+
+ $fullNotifications
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setGuid()
+
+
+
+
+
+ Sets guid
+
+
+ public
+ setGuid ( string $guid ) : void
+
+
+
+ A passthru variable provided by the merchant and designed to be used by the merchant
+to correlate the invoice with an order ID in their system,
+which can be used as a lookup variable in Retrieve Invoice by GUID.
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the refund request being retrieved
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets invoice resource id
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceTime()
+
+
+
+
+
+ Sets invoiceTime - UNIX time of invoice creation, in milliseconds
+
+
+ public
+ setInvoiceTime ( int $invoiceTime ) : mixed
+
+
+
+
+ Parameters
+
+
+ $invoiceTime
+ : int
+
+
+ UNIX time of invoice creation, in milliseconds
+
+
+
+
+
+
+
+
+
+
+
+ setIsCancelled()
+
+
+
+
+
+ Sets isCancelled
+
+
+ public
+ setIsCancelled ( bool $isCancelled ) : void
+
+
+
+ Indicates whether or not the invoice was cancelled.
+
+
+ Parameters
+
+
+ $isCancelled
+ : bool
+
+
+ Indicates whether or not the invoice was cancelled.
+
+
+
+
+
+
+
+
+
+
+
+ setItemCode()
+
+
+
+
+
+ Sets itemCode
+
+
+ public
+ setItemCode ( string $itemCode ) : void
+
+
+
+ "bitcoindonation" for donations, otherwise do not include the field in the request.
+
+
+ Parameters
+
+
+ $itemCode
+ : string
+
+
+ "bitcoindonation" for donations, otherwise do not include the field in the request.
+
+
+
+
+
+
+
+
+
+
+
+ setItemDesc()
+
+
+
+
+
+ Sets itemDesc
+
+
+ public
+ setItemDesc ( string $itemDesc ) : void
+
+
+
+ Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.
+
+
+ Parameters
+
+
+ $itemDesc
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setItemizedDetails()
+
+
+
+
+
+ Sets itemizedDetails
+
+
+ public
+ setItemizedDetails ( array<string|int, ItemizedDetails > $itemizedDetails ) : void
+
+
+
+ Object containing line item details for display.
+
+
+ Parameters
+
+
+ $itemizedDetails
+ : array<string|int, ItemizedDetails >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ setJsonPayProRequired()
+
+
+
+
+
+ Sets jsonPayProRequired
+
+
+ public
+ setJsonPayProRequired ( bool $jsonPayProRequired ) : void
+
+
+
+ Boolean set to false by default.
+If set to true, this means that the invoice will only accept payments
+from wallets which have implemented the
+BitPay JSON Payment Protocol
+
+
+ Parameters
+
+
+ $jsonPayProRequired
+ : bool
+
+
+ the json pay pro required
+
+
+
+
+
+
+
+
+
+
+
+ setLowFeeDetected()
+
+
+
+
+
+ Sets lowFeeDetected
+
+
+ public
+ setLowFeeDetected ( bool $lowFeeDetected ) : mixed
+
+
+
+ Flag to indicate if the miner fee used by the buyer is too low.
+Initially set to false when the invoice is created.
+
+
+ Parameters
+
+
+ $lowFeeDetected
+ : bool
+
+
+ Flag to indicate if the miner fee used by the buyer is too low
+
+
+
+
+
+
+
+
+
+
+
+ setMerchantName()
+
+
+
+
+
+ Sets merchantName
+
+
+ public
+ setMerchantName ( string $merchantName ) : void
+
+
+
+ A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).
+
+
+ Parameters
+
+
+ $merchantName
+ : string
+
+
+ A display string for merchant identification
+
+
+
+
+
+
+
+
+
+
+
+ setMinerFees()
+
+
+
+
+
+ Sets minerFees
+
+
+ public
+ setMinerFees ( MinerFees $minerFees ) : void
+
+
+
+ The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+The key is the currency and the value is an object containing
+the satoshis per byte, the total fee, and the fiat amount.
+This is referenced as "Network Cost" on an invoice, see
+
+this support article
+ for more information
+
+
+ Parameters
+
+
+ $minerFees
+ : MinerFees
+
+
+ The total amount of fees that the purchaser will pay
+to cover BitPay's UTXO sweep cost for an invoice
+
+
+
+
+
+
+
+
+
+
+
+ setNonPayProPaymentReceived()
+
+
+
+
+
+ Sets nonPayProPaymentReceived
+
+
+ public
+ setNonPayProPaymentReceived ( bool $nonPayProPaymentReceived ) : void
+
+
+
+ This boolean will be available on an invoice object once an invoice is paid
+and indicate if the transaction was made with a wallet using the payment protocol (true) or peer to peer (false).
+
+
+ Parameters
+
+
+ $nonPayProPaymentReceived
+ : bool
+
+
+ transaction was made with a wallet using the payment protocol
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationEmail()
+
+
+
+
+
+ Sets NotificationEmail
+
+
+ public
+ setNotificationEmail ( string $notificationEmail ) : void
+
+
+
+ Merchant email address for notification of payout status change.
+
+
+ Parameters
+
+
+ $notificationEmail
+ : string
+
+
+ Merchant email address for notification of payout status change
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationURL()
+
+
+
+
+
+ Sets notificationURL
+
+
+ public
+ setNotificationURL ( string $notificationURL ) : void
+
+
+
+
+ Parameters
+
+
+ $notificationURL
+ : string
+
+
+
+URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+
+
+
+
+
+
+
+
+
+
+ setOrderId()
+
+
+
+
+
+ Sets orderId
+
+
+ public
+ setOrderId ( string $orderId ) : void
+
+
+
+ Can be used by the merchant to assign their own internal Id to an invoice.
+If used, there should be a direct match between an orderId and an invoice id.
+
+
+ Parameters
+
+
+ $orderId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setOverpaidAmount()
+
+
+
+
+
+ Sets overpaidAmount
+
+
+ public
+ setOverpaidAmount ( int $overpaidAmount ) : void
+
+
+
+ This parameter will be returned on the invoice object
+if the invoice was overpaid ("exceptionStatus": "paidOver").
+It equals to the absolute difference between amountPaid
+and paymentTotals for the corresponding transactionCurrency used.
+
+
+ Parameters
+
+
+ $overpaidAmount
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentCodes()
+
+
+
+
+
+ Sets paymentCodes
+
+
+ public
+ setPaymentCodes ( array<string|int, mixed>|null $paymentCodes ) : mixed
+
+
+
+ The URIs for sending a transaction to the invoice. The first key is the transaction currency.
+The transaction currency maps to an object containing the payment URIs.
+The key of this object is the BIP number and the value is the payment URI.
+For "BTC", "BCH" and "DOGE" - BIP72b and BIP73 are supported.
+For "ETH", "GUSD", "PAX", "BUSD", "USDC", "DAI" and "WBTC"- EIP681 is supported
+For "XRP" - RIP681, BIP72b and BIP73 is supported
+
+
+ Parameters
+
+
+ $paymentCodes
+ : array<string|int, mixed>|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentCurrencies()
+
+
+
+
+
+ Sets paymentCurrencies
+
+
+ public
+ setPaymentCurrencies ( array<string|int, mixed> $paymentCurrencies ) : void
+
+
+
+ Allow the merchant to select the cryptocurrencies available as payment option on the BitPay invoice.
+Possible values are currently "BTC", "BCH", "ETH", "GUSD",
+"PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+For instance "paymentCurrencies": ["BTC"] will create an invoice with only XRP available as transaction currency,
+thus bypassing the currency selection step on the invoice.
+
+
+ Parameters
+
+
+ $paymentCurrencies
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentDisplaySubTotals()
+
+
+
+
+
+ Sets paymentDisplaySubtotals
+
+
+ public
+ setPaymentDisplaySubTotals ( array<string|int, mixed>|null $paymentDisplaySubTotals ) : mixed
+
+
+
+ Equivalent to price for each supported transactionCurrency, excluding minerFees.
+The key is the currency and the value is an amount indicated in the base unit
+for each supported transactionCurrency.
+
+
+ Parameters
+
+
+ $paymentDisplaySubTotals
+ : array<string|int, mixed>|null
+
+
+ Equivalent to price for each supported transactionCurrency
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentDisplayTotals()
+
+
+
+
+
+ Sets paymentDisplayTotals
+
+
+ public
+ setPaymentDisplayTotals ( array<string|int, mixed>|null $paymentDisplayTotals ) : mixed
+
+
+
+ The total amount that the purchaser should pay as displayed on the invoice UI.
+This is like paymentDisplaySubTotals but with the minerFees included.
+The key is the currency and the value is an amount
+indicated in the base unit for each supported transactionCurrency.
+
+
+ Parameters
+
+
+ $paymentDisplayTotals
+ : array<string|int, mixed>|null
+
+
+ The total amount that the purchaser should pay
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentSubtotals()
+
+
+
+
+
+ Sets paymentSubtotals
+
+
+ public
+ setPaymentSubtotals ( array<string|int, mixed>|null $paymentSubtotals ) : mixed
+
+
+
+ For internal use. This field can be ignored in merchant implementations.
+
+
+ Parameters
+
+
+ $paymentSubtotals
+ : array<string|int, mixed>|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPaymentTotals()
+
+
+
+
+
+ Sets paymentTotals
+
+
+ public
+ setPaymentTotals ( array<string|int, mixed>|null $paymentTotals ) : mixed
+
+
+
+ For internal use - This field can be ignored in merchant implementations.
+
+
+ Parameters
+
+
+ $paymentTotals
+ : array<string|int, mixed>|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPhysical()
+
+
+
+
+
+ Sets physical.
+
+
+ public
+ setPhysical ( bool $physical ) : void
+
+
+
+ Indicates whether items are physical goods. Alternatives include digital goods and services.
+
+
+ Parameters
+
+
+ $physical
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPosData()
+
+
+
+
+
+ Sets posData
+
+
+ public
+ setPosData ( string $posData ) : void
+
+
+
+ A passthru variable provided by the merchant during invoice creation and designed to be
+used by the merchant to correlate the invoice with an order or other object in their system.
+This passthru variable can be a serialized object.
+
+
+ Parameters
+
+
+ $posData
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPrice()
+
+
+
+
+
+ Sets price
+
+
+ public
+ setPrice ( float $price ) : void
+
+
+
+ Fixed price amount for the checkout, in the "currency" of the invoice object.
+
+
+ Parameters
+
+
+ $price
+ : float
+
+
+ Fixed price amount for the checkout, in the "currency" of the invoice object.
+
+
+
+
+
+
+
+
+
+
+
+ setRedirectURL()
+
+
+
+
+
+ Sets RedirectURL
+
+
+ public
+ setRedirectURL ( string $redirectURL ) : void
+
+
+
+ The shopper will be redirected to this URL when clicking on the Return button
+after a successful payment or when clicking on the Close button if a separate closeURL is not specified.
+Be sure to include "http://" or "https://" in the url.
+
+
+ Parameters
+
+
+ $redirectURL
+ : string
+
+
+ The shopper will be redirected to this URL
+
+
+
+
+
+
+
+
+
+
+
+ setRefundAddresses()
+
+
+
+
+
+ Sets refundAddresses
+
+
+ public
+ setRefundAddresses ( array<string|int, mixed> $refundAddresses ) : void
+
+
+
+ Initially empty when the invoice is created.
+This field will be populated with the refund address
+provided by the customer if you request a refund of the specific invoice.
+
+
+ Parameters
+
+
+ $refundAddresses
+ : array<string|int, mixed>
+
+
+ Refund address provided by the customer
+
+
+
+
+
+
+
+
+
+
+
+ setRefundAddressRequestPending()
+
+
+
+
+
+ Sets refundAddressRequestPending
+
+
+ public
+ setRefundAddressRequestPending ( bool $refundAddressRequestPending ) : void
+
+
+
+ Initially set to false when the invoice is created,
+this field will be set to true once a refund request has been issued by the merchant.
+This flag is here to indicate that the refund request is pending action
+from the buyer to provide an address for the refund,
+via the secure link which has been automatically emailed to him.
+
+
+ Parameters
+
+
+ $refundAddressRequestPending
+ : bool
+
+
+ This flag is here to indicate that the refund
+request is pending action
+
+
+
+
+
+
+
+
+
+
+
+ setRefundInfo()
+
+
+
+
+
+ Sets refundInfo
+
+
+ public
+ setRefundInfo ( RefundInfo $refundInfo ) : void
+
+
+
+ For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+
+
+ Parameters
+
+
+ $refundInfo
+ : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setSelectedTransactionCurrency()
+
+
+
+
+
+ Sets selectedTransactionCurrency
+
+
+ public
+ setSelectedTransactionCurrency ( string $selectedTransactionCurrency ) : void
+
+
+
+ This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+"USDC", "XRP", "DOGE", "DAI" and "WBTC".
+If not yet selected, this field will not be returned.
+
+
+ Parameters
+
+
+ $selectedTransactionCurrency
+ : string
+
+
+ This field will be populated with the cryptocurrency selected
+to pay the BitPay invoice
+
+
+
+
+
+
+
+
+
+
+
+ setShopper()
+
+
+
+
+
+ Sets shopper
+
+
+ public
+ setShopper ( Shopper $shopper ) : mixed
+
+
+
+ This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+
+
+ Parameters
+
+
+ $shopper
+ : Shopper
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://blog.bitpay.com/bitpay-dashboard-id
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets status
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportedTransactionCurrencies()
+
+
+
+
+
+ Sets supportedTransactionCurrencies
+
+
+ public
+ setSupportedTransactionCurrencies ( SupportedTransactionCurrencies $supportedTransactionCurrencies ) : void
+
+
+
+ The currencies that may be used to pay this invoice.
+The object is keyed by currency code.
+The values are objects with an "enabled" boolean and option.
+An extra "reason" parameter is added in the object if a cryptocurrency is disabled on a specific invoice.
+If you disable a currency via the invoice parameter "paymentCurrencies",
+this parameter will be set to "merchantDisabledByParam"
+
+
+ Parameters
+
+
+ $supportedTransactionCurrencies
+ : SupportedTransactionCurrencies
+
+
+ The currencies that may be used
+to pay this invoice
+
+
+
+
+
+
+
+
+
+
+
+ setTargetConfirmations()
+
+
+
+
+
+ Sets targetConfirmations
+
+
+ public
+ setTargetConfirmations ( int $targetConfirmations ) : void
+
+
+
+ Indicates the number of block confirmation of the crypto currency
+transaction which are required to credit a paid invoice to the merchant account.
+Currently, the value set is set to 6 by default for BTC/BCH/XRP,
+40 for DOGE and 50 for ETH/GUSD/PAX/USDC/BUSD/DAI/WBTC
+c
+
+
+ Parameters
+
+
+ $targetConfirmations
+ : int
+
+
+ Indicates the number of block confirmation of the crypto currency transaction
+which are required to credit a paid invoice to the merchant account
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets token
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+ Invoice resource token.
+This token is derived from the API token initially used to create the
+invoice and is tied to the specific resource id created.
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionCurrency()
+
+
+
+
+
+ Sets transactionCurrency
+
+
+ public
+ setTransactionCurrency ( string $transactionCurrency ) : void
+
+
+
+ The cryptocurrency used to pay the invoice.
+This field will only be available after a transaction is applied to the invoice.
+Possible values are currently "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+"USDC", "XRP", "DOGE", "DAI" and "WBTC".
+
+
+ Parameters
+
+
+ $transactionCurrency
+ : string
+
+
+ The currency used for the invoice transaction.
+
+
+
+
+
+
+
+
+
+
+
+ setTransactions()
+
+
+
+
+
+ Sets transactions
+
+
+ public
+ setTransactions ( array<string|int, mixed> $transactions ) : void
+
+
+
+ Contains the cryptocurrency transaction details for the executed payout.
+
+
+ Parameters
+
+
+ $transactions
+ : array<string|int, mixed>
+
+
+ array with the crypto currency transaction hashes linked to the invoice
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionSpeed()
+
+
+
+
+
+ Sets transactionSpeed.
+
+
+ public
+ setTransactionSpeed ( string $transactionSpeed ) : void
+
+
+
+ This is a risk mitigation parameter for the merchant to configure how they want
+to fulfill orders depending on the number of block confirmations for the transaction
+made by the consumer on the selected cryptocurrency.
+If not set on the invoice, transactionSpeed will default to the account-level Order Settings.
+Note : orders are only credited to your BitPay Account Summary for settlement after
+the invoice reaches the status "complete" (regardless of this setting).
+
+
+ Parameters
+
+
+ $transactionSpeed
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUnderpaidAmount()
+
+
+
+
+
+ Sets underpaidAmount
+
+
+ public
+ setUnderpaidAmount ( int $underpaidAmount ) : void
+
+
+
+ This parameter will be returned on the invoice object
+if the invoice was underpaid ("exceptionStatus": "paidPartial").
+It equals to the absolute difference between amountPaid
+and paymentTotals for the corresponding transactionCurrency used.
+
+
+ Parameters
+
+
+ $underpaidAmount
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUniversalCodes()
+
+
+
+
+
+ Sets universalCodes
+
+
+ public
+ setUniversalCodes ( UniversalCodes $universalCodes ) : mixed
+
+
+
+
+ Parameters
+
+
+ $universalCodes
+ : UniversalCodes
+
+
+ Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+
+
+
+
+
+ setUrl()
+
+
+
+
+
+ Sets url
+
+
+ public
+ setUrl ( string $url ) : void
+
+
+
+ Web address of invoice, expires at expirationTime
+
+
+ Parameters
+
+
+ $url
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Returns the Invoice object as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html b/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html
new file mode 100644
index 00000000..cc4de518
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html
@@ -0,0 +1,620 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type Invoice status.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ COMPLETE
+
+ = "complete"
+
+When an invoice has the status complete, it means that BitPay has credited the merchant account,
+in the currency indicated in the settlement settings. For instance, with invoices paid in Bitcoin (BTC),
+6 confirmation blocks on the bitcoin network are required for an invoice to be complete,
+this takes on average 1 hour.
+
+
+ CONFIRMED
+
+ = "confirmed"
+
+This status can be used by merchants in order to fulfill orders placed by the consumer.
+
+
+ EXPIRED
+
+ = "expired"
+
+An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.
+
+
+ INVALID
+
+ = "invalid"
+
+An invoice is considered invalid when it was paid,
+but the corresponding cryptocurrency transaction was not confirmed within 1 hour on the corresponding blockchain.
+
+
+ NEW
+
+ = "new"
+
+An invoice starts in this state. When in this state and only in this state, payments broadcasted by purchasers
+be applied to the invoice (there is a 15 minute window for the purchaser to send a payment from
+their crypto wallet). If an invoice has received a partial payment,
+it will still reflect a status of new to the merchant. From a merchant system perspective,
+an invoice is either paid or not paid, partial payments are automatically refunded by BitPay to the consumer.
+
+
+ PAID
+
+ = "paid"
+
+As soon as payment is received it is evaluated against the invoice requested amount.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ COMPLETE
+
+
+
+
+
+
+ When an invoice has the status complete, it means that BitPay has credited the merchant account,
+in the currency indicated in the settlement settings. For instance, with invoices paid in Bitcoin (BTC),
+6 confirmation blocks on the bitcoin network are required for an invoice to be complete,
+this takes on average 1 hour.
+
+
+ public
+ mixed
+ COMPLETE
+ = "complete"
+
+
+
+
+
+
+
+
+
+
+ CONFIRMED
+
+
+
+
+
+
+ This status can be used by merchants in order to fulfill orders placed by the consumer.
+
+
+ public
+ mixed
+ CONFIRMED
+ = "confirmed"
+
+
+
+ Merchants can configure the timing at which BitPay sets this specific invoice status,
+depending on the number of confirmation achieved by the consumer's transaction in the selected cryptocurrency.
+This can be configured during invoice creation using the "transactionSpeed" parameter
+(section Create an invoice), or at account level via a dashboard setting.
+
+
+
+
+
+
+
+
+ EXPIRED
+
+
+
+
+
+
+ An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.
+
+
+ public
+ mixed
+ EXPIRED
+ = "expired"
+
+
+
+
+
+
+
+
+
+
+ INVALID
+
+
+
+
+
+
+ An invoice is considered invalid when it was paid,
+but the corresponding cryptocurrency transaction was not confirmed within 1 hour on the corresponding blockchain.
+
+
+ public
+ mixed
+ INVALID
+ = "invalid"
+
+
+
+ It is possible that some transactions can take longer than 1 hour to be included in a block.
+If the transaction confirms after 1 hour, BitPay will update the invoice state from "invalid" to "complete"
+(6 confirmations for transactions on the bitcoin network for instance).
+
+
+
+
+
+
+
+
+ NEW
+
+
+
+
+
+
+ An invoice starts in this state. When in this state and only in this state, payments broadcasted by purchasers
+be applied to the invoice (there is a 15 minute window for the purchaser to send a payment from
+their crypto wallet). If an invoice has received a partial payment,
+it will still reflect a status of new to the merchant. From a merchant system perspective,
+an invoice is either paid or not paid, partial payments are automatically refunded by BitPay to the consumer.
+
+
+ public
+ mixed
+ NEW
+ = "new"
+
+
+
+
+
+
+
+
+
+
+ PAID
+
+
+
+
+
+
+ As soon as payment is received it is evaluated against the invoice requested amount.
+
+
+ public
+ mixed
+ PAID
+ = "paid"
+
+
+
+ If the amount paid is equal to or greater than the amount expected then the invoice is marked as being paid.
+To detect whether the invoice has been overpaid consult the invoice exception status (exceptionStatus parameter).
+The overpaid amount on an invoice is automatically refunded by BitPay to the consumer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html b/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html
new file mode 100644
index 00000000..e8fc88b8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html
@@ -0,0 +1,912 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemizedDetails
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class ItemizedDetails
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float|null
+
+
+
+ $description
+
+ : string|null
+
+
+
+ $isFee
+
+ : bool|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmount()
+
+ : float|null
+
+Gets The amount of currency.
+
+
+ getDescription()
+
+ : string|null
+
+Gets description
+
+
+ getIsFee()
+
+ : bool|null
+
+Gets is fee
+
+
+ setAmount()
+
+ : void
+
+Sets The amount of currency.
+
+
+ setDescription()
+
+ : void
+
+Sets string for the item.
+
+
+ setIsFee()
+
+ : void
+
+Sets is fee
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Item details data as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $description
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $description
+ = null
+
+
+
+
+
+
+
+
+ $isFee
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $isFee
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets The amount of currency.
+
+
+ public
+ getAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getDescription()
+
+
+
+
+
+ Gets description
+
+
+ public
+ getDescription ( ) : string|null
+
+
+
+ Display string for the item.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getIsFee()
+
+
+
+
+
+ Gets is fee
+
+
+ public
+ getIsFee ( ) : bool|null
+
+
+
+ Indicates whether or not the item is considered a fee/tax or part of the main purchase.
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets The amount of currency.
+
+
+ public
+ setAmount ( float|null $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDescription()
+
+
+
+
+
+ Sets string for the item.
+
+
+ public
+ setDescription ( string|null $description ) : void
+
+
+
+
+ Parameters
+
+
+ $description
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setIsFee()
+
+
+
+
+
+ Sets is fee
+
+
+ public
+ setIsFee ( bool|null $isFee ) : void
+
+
+
+ Gets Indicates whether or not the item is considered a fee/tax or part of the main purchase.
+
+
+ Parameters
+
+
+ $isFee
+ : bool|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Item details data as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ item details data as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html b/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html
new file mode 100644
index 00000000..bb6211d1
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html
@@ -0,0 +1,2116 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFees
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+
+ The key is the currency and the value is an object containing the satoshis per byte,
+the total fee, and the fiat amount. This is referenced as "Network Cost" on an invoice,
+see this support article for more information.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $bch
+
+ : MinerFeesItem
+
+
+
+ $btc
+
+ : MinerFeesItem
+
+
+
+ $busd
+
+ : MinerFeesItem
+
+
+
+ $dai
+
+ : MinerFeesItem
+
+
+
+ $doge
+
+ : MinerFeesItem
+
+
+
+ $eth
+
+ : MinerFeesItem
+
+
+
+ $gusd
+
+ : MinerFeesItem
+
+
+
+ $ltc
+
+ : MinerFeesItem
+
+
+
+ $pax
+
+ : MinerFeesItem
+
+
+
+ $usdc
+
+ : MinerFeesItem
+
+
+
+ $wbtc
+
+ : MinerFeesItem
+
+
+
+ $xrp
+
+ : MinerFeesItem
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+MinerFees constructor.
+
+
+ getBCH()
+
+ : MinerFeesItem
+
+Gets BCH.
+
+
+ getBTC()
+
+ : MinerFeesItem
+
+Gets BTC.
+
+
+ getBUSD()
+
+ : MinerFeesItem
+
+Gets BUSD.
+
+
+ getDAI()
+
+ : MinerFeesItem
+
+Gets DAI.
+
+
+ getDOGE()
+
+ : MinerFeesItem
+
+Gets DOGE.
+
+
+ getETH()
+
+ : MinerFeesItem
+
+Gets ETH.
+
+
+ getGUSD()
+
+ : MinerFeesItem
+
+Gets GUSD.
+
+
+ getLTC()
+
+ : MinerFeesItem
+
+Gets LTC.
+
+
+ getPAX()
+
+ : MinerFeesItem
+
+Gets PAX.
+
+
+ getUSDC()
+
+ : MinerFeesItem
+
+Gets USDC.
+
+
+ getWBTC()
+
+ : MinerFeesItem
+
+Gets WBTC.
+
+
+ getXRP()
+
+ : MinerFeesItem
+
+Gets XRP.
+
+
+ setBCH()
+
+ : void
+
+Sets BCH.
+
+
+ setBTC()
+
+ : void
+
+Sets BTC.
+
+
+ setBUSD()
+
+ : void
+
+Sets BUSD.
+
+
+ setDAI()
+
+ : void
+
+Sets DAI.
+
+
+ setDOGE()
+
+ : void
+
+Sets DOGE.
+
+
+ setETH()
+
+ : void
+
+Sets ETH.
+
+
+ setGUSD()
+
+ : void
+
+Sets GUSD.
+
+
+ setLTC()
+
+ : void
+
+Sets LTC.
+
+
+ setPAX()
+
+ : void
+
+Sets PAX.
+
+
+ setUSDC()
+
+ : void
+
+Sets USDC.
+
+
+ setWBTC()
+
+ : void
+
+Sets WBTC.
+
+
+ setXRP()
+
+ : void
+
+Sets XRP.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return array with details for currencies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $bch
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $bch
+
+
+
+
+
+
+
+
+
+ $btc
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $btc
+
+
+
+
+
+
+
+
+
+ $busd
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $busd
+
+
+
+
+
+
+
+
+
+ $dai
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $dai
+
+
+
+
+
+
+
+
+
+ $doge
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $doge
+
+
+
+
+
+
+
+
+
+ $eth
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $eth
+
+
+
+
+
+
+
+
+
+ $gusd
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $gusd
+
+
+
+
+
+
+
+
+
+ $ltc
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $ltc
+
+
+
+
+
+
+
+
+
+ $pax
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $pax
+
+
+
+
+
+
+
+
+
+ $usdc
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $usdc
+
+
+
+
+
+
+
+
+
+ $wbtc
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $wbtc
+
+
+
+
+
+
+
+
+
+ $xrp
+
+
+
+
+
+
+
+
+
+ protected
+ MinerFeesItem
+ $xrp
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ MinerFees constructor.
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getBCH()
+
+
+
+
+
+ Gets BCH.
+
+
+ public
+ getBCH ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getBTC()
+
+
+
+
+
+ Gets BTC.
+
+
+ public
+ getBTC ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getBUSD()
+
+
+
+
+
+ Gets BUSD.
+
+
+ public
+ getBUSD ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getDAI()
+
+
+
+
+
+ Gets DAI.
+
+
+ public
+ getDAI ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getDOGE()
+
+
+
+
+
+ Gets DOGE.
+
+
+ public
+ getDOGE ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getETH()
+
+
+
+
+
+ Gets ETH.
+
+
+ public
+ getETH ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getGUSD()
+
+
+
+
+
+ Gets GUSD.
+
+
+ public
+ getGUSD ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getLTC()
+
+
+
+
+
+ Gets LTC.
+
+
+ public
+ getLTC ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getPAX()
+
+
+
+
+
+ Gets PAX.
+
+
+ public
+ getPAX ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getUSDC()
+
+
+
+
+
+ Gets USDC.
+
+
+ public
+ getUSDC ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getWBTC()
+
+
+
+
+
+ Gets WBTC.
+
+
+ public
+ getWBTC ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ getXRP()
+
+
+
+
+
+ Gets XRP.
+
+
+ public
+ getXRP ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ setBCH()
+
+
+
+
+
+ Sets BCH.
+
+
+ public
+ setBCH ( MinerFeesItem $bch ) : void
+
+
+
+
+ Parameters
+
+
+ $bch
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBTC()
+
+
+
+
+
+ Sets BTC.
+
+
+ public
+ setBTC ( MinerFeesItem $btc ) : void
+
+
+
+
+ Parameters
+
+
+ $btc
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBUSD()
+
+
+
+
+
+ Sets BUSD.
+
+
+ public
+ setBUSD ( MinerFeesItem $busd ) : void
+
+
+
+
+ Parameters
+
+
+ $busd
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDAI()
+
+
+
+
+
+ Sets DAI.
+
+
+ public
+ setDAI ( MinerFeesItem $dai ) : void
+
+
+
+
+ Parameters
+
+
+ $dai
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ setDOGE()
+
+
+
+
+
+ Sets DOGE.
+
+
+ public
+ setDOGE ( MinerFeesItem $doge ) : void
+
+
+
+
+ Parameters
+
+
+ $doge
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setETH()
+
+
+
+
+
+ Sets ETH.
+
+
+ public
+ setETH ( MinerFeesItem $eth ) : void
+
+
+
+
+ Parameters
+
+
+ $eth
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setGUSD()
+
+
+
+
+
+ Sets GUSD.
+
+
+ public
+ setGUSD ( MinerFeesItem $gusd ) : void
+
+
+
+
+ Parameters
+
+
+ $gusd
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setLTC()
+
+
+
+
+
+ Sets LTC.
+
+
+ public
+ setLTC ( MinerFeesItem $ltc ) : void
+
+
+
+
+ Parameters
+
+
+ $ltc
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPAX()
+
+
+
+
+
+ Sets PAX.
+
+
+ public
+ setPAX ( MinerFeesItem $pax ) : void
+
+
+
+
+ Parameters
+
+
+ $pax
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setUSDC()
+
+
+
+
+
+ Sets USDC.
+
+
+ public
+ setUSDC ( MinerFeesItem $usdc ) : void
+
+
+
+
+ Parameters
+
+
+ $usdc
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setWBTC()
+
+
+
+
+
+ Sets WBTC.
+
+
+ public
+ setWBTC ( MinerFeesItem $wbtc ) : void
+
+
+
+
+ Parameters
+
+
+ $wbtc
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+ setXRP()
+
+
+
+
+
+ Sets XRP.
+
+
+ public
+ setXRP ( MinerFeesItem $xrp ) : void
+
+
+
+
+ Parameters
+
+
+ $xrp
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return array with details for currencies.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html
new file mode 100644
index 00000000..62eaf9d0
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html
@@ -0,0 +1,870 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class MinerFeesItem
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $fiatAmount
+
+ : float|null
+
+
+
+ $satoshisPerByte
+
+ : float|null
+
+
+
+ $totalFee
+
+ : float|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getFiatAmount()
+
+ : float|null
+
+
+
+ getSatoshisPerByte()
+
+ : float|null
+
+
+
+ getTotalFee()
+
+ : float|null
+
+
+
+ setFiatAmount()
+
+ : void
+
+
+
+ setSatoshisPerByte()
+
+ : void
+
+
+
+ setTotalFee()
+
+ : void
+
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $fiatAmount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $fiatAmount
+ = null
+
+
+
+
+
+
+
+
+ $satoshisPerByte
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $satoshisPerByte
+ = null
+
+
+
+
+
+
+
+
+ $totalFee
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $totalFee
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getFiatAmount()
+
+
+
+
+
+
+
+ public
+ getFiatAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getSatoshisPerByte()
+
+
+
+
+
+
+
+ public
+ getSatoshisPerByte ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getTotalFee()
+
+
+
+
+
+
+
+ public
+ getTotalFee ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ setFiatAmount()
+
+
+
+
+
+
+
+ public
+ setFiatAmount ( float|null $fiatAmount ) : void
+
+
+
+
+ Parameters
+
+
+ $fiatAmount
+ : float|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setSatoshisPerByte()
+
+
+
+
+
+
+
+ public
+ setSatoshisPerByte ( float $satoshisPerByte ) : void
+
+
+
+
+ Parameters
+
+
+ $satoshisPerByte
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setTotalFee()
+
+
+
+
+
+
+
+ public
+ setTotalFee ( float $totalFee ) : void
+
+
+
+
+ Parameters
+
+
+ $totalFee
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-Refund.html b/docs/classes/BitPaySDK-Model-Invoice-Refund.html
new file mode 100644
index 00000000..210c9c79
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-Refund.html
@@ -0,0 +1,3627 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class Refund
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float
+
+
+
+ $buyerPaysRefundFee
+
+ : bool|null
+
+
+
+ $currency
+
+ : string
+
+
+
+ $guid
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $immediate
+
+ : bool|null
+
+
+
+ $invoice
+
+ : string|null
+
+
+
+ $invoiceId
+
+ : string|null
+
+
+
+ $lastRefundNotification
+
+ : string|null
+
+
+
+ $notificationURL
+
+ : string|null
+
+
+
+ $preview
+
+ : bool|null
+
+
+
+ $reference
+
+ : string|null
+
+
+
+ $refundAddress
+
+ : string|null
+
+
+
+ $refundFee
+
+ : float|null
+
+
+
+ $requestDate
+
+ : string|null
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $supportRequest
+
+ : string|null
+
+
+
+ $token
+
+ : string
+
+
+
+ $transactionAmount
+
+ : float|null
+
+
+
+ $transactionCurrency
+
+ : string|null
+
+
+
+ $transactionRefundFee
+
+ : float|null
+
+
+
+ $txid
+
+ : string|null
+
+
+
+ $type
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create Refund object
+
+
+ getAmount()
+
+ : float
+
+Gets amount to be refunded in the invoice currency
+
+
+ getBuyerPaysRefundFee()
+
+ : bool|null
+
+Gets whether the buyer should pay the refund fee rather
+than the merchant
+
+
+ getCurrency()
+
+ : string
+
+Gets reference currency used for the refund, the same as the currency used to create the invoice
+
+
+ getGuid()
+
+ : string|null
+
+Gets a passthru variable provided by the merchant and designed to be used by the merchant to correlate
+the invoice with an order ID in their system
+
+
+ getId()
+
+ : string|null
+
+Gets the ID of the refund
+
+
+ getImmediate()
+
+ : bool|null
+
+Gets whether the funds should be removed from merchant ledger immediately
+on submission or at the time of processing
+
+
+ getInvoice()
+
+ : string|null
+
+Gets the ID of the invoice being refunded
+
+
+ getInvoiceId()
+
+ : string|null
+
+Gets the ID of the invoice to refund
+
+
+ getLastRefundNotification()
+
+ : string|null
+
+Gets the last time notification of buyer was attempted
+
+
+ getNotificationURL()
+
+ : string|null
+
+Gets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+ getPreview()
+
+ : bool|null
+
+Whether to create the refund request as a preview
+
+
+ getReference()
+
+ : string|null
+
+Present only if specified in the request to create the refund. This is your reference label for this refund.
+
+
+ getRefundAddress()
+
+ : string|null
+
+Gets the wallet address that the refund will return the funds to, added by the customer.
+
+
+ getRefundFee()
+
+ : float|null
+
+Gets the amount of refund fee expressed in terms of pricing currency
+
+
+ getRequestDate()
+
+ : string|null
+
+Gets the date the refund was requested
+
+
+ getStatus()
+
+ : string|null
+
+Gets the refund lifecycle status of the request
+
+
+ getSupportRequest()
+
+ : string|null
+
+Gets the ID of the associated support request for the refund.
+
+
+ getToken()
+
+ : string
+
+Gets API token
+
+
+ getTransactionAmount()
+
+ : float|null
+
+Gets amount to be refunded in terms of the transaction currency.
+
+
+ getTransactionCurrency()
+
+ : string|null
+
+Gets the currency used for the invoice transaction.
+
+
+ getTransactionRefundFee()
+
+ : float|null
+
+Gets the refund fee expressed in terms of transaction currency.
+
+
+ getTxid()
+
+ : string|null
+
+Gets the transaction ID of the refund once executed.
+
+
+ getType()
+
+ : string|null
+
+<p>Gets the type of refund.</p>
+<ul>
+ <li>full (current rate): A full refund of the amount paid at the current rate.</li>
+ <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
+
+
+ setAmount()
+
+ : void
+
+Sets amount to be refunded
+
+
+ setBuyerPaysRefundFee()
+
+ : void
+
+Sets whether the buyer should pay the refund fee rather
+
+
+ setCurrency()
+
+ : void
+
+Sets currency used for the refund
+
+
+ setGuid()
+
+ : void
+
+Sets guid
+
+
+ setId()
+
+ : void
+
+Sets id of the refund
+
+
+ setImmediate()
+
+ : void
+
+Sets immediate value
+
+
+ setInvoice()
+
+ : void
+
+Sets the id of the invoice being refunded
+
+
+ setInvoiceId()
+
+ : void
+
+Sets invoice id
+
+
+ setLastRefundNotification()
+
+ : void
+
+Sets last refund notification
+
+
+ setNotificationURL()
+
+ : void
+
+Sets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+ setPreview()
+
+ : void
+
+Sets preview
+
+
+ setReference()
+
+ : void
+
+Sets reference label for refund
+
+
+ setRefundAddress()
+
+ : void
+
+Sets the wallet address that the refund will return the funds to, added by the customer.
+
+
+ setRefundFee()
+
+ : void
+
+Sets amount of the refund fee
+
+
+ setRequestDate()
+
+ : void
+
+Sets request date
+
+
+ setStatus()
+
+ : void
+
+Sets refund status
+
+
+ setSupportRequest()
+
+ : void
+
+Sets the ID of the associated support request for the refund.
+
+
+ setToken()
+
+ : void
+
+Sets API token
+
+
+ setTransactionAmount()
+
+ : void
+
+Sets amount to be refunded in terms of the transaction currency.
+
+
+ setTransactionCurrency()
+
+ : void
+
+Sets the currency used for the invoice transaction.
+
+
+ setTransactionRefundFee()
+
+ : void
+
+Sets the refund fee expressed in terms of transaction currency.
+
+
+ setTxid()
+
+ : void
+
+Sets the transaction ID of the refund once executed.
+
+
+ setType()
+
+ : void
+
+<p>Sets the type of refund.</p>
+<ul>
+ <li>full (current rate): A full refund of the amount paid at the current rate.</li>
+ <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return Refund values as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float
+ $amount
+
+
+
+
+
+
+
+
+
+ $buyerPaysRefundFee
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $buyerPaysRefundFee
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $currency
+
+
+
+
+
+
+
+
+
+ $guid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $guid
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $immediate
+ = null
+
+
+
+
+
+
+
+
+ $invoice
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $invoice
+ = null
+
+
+
+
+
+
+
+
+ $invoiceId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $invoiceId
+ = null
+
+
+
+
+
+
+
+
+ $lastRefundNotification
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $lastRefundNotification
+ = null
+
+
+
+
+
+
+
+
+ $notificationURL
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $notificationURL
+ = null
+
+
+
+
+
+
+
+
+ $preview
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $preview
+ = null
+
+
+
+
+
+
+
+
+ $reference
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $reference
+ = null
+
+
+
+
+
+
+
+
+ $refundAddress
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $refundAddress
+ = null
+
+
+
+
+
+
+
+
+ $refundFee
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $refundFee
+ = null
+
+
+
+
+
+
+
+
+ $requestDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $requestDate
+ = null
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $supportRequest
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $supportRequest
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $token
+
+
+
+
+
+
+
+
+
+ $transactionAmount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $transactionAmount
+ = null
+
+
+
+
+
+
+
+
+ $transactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $transactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $transactionRefundFee
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $transactionRefundFee
+ = null
+
+
+
+
+
+
+
+
+ $txid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $txid
+ = null
+
+
+
+
+
+
+
+
+ $type
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $type
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create Refund object
+
+
+ public
+ __construct ( [ float $amount = 0.0 ] [ , string $currency = "" ] [ , string $token = "" ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float
+ = 0.0
+
+
+
+
+ $currency
+ : string
+ = ""
+
+
+
+
+ $token
+ : string
+ = ""
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets amount to be refunded in the invoice currency
+
+
+ public
+ getAmount ( ) : float
+
+
+
+
+
+
+
+
+ Return values
+ float
+
+
+
+
+
+ getBuyerPaysRefundFee()
+
+
+
+
+
+ Gets whether the buyer should pay the refund fee rather
+than the merchant
+
+
+ public
+ getBuyerPaysRefundFee ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets reference currency used for the refund, the same as the currency used to create the invoice
+
+
+ public
+ getCurrency ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getGuid()
+
+
+
+
+
+ Gets a passthru variable provided by the merchant and designed to be used by the merchant to correlate
+the invoice with an order ID in their system
+
+
+ public
+ getGuid ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets the ID of the refund
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+
+
+ Gets whether the funds should be removed from merchant ledger immediately
+on submission or at the time of processing
+
+
+ public
+ getImmediate ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getInvoice()
+
+
+
+
+
+ Gets the ID of the invoice being refunded
+
+
+ public
+ getInvoice ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getInvoiceId()
+
+
+
+
+
+ Gets the ID of the invoice to refund
+
+
+ public
+ getInvoiceId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getLastRefundNotification()
+
+
+
+
+
+ Gets the last time notification of buyer was attempted
+
+
+ public
+ getLastRefundNotification ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getNotificationURL()
+
+
+
+
+
+ Gets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+ public
+ getNotificationURL ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getPreview()
+
+
+
+
+
+ Whether to create the refund request as a preview
+
+
+ public
+ getPreview ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getReference()
+
+
+
+
+
+ Present only if specified in the request to create the refund. This is your reference label for this refund.
+
+
+ public
+ getReference ( ) : string|null
+
+
+
+ It will be passed-through on each response for you to identify the refund in your system.
+Maximum string length is 100 characters
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getRefundAddress()
+
+
+
+
+
+ Gets the wallet address that the refund will return the funds to, added by the customer.
+
+
+ public
+ getRefundAddress ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getRefundFee()
+
+
+
+
+
+ Gets the amount of refund fee expressed in terms of pricing currency
+
+
+ public
+ getRefundFee ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getRequestDate()
+
+
+
+
+
+ Gets the date the refund was requested
+
+
+ public
+ getRequestDate ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets the refund lifecycle status of the request
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getSupportRequest()
+
+
+
+
+
+ Gets the ID of the associated support request for the refund.
+
+
+ public
+ getSupportRequest ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets API token
+
+
+ public
+ getToken ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getTransactionAmount()
+
+
+
+
+
+ Gets amount to be refunded in terms of the transaction currency.
+
+
+ public
+ getTransactionAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getTransactionCurrency()
+
+
+
+
+
+ Gets the currency used for the invoice transaction.
+
+
+ public
+ getTransactionCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getTransactionRefundFee()
+
+
+
+
+
+ Gets the refund fee expressed in terms of transaction currency.
+
+
+ public
+ getTransactionRefundFee ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getTxid()
+
+
+
+
+
+ Gets the transaction ID of the refund once executed.
+
+
+ public
+ getTxid ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getType()
+
+
+
+
+
+ <p>Gets the type of refund.</p>
+<ul>
+ <li>full (current rate): A full refund of the amount paid at the current rate.</li>
+ <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
+
+
+ public
+ getType ( ) : string|null
+
+
+
+ Note: deprecated refund implementation only.
+ partial: Part of the invoice is being refunded, rather than the full invoie amount.
+ underpayment: The payment was underpaid, a refund in the amount paid will be executed.
+ overpayment: The payment was overpaid, a refund in the amount that was overpaid from the invoice price
+ will be executed.
+ declined: The payment was declined, a refund in the full amount paid will be excuted.
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets amount to be refunded
+
+
+ public
+ setAmount ( float $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerPaysRefundFee()
+
+
+
+
+
+ Sets whether the buyer should pay the refund fee rather
+
+
+ public
+ setBuyerPaysRefundFee ( bool $buyerPaysRefundFee ) : void
+
+
+
+
+ Parameters
+
+
+ $buyerPaysRefundFee
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency used for the refund
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setGuid()
+
+
+
+
+
+ Sets guid
+
+
+ public
+ setGuid ( string $guid ) : void
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets id of the refund
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets immediate value
+
+
+ public
+ setImmediate ( bool $immediate ) : void
+
+
+
+
+ Parameters
+
+
+ $immediate
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoice()
+
+
+
+
+
+ Sets the id of the invoice being refunded
+
+
+ public
+ setInvoice ( string $invoice ) : void
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceId()
+
+
+
+
+
+ Sets invoice id
+
+
+ public
+ setInvoiceId ( string $invoiceId ) : void
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setLastRefundNotification()
+
+
+
+
+
+ Sets last refund notification
+
+
+ public
+ setLastRefundNotification ( string $lastRefundNotification ) : void
+
+
+
+
+ Parameters
+
+
+ $lastRefundNotification
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationURL()
+
+
+
+
+
+ Sets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+ public
+ setNotificationURL ( string|null $notificationURL ) : void
+
+
+
+
+ Parameters
+
+
+ $notificationURL
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setPreview()
+
+
+
+
+
+ Sets preview
+
+
+ public
+ setPreview ( bool $preview ) : void
+
+
+
+
+ Parameters
+
+
+ $preview
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setReference()
+
+
+
+
+
+ Sets reference label for refund
+
+
+ public
+ setReference ( string $reference ) : void
+
+
+
+
+ Parameters
+
+
+ $reference
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setRefundAddress()
+
+
+
+
+
+ Sets the wallet address that the refund will return the funds to, added by the customer.
+
+
+ public
+ setRefundAddress ( string|null $refundAddress ) : void
+
+
+
+
+ Parameters
+
+
+ $refundAddress
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setRefundFee()
+
+
+
+
+
+ Sets amount of the refund fee
+
+
+ public
+ setRefundFee ( float $refundFee ) : void
+
+
+
+
+ Parameters
+
+
+ $refundFee
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setRequestDate()
+
+
+
+
+
+ Sets request date
+
+
+ public
+ setRequestDate ( string $requestDate ) : void
+
+
+
+
+ Parameters
+
+
+ $requestDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets refund status
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportRequest()
+
+
+
+
+
+ Sets the ID of the associated support request for the refund.
+
+
+ public
+ setSupportRequest ( string|null $supportRequest ) : void
+
+
+
+
+ Parameters
+
+
+ $supportRequest
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets API token
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionAmount()
+
+
+
+
+
+ Sets amount to be refunded in terms of the transaction currency.
+
+
+ public
+ setTransactionAmount ( float|null $transactionAmount ) : void
+
+
+
+
+ Parameters
+
+
+ $transactionAmount
+ : float|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionCurrency()
+
+
+
+
+
+ Sets the currency used for the invoice transaction.
+
+
+ public
+ setTransactionCurrency ( string|null $transactionCurrency ) : void
+
+
+
+
+ Parameters
+
+
+ $transactionCurrency
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionRefundFee()
+
+
+
+
+
+ Sets the refund fee expressed in terms of transaction currency.
+
+
+ public
+ setTransactionRefundFee ( float|null $transactionRefundFee ) : void
+
+
+
+
+ Parameters
+
+
+ $transactionRefundFee
+ : float|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setTxid()
+
+
+
+
+
+ Sets the transaction ID of the refund once executed.
+
+
+ public
+ setTxid ( string|null $txid ) : void
+
+
+
+
+ Parameters
+
+
+ $txid
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setType()
+
+
+
+
+
+ <p>Sets the type of refund.</p>
+<ul>
+ <li>full (current rate): A full refund of the amount paid at the current rate.</li>
+ <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
+
+
+ public
+ setType ( string|null $type ) : void
+
+
+
+ Note: deprecated refund implementation only.
+ partial: Part of the invoice is being refunded, rather than the full invoie amount.
+ underpayment: The payment was underpaid, a refund in the amount paid will be executed.
+ overpayment: The payment was overpaid, a refund in the amount that was overpaid from the invoice price
+ will be executed.
+ declined: The payment was declined, a refund in the full amount paid will be excuted.
+
+
+
+ Parameters
+
+
+ $type
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return Refund values as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html b/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html
new file mode 100644
index 00000000..4e72ed41
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html
@@ -0,0 +1,926 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amounts
+
+ : array<string|int, mixed>|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $supportRequest
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmounts()
+
+ : array<string|int, mixed>|null
+
+Gets amounts
+
+
+ getCurrency()
+
+ : string|null
+
+Gets currency
+
+
+ getSupportRequest()
+
+ : string|null
+
+Gets support request
+
+
+ setAmounts()
+
+ : void
+
+Set amounts
+
+
+ setCurrency()
+
+ : void
+
+Sets currency
+
+
+ setSupportRequest()
+
+ : void
+
+Sets support request
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Refund info as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amounts
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $amounts
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $supportRequest
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $supportRequest
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmounts()
+
+
+
+
+
+ Gets amounts
+
+
+ public
+ getAmounts ( ) : array<string|int, mixed>|null
+
+
+
+ For a refunded invoice, this object will contain the crypto currency amount
+refunded by BitPay to the consumer (in the selected transactionCurrency)
+and the equivalent refunded amount from the invoice in the given currency
+(thus linked to the amount debited from the merchant account to cover the refund)
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+ —
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+ For a refunded invoice, this field will contain the base currency selected for the refund.
+Typically the same as the invoice currency.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSupportRequest()
+
+
+
+
+
+ Gets support request
+
+
+ public
+ getSupportRequest ( ) : string|null
+
+
+
+ For a refunded invoice, this field will contain the refund requestId once executed.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAmounts()
+
+
+
+
+
+ Set amounts
+
+
+ public
+ setAmounts ( array<string|int, mixed> $amounts ) : void
+
+
+
+ For a refunded invoice, this object will contain the crypto currency amount
+refunded by BitPay to the consumer (in the selected transactionCurrency)
+and the equivalent refunded amount from the invoice in the given currency
+(thus linked to the amount debited from the merchant account to cover the refund)
+
+
+ Parameters
+
+
+ $amounts
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+ For a refunded invoice, this field will contain the base currency selected for the refund.
+Typically the same as the invoice currency.
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportRequest()
+
+
+
+
+
+ Sets support request
+
+
+ public
+ setSupportRequest ( string $supportRequest ) : void
+
+
+
+ For a refunded invoice, this field will contain the refund requestId once executed.
+
+
+ Parameters
+
+
+ $supportRequest
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Refund info as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html b/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html
new file mode 100644
index 00000000..9db663b4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html
@@ -0,0 +1,593 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund status list
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ CANCELLED
+
+ = "cancelled"
+
+Refund was canceled by merchant action. Immediate refunds cannot be canceled outside of preview state
+
+
+ CREATED
+
+ = "created"
+
+Funds deducted/allocated if immediate, will proceed when transactions are confirmed
+and the required data is collected
+
+
+ FAILURE
+
+ = "failure"
+
+Refund failed during processing (this is really more of an internal state)
+
+
+ PENDING
+
+ = "pending"
+
+Refund is in process of being fulfilled
+
+
+ PREVIEW
+
+ = "preview"
+
+No funds deducted, refund will not proceed automatically
+
+
+ SUCCESS
+
+ = "success"
+
+Refund was successfully processed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CANCELLED
+
+
+
+
+
+
+ Refund was canceled by merchant action. Immediate refunds cannot be canceled outside of preview state
+
+
+ public
+ mixed
+ CANCELLED
+ = "cancelled"
+
+
+
+
+
+
+
+
+
+
+ CREATED
+
+
+
+
+
+
+ Funds deducted/allocated if immediate, will proceed when transactions are confirmed
+and the required data is collected
+
+
+ public
+ mixed
+ CREATED
+ = "created"
+
+
+
+
+
+
+
+
+
+
+ FAILURE
+
+
+
+
+
+
+ Refund failed during processing (this is really more of an internal state)
+
+
+ public
+ mixed
+ FAILURE
+ = "failure"
+
+
+
+
+
+
+
+
+
+
+ PENDING
+
+
+
+
+
+
+ Refund is in process of being fulfilled
+
+
+ public
+ mixed
+ PENDING
+ = "pending"
+
+
+
+
+
+
+
+
+
+
+ PREVIEW
+
+
+
+
+
+
+ No funds deducted, refund will not proceed automatically
+
+
+ public
+ mixed
+ PREVIEW
+ = "preview"
+
+
+
+
+
+
+
+
+
+
+ SUCCESS
+
+
+
+
+
+
+ Refund was successfully processed
+
+
+ public
+ mixed
+ SUCCESS
+ = "success"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html b/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html
new file mode 100644
index 00000000..3fcfd377
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html
@@ -0,0 +1,1910 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundWebhook
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class RefundWebhook
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/refunds-1
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float
+
+
+
+ $buyerPaysRefundFee
+
+ : bool
+
+
+
+ $currency
+
+ : string
+
+
+
+ $id
+
+ : string
+
+
+
+ $immediate
+
+ : bool
+
+
+
+ $invoice
+
+ : string
+
+
+
+ $lastRefundNotification
+
+ : string
+
+
+
+ $refundFee
+
+ : float
+
+
+
+ $requestDate
+
+ : string
+
+
+
+ $status
+
+ : string
+
+
+
+ $supportRequest
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmount()
+
+ : float
+
+
+
+ getBuyerPaysRefundFee()
+
+ : bool
+
+
+
+ getCurrency()
+
+ : string
+
+
+
+ getId()
+
+ : string
+
+
+
+ getImmediate()
+
+ : bool
+
+
+
+ getInvoice()
+
+ : string
+
+
+
+ getLastRefundNotification()
+
+ : string
+
+
+
+ getRefundFee()
+
+ : float
+
+
+
+ getRequestDate()
+
+ : string
+
+
+
+ getStatus()
+
+ : string
+
+
+
+ getSupportRequest()
+
+ : string
+
+
+
+ setAmount()
+
+ : void
+
+
+
+ setBuyerPaysRefundFee()
+
+ : void
+
+
+
+ setCurrency()
+
+ : void
+
+
+
+ setId()
+
+ : void
+
+
+
+ setImmediate()
+
+ : void
+
+
+
+ setInvoice()
+
+ : void
+
+
+
+ setLastRefundNotification()
+
+ : void
+
+
+
+ setRefundFee()
+
+ : void
+
+
+
+ setRequestDate()
+
+ : void
+
+
+
+ setStatus()
+
+ : void
+
+
+
+ setSupportRequest()
+
+ : void
+
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float
+ $amount
+
+
+
+
+
+
+
+
+
+ $buyerPaysRefundFee
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $buyerPaysRefundFee
+
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $currency
+
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $id
+
+
+
+
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $immediate
+
+
+
+
+
+
+
+
+
+ $invoice
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $invoice
+
+
+
+
+
+
+
+
+
+ $lastRefundNotification
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $lastRefundNotification
+
+
+
+
+
+
+
+
+
+ $refundFee
+
+
+
+
+
+
+
+
+
+ protected
+ float
+ $refundFee
+
+
+
+
+
+
+
+
+
+ $requestDate
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $requestDate
+
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $status
+
+
+
+
+
+
+
+
+
+ $supportRequest
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $supportRequest
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+
+
+ public
+ getAmount ( ) : float
+
+
+
+
+
+
+
+
+ Return values
+ float
+
+
+
+
+
+ getBuyerPaysRefundFee()
+
+
+
+
+
+
+
+ public
+ getBuyerPaysRefundFee ( ) : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+
+
+ public
+ getCurrency ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getId()
+
+
+
+
+
+
+
+ public
+ getId ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+
+
+
+
+ public
+ getImmediate ( ) : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ getInvoice()
+
+
+
+
+
+
+
+ public
+ getInvoice ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getLastRefundNotification()
+
+
+
+
+
+
+
+ public
+ getLastRefundNotification ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getRefundFee()
+
+
+
+
+
+
+
+ public
+ getRefundFee ( ) : float
+
+
+
+
+
+
+
+
+ Return values
+ float
+
+
+
+
+
+ getRequestDate()
+
+
+
+
+
+
+
+ public
+ getRequestDate ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+
+
+ public
+ getStatus ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getSupportRequest()
+
+
+
+
+
+
+
+ public
+ getSupportRequest ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+
+
+ public
+ setAmount ( float $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerPaysRefundFee()
+
+
+
+
+
+
+
+ public
+ setBuyerPaysRefundFee ( bool $buyerPaysRefundFee ) : void
+
+
+
+
+ Parameters
+
+
+ $buyerPaysRefundFee
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ setImmediate ( bool $immediate ) : void
+
+
+
+
+ Parameters
+
+
+ $immediate
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoice()
+
+
+
+
+
+
+
+ public
+ setInvoice ( string $invoice ) : void
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setLastRefundNotification()
+
+
+
+
+
+
+
+ public
+ setLastRefundNotification ( string $lastRefundNotification ) : void
+
+
+
+
+ Parameters
+
+
+ $lastRefundNotification
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setRefundFee()
+
+
+
+
+
+
+
+ public
+ setRefundFee ( float $refundFee ) : void
+
+
+
+
+ Parameters
+
+
+ $refundFee
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setRequestDate()
+
+
+
+
+
+
+
+ public
+ setRequestDate ( string $requestDate ) : void
+
+
+
+
+ Parameters
+
+
+ $requestDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportRequest()
+
+
+
+
+
+
+
+ public
+ setSupportRequest ( string $supportRequest ) : void
+
+
+
+
+ Parameters
+
+
+ $supportRequest
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-Shopper.html b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html
new file mode 100644
index 00000000..768f45b7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html
@@ -0,0 +1,634 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Shopper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+
+ See the following blogpost for more information.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $user
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getUser()
+
+ : string|null
+
+Gets user
+
+
+ setUser()
+
+ : void
+
+Sets user
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Shopper as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $user
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $user
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getUser()
+
+
+
+
+
+ Gets user
+
+
+ public
+ getUser ( ) : string|null
+
+
+
+ If a shopper signs in on the invoice using his BitPay ID,
+this field will contain the unique ID assigned by BitPay to this shopper.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setUser()
+
+
+
+
+
+ Sets user
+
+
+ public
+ setUser ( string $user ) : void
+
+
+
+ If a shopper signs in on the invoice using his BitPay ID,
+this field will contain the unique ID assigned by BitPay to this shopper.
+
+
+ Parameters
+
+
+ $user
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Shopper as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html
new file mode 100644
index 00000000..36a04fd5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html
@@ -0,0 +1,1972 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html
new file mode 100644
index 00000000..73e973b0
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html
@@ -0,0 +1,759 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrency
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class SupportedTransactionCurrency
+The currency that may be used to pay this invoice. The values are objects with an "enabled" boolean and option.
+
+ An extra "reason" parameter is added in the object if a cryptocurrency is disabled on a specific invoice.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $enabled
+
+ : bool|null
+
+
+
+ $reason
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+SupportedTransactionCurrency constructor.
+
+
+ getEnabled()
+
+ : bool|null
+
+Sets enabled.
+
+
+ getReason()
+
+ : string|null
+
+Sets reason.
+
+
+ setEnabled()
+
+ : void
+
+Gets enabled.
+
+
+ setReason()
+
+ : void
+
+Gets reason.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return array with enabled and reason value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $enabled
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $enabled
+ = null
+
+
+
+
+
+
+
+
+ $reason
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $reason
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ SupportedTransactionCurrency constructor.
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getEnabled()
+
+
+
+
+
+ Sets enabled.
+
+
+ public
+ getEnabled ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+
+
+
+
+
+ getReason()
+
+
+
+
+
+ Sets reason.
+
+
+ public
+ getReason ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setEnabled()
+
+
+
+
+
+ Gets enabled.
+
+
+ public
+ setEnabled ( bool $enabled ) : void
+
+
+
+
+ Parameters
+
+
+ $enabled
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setReason()
+
+
+
+
+
+ Gets reason.
+
+
+ public
+ setReason ( string $reason ) : void
+
+
+
+
+ Parameters
+
+
+ $reason
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return array with enabled and reason value.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html b/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html
new file mode 100644
index 00000000..1efd3677
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html
@@ -0,0 +1,770 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UniversalCodes
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/invoices
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $paymentString
+
+ : string|null
+
+
+
+ $verificationLink
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getPaymentString()
+
+ : string|null
+
+Gets payment string
+
+
+ getVerificationLink()
+
+ : string|null
+
+Gets verification link
+
+
+ setPaymentString()
+
+ : void
+
+Sets payment string
+
+
+ setVerificationLink()
+
+ : void
+
+Sets verification link
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Universal codes as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $paymentString
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $paymentString
+ = null
+
+
+
+
+
+
+
+
+ $verificationLink
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $verificationLink
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getPaymentString()
+
+
+
+
+
+ Gets payment string
+
+
+ public
+ getPaymentString ( ) : string|null
+
+
+
+ Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getVerificationLink()
+
+
+
+
+
+ Gets verification link
+
+
+ public
+ getVerificationLink ( ) : string|null
+
+
+
+ Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setPaymentString()
+
+
+
+
+
+ Sets payment string
+
+
+ public
+ setPaymentString ( string $paymentString ) : void
+
+
+
+ Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.
+
+
+ Parameters
+
+
+ $paymentString
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setVerificationLink()
+
+
+
+
+
+ Sets verification link
+
+
+ public
+ setVerificationLink ( string $verificationLink ) : void
+
+
+
+ Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.
+
+
+ Parameters
+
+
+ $verificationLink
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Universal codes as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ universal codes as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Ledger-Buyer.html b/docs/classes/BitPaySDK-Model-Ledger-Buyer.html
new file mode 100644
index 00000000..cbdb29cb
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Ledger-Buyer.html
@@ -0,0 +1,1885 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/ledgers
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $address1
+
+ : string|null
+
+
+
+ $address2
+
+ : string|null
+
+
+
+ $city
+
+ : string|null
+
+
+
+ $country
+
+ : string|null
+
+
+
+ $email
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $notify
+
+ : bool|null
+
+
+
+ $phone
+
+ : string|null
+
+
+
+ $state
+
+ : string|null
+
+
+
+ $zip
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAddress1()
+
+ : string|null
+
+Gets address 1
+
+
+ getAddress2()
+
+ : string|null
+
+Gets address2
+
+
+ getCity()
+
+ : string|null
+
+Gets city
+
+
+ getCountry()
+
+ : string|null
+
+Gets country
+
+
+ getEmail()
+
+ : string|null
+
+Gets email
+
+
+ getName()
+
+ : string|null
+
+Gets name
+
+
+ getNotify()
+
+ : bool|null
+
+Gets notify
+
+
+ getPhone()
+
+ : string|null
+
+Gets phone
+
+
+ getState()
+
+ : string|null
+
+Gets state
+
+
+ getZip()
+
+ : string|null
+
+Gets zip
+
+
+ setAddress1()
+
+ : void
+
+Sets address1
+
+
+ setAddress2()
+
+ : void
+
+Sets address2
+
+
+ setCity()
+
+ : void
+
+Sets city
+
+
+ setCountry()
+
+ : void
+
+Sets country
+
+
+ setEmail()
+
+ : void
+
+Sets email
+
+
+ setName()
+
+ : void
+
+Sets name
+
+
+ setNotify()
+
+ : void
+
+Sets notify
+
+
+ setPhone()
+
+ : void
+
+Sets phone
+
+
+ setState()
+
+ : void
+
+Sets state
+
+
+ setZip()
+
+ : void
+
+Sets zip
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Buyer as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $address1
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address1
+ = null
+
+
+
+
+
+
+
+
+ $address2
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address2
+ = null
+
+
+
+
+
+
+
+
+ $city
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $city
+ = null
+
+
+
+
+
+
+
+
+ $country
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $country
+ = null
+
+
+
+
+
+
+
+
+ $email
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $email
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $notify
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $notify
+ = null
+
+
+
+
+
+
+
+
+ $phone
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $phone
+ = null
+
+
+
+
+
+
+
+
+ $state
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $state
+ = null
+
+
+
+
+
+
+
+
+ $zip
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $zip
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAddress1()
+
+
+
+
+
+ Gets address 1
+
+
+ public
+ getAddress1 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getAddress2()
+
+
+
+
+
+ Gets address2
+
+
+ public
+ getAddress2 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCity()
+
+
+
+
+
+ Gets city
+
+
+ public
+ getCity ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCountry()
+
+
+
+
+
+ Gets country
+
+
+ public
+ getCountry ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getEmail()
+
+
+
+
+
+ Gets email
+
+
+ public
+ getEmail ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getNotify()
+
+
+
+
+
+ Gets notify
+
+
+ public
+ getNotify ( ) : bool|null
+
+
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getPhone()
+
+
+
+
+
+ Gets phone
+
+
+ public
+ getPhone ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getState()
+
+
+
+
+
+ Gets state
+
+
+ public
+ getState ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getZip()
+
+
+
+
+
+ Gets zip
+
+
+ public
+ getZip ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAddress1()
+
+
+
+
+
+ Sets address1
+
+
+ public
+ setAddress1 ( string $address1 ) : void
+
+
+
+
+ Parameters
+
+
+ $address1
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setAddress2()
+
+
+
+
+
+ Sets address2
+
+
+ public
+ setAddress2 ( string $address2 ) : void
+
+
+
+
+ Parameters
+
+
+ $address2
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCity()
+
+
+
+
+
+ Sets city
+
+
+ public
+ setCity ( string $city ) : void
+
+
+
+
+ Parameters
+
+
+ $city
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCountry()
+
+
+
+
+
+ Sets country
+
+
+ public
+ setCountry ( string $country ) : void
+
+
+
+
+ Parameters
+
+
+ $country
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setEmail()
+
+
+
+
+
+ Sets email
+
+
+ public
+ setEmail ( string $email ) : void
+
+
+
+
+ Parameters
+
+
+ $email
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotify()
+
+
+
+
+
+ Sets notify
+
+
+ public
+ setNotify ( bool $notify ) : void
+
+
+
+
+ Parameters
+
+
+ $notify
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPhone()
+
+
+
+
+
+ Sets phone
+
+
+ public
+ setPhone ( string $phone ) : void
+
+
+
+
+ Parameters
+
+
+ $phone
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setState()
+
+
+
+
+
+ Sets state
+
+
+ public
+ setState ( string $state ) : void
+
+
+
+
+ Parameters
+
+
+ $state
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setZip()
+
+
+
+
+
+ Sets zip
+
+
+ public
+ setZip ( string $zip ) : void
+
+
+
+
+ Parameters
+
+
+ $zip
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Buyer as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Ledger-Ledger.html b/docs/classes/BitPaySDK-Model-Ledger-Ledger.html
new file mode 100644
index 00000000..3b1fccda
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Ledger-Ledger.html
@@ -0,0 +1,765 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ledger
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/ledgers
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $balance
+
+ : float|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getBalance()
+
+ : float|null
+
+Gets Ledger balance in the corresponding currency
+
+
+ getCurrency()
+
+ : string|null
+
+Gets Ledger currency
+
+
+ setBalance()
+
+ : void
+
+Sets Ledger balance in the corresponding currency
+
+
+ setCurrency()
+
+ : void
+
+Sets Ledger currency
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Ledger as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $balance
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $balance
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getBalance()
+
+
+
+
+
+ Gets Ledger balance in the corresponding currency
+
+
+ public
+ getBalance ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets Ledger currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setBalance()
+
+
+
+
+
+ Sets Ledger balance in the corresponding currency
+
+
+ public
+ setBalance ( float $balance ) : void
+
+
+
+
+ Parameters
+
+
+ $balance
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets Ledger currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Ledger as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html b/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html
new file mode 100644
index 00000000..3ece3aad
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html
@@ -0,0 +1,2609 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/ledgers
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : string|null
+
+
+
+ $buyerFields
+
+ : Buyer
+
+
+
+ $code
+
+ : string|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $description
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $invoiceAmount
+
+ : float|null
+
+
+
+ $invoiceCurrency
+
+ : string|null
+
+
+
+ $invoiceId
+
+ : string|null
+
+
+
+ $scale
+
+ : string|null
+
+
+
+ $supportRequest
+
+ : string|null
+
+
+
+ $timestamp
+
+ : string|null
+
+
+
+ $transactionCurrency
+
+ : string|null
+
+
+
+ $txType
+
+ : string|null
+
+
+
+ $type
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmount()
+
+ : string|null
+
+Gets Ledger entry amount, relative to the scale.
+
+
+ getBuyerFields()
+
+ : Buyer
+
+Gets buyer fields
+
+
+ getCode()
+
+ : string|null
+
+Gets code
+
+
+ getCurrency()
+
+ : string|null
+
+Gets Ledger entry currency for the corresponding amount
+
+
+ getDescription()
+
+ : string|null
+
+Gets description
+
+
+ getId()
+
+ : string|null
+
+Gets Ledger resource Id
+
+
+ getInvoiceAmount()
+
+ : float|null
+
+Gets Invoice price in the invoice original currency
+
+
+ getInvoiceCurrency()
+
+ : string|null
+
+Gets Currency used for invoice creation
+
+
+ getInvoiceId()
+
+ : string|null
+
+Gets BitPay invoice Id
+
+
+ getScale()
+
+ : string|null
+
+Gets scale
+
+
+ getSupportRequest()
+
+ : string|null
+
+Gets The refund requestId
+
+
+ getTimestamp()
+
+ : string|null
+
+Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ getTransactionCurrency()
+
+ : string|null
+
+Gets Cryptocurrency selected by the consumer when paying an invoice.
+
+
+ getTxType()
+
+ : string|null
+
+Gets tx type
+
+
+ getType()
+
+ : string|null
+
+Gets type
+
+
+ setAmount()
+
+ : void
+
+Sets Ledger entry amount, relative to the scale.
+
+
+ setBuyerFields()
+
+ : void
+
+Sets buyer fields
+
+
+ setCode()
+
+ : void
+
+Sets code
+
+
+ setCurrency()
+
+ : void
+
+Sets Ledger entry currency for the corresponding amount
+
+
+ setDescription()
+
+ : void
+
+Sets description
+
+
+ setId()
+
+ : void
+
+Sets Ledger resource Id
+
+
+ setInvoiceAmount()
+
+ : void
+
+Sets Invoice price in the invoice original currency
+
+
+ setInvoiceCurrency()
+
+ : void
+
+Sets Currency used for invoice creation
+
+
+ setInvoiceId()
+
+ : void
+
+Sets BitPay invoice Id
+
+
+ setScale()
+
+ : void
+
+Sets scale
+
+
+ setSupportRequest()
+
+ : void
+
+Sets The refund requestId
+
+
+ setTimestamp()
+
+ : void
+
+Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ setTransactionCurrency()
+
+ : void
+
+Sets Cryptocurrency selected by the consumer when paying an invoice.
+
+
+ setTxType()
+
+ : void
+
+Sets tx type
+
+
+ setType()
+
+ : void
+
+Sets type
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets LedgerEntry as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $buyerFields
+
+
+
+
+
+
+
+
+
+ protected
+ Buyer
+ $buyerFields
+
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $description
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $description
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $invoiceAmount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $invoiceAmount
+ = null
+
+
+
+
+
+
+
+
+ $invoiceCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $invoiceCurrency
+ = null
+
+
+
+
+
+
+
+
+ $invoiceId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $invoiceId
+ = null
+
+
+
+
+
+
+
+
+ $scale
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $scale
+ = null
+
+
+
+
+
+
+
+
+ $supportRequest
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $supportRequest
+ = null
+
+
+
+
+
+
+
+
+ $timestamp
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $timestamp
+ = null
+
+
+
+
+
+
+
+
+ $transactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $transactionCurrency
+ = null
+
+
+
+
+
+
+
+
+ $txType
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $txType
+ = null
+
+
+
+
+
+
+
+
+ $type
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $type
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets Ledger entry amount, relative to the scale.
+
+
+ public
+ getAmount ( ) : string|null
+
+
+
+ The decimal amount can be obtained by dividing the amount field by the scale parameter.
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getBuyerFields()
+
+
+
+
+
+ Gets buyer fields
+
+
+ public
+ getBuyerFields ( ) : Buyer
+
+
+
+ If provided by the merchant in the buyer object during invoice creation
+
+
+
+
+
+
+ Return values
+ Buyer
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Gets code
+
+
+ public
+ getCode ( ) : string|null
+
+
+
+ Contains the Ledger entry code.
+See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets Ledger entry currency for the corresponding amount
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getDescription()
+
+
+
+
+
+ Gets description
+
+
+ public
+ getDescription ( ) : string|null
+
+
+
+ Ledger entry description. Also contains an id depending on the type of entry
+(for instance payout id, settlement id, invoice orderId etc...)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets Ledger resource Id
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getInvoiceAmount()
+
+
+
+
+
+ Gets Invoice price in the invoice original currency
+
+
+ public
+ getInvoiceAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getInvoiceCurrency()
+
+
+
+
+
+ Gets Currency used for invoice creation
+
+
+ public
+ getInvoiceCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getInvoiceId()
+
+
+
+
+
+ Gets BitPay invoice Id
+
+
+ public
+ getInvoiceId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getScale()
+
+
+
+
+
+ Gets scale
+
+
+ public
+ getScale ( ) : string|null
+
+
+
+ Power of 10 used for conversion
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSupportRequest()
+
+
+
+
+
+ Gets The refund requestId
+
+
+ public
+ getSupportRequest ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getTimestamp()
+
+
+
+
+
+ Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ getTimestamp ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getTransactionCurrency()
+
+
+
+
+
+ Gets Cryptocurrency selected by the consumer when paying an invoice.
+
+
+ public
+ getTransactionCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the transaction currency
+
+
+
+
+
+
+
+ getTxType()
+
+
+
+
+
+ Gets tx type
+
+
+ public
+ getTxType ( ) : string|null
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getType()
+
+
+
+
+
+ Gets type
+
+
+ public
+ getType ( ) : string|null
+
+
+
+ Contains the Ledger entry name.
+See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets Ledger entry amount, relative to the scale.
+
+
+ public
+ setAmount ( string $amount ) : void
+
+
+
+ The decimal amount can be obtained by dividing the amount field by the scale parameter.
+
+
+ Parameters
+
+
+ $amount
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBuyerFields()
+
+
+
+
+
+ Sets buyer fields
+
+
+ public
+ setBuyerFields ( Buyer $buyerFields ) : void
+
+
+
+
+ Parameters
+
+
+ $buyerFields
+ : Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets code
+
+
+ public
+ setCode ( string $code ) : void
+
+
+
+ Contains the Ledger entry code.
+See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+
+
+ Parameters
+
+
+ $code
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets Ledger entry currency for the corresponding amount
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDescription()
+
+
+
+
+
+ Sets description
+
+
+ public
+ setDescription ( string $description ) : void
+
+
+
+ Ledger entry description. Also contains an id depending on the type of entry
+(for instance payout id, settlement id, invoice orderId etc...)
+
+
+ Parameters
+
+
+ $description
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets Ledger resource Id
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceAmount()
+
+
+
+
+
+ Sets Invoice price in the invoice original currency
+
+
+ public
+ setInvoiceAmount ( float $invoiceAmount ) : void
+
+
+
+
+ Parameters
+
+
+ $invoiceAmount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceCurrency()
+
+
+
+
+
+ Sets Currency used for invoice creation
+
+
+ public
+ setInvoiceCurrency ( string $invoiceCurrency ) : void
+
+
+
+
+ Parameters
+
+
+ $invoiceCurrency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceId()
+
+
+
+
+
+ Sets BitPay invoice Id
+
+
+ public
+ setInvoiceId ( string $invoiceId ) : void
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setScale()
+
+
+
+
+
+ Sets scale
+
+
+ public
+ setScale ( string $scale ) : void
+
+
+
+ Power of 10 used for conversion
+
+
+ Parameters
+
+
+ $scale
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportRequest()
+
+
+
+
+
+ Sets The refund requestId
+
+
+ public
+ setSupportRequest ( string $supportRequest ) : void
+
+
+
+
+ Parameters
+
+
+ $supportRequest
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setTimestamp()
+
+
+
+
+
+ Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ setTimestamp ( string $timestamp ) : void
+
+
+
+
+ Parameters
+
+
+ $timestamp
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionCurrency()
+
+
+
+
+
+ Sets Cryptocurrency selected by the consumer when paying an invoice.
+
+
+ public
+ setTransactionCurrency ( string $transactionCurrency ) : void
+
+
+
+
+ Parameters
+
+
+ $transactionCurrency
+ : string
+
+
+ the transaction currency
+
+
+
+
+
+
+
+
+
+
+
+ setTxType()
+
+
+
+
+
+ Sets tx type
+
+
+ public
+ setTxType ( string $txType ) : void
+
+
+
+
+
+ Parameters
+
+
+ $txType
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setType()
+
+
+
+
+
+ Sets type
+
+
+ public
+ setType ( string $type ) : void
+
+
+
+ Contains the Ledger entry name.
+See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+
+
+ Parameters
+
+
+ $type
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets LedgerEntry as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-Payout.html b/docs/classes/BitPaySDK-Model-Payout-Payout.html
new file mode 100644
index 00000000..3cce57ce
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-Payout.html
@@ -0,0 +1,3840 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $accountId
+
+ : string
+
+
+
+ $amount
+
+ : float|null
+
+
+
+ $code
+
+ : int|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $dateExecuted
+
+ : string|null
+
+
+
+ $effectiveDate
+
+ : string|null
+
+
+
+ $email
+
+ : string
+
+
+
+ $exchangeRates
+
+ : array<string|int, mixed>|null
+
+
+
+ $groupId
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $ignoreEmails
+
+ : bool
+
+
+
+ $label
+
+ : string
+
+
+
+ $ledgerCurrency
+
+ : string|null
+
+
+
+ $message
+
+ : string
+
+
+
+ $notificationEmail
+
+ : string
+
+
+
+ $notificationURL
+
+ : string
+
+
+
+ $recipientId
+
+ : string
+
+
+
+ $reference
+
+ : string
+
+
+
+ $requestDate
+
+ : string|null
+
+
+
+ $shopperId
+
+ : string
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $token
+
+ : string
+
+
+
+ $transactions
+
+ : array<string|int, PayoutTransaction >
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create a request Payout object.
+
+
+ formatAmount()
+
+ : void
+
+Change amount value based on precision rounding.
+
+
+ getAccountId()
+
+ : string
+
+Gets BitPay account id that is associated to the payout,
+assigned by BitPay for a given account during the onboarding process.
+
+
+ getAmount()
+
+ : float|null
+
+Gets amount of cryptocurrency sent to the requested address.
+
+
+ getCode()
+
+ : int|null
+
+This field will be returned in case of error and contain an error code.
+
+
+ getCurrency()
+
+ : string|null
+
+Gets currency code set for the batch amount (ISO 4217 3-character currency code).
+
+
+ getDateExecuted()
+
+ : string|null
+
+Gets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+ getEffectiveDate()
+
+ : string|null
+
+Gets Ledger currency code (ISO 4217 3-character currency code)
+
+
+ getEmail()
+
+ : string
+
+Gets email.
+
+
+ getExchangeRates()
+
+ : array<string|int, mixed>|null
+
+Gets exchange rates keyed by source and target currencies.
+
+
+ getGroupId()
+
+ : string|null
+
+Gets group id.
+
+
+ getId()
+
+ : string|null
+
+Gets Payout request id.
+
+
+ getLabel()
+
+ : string
+
+Gets label.
+
+
+ getLedgerCurrency()
+
+ : string|null
+
+Gets Ledger currency code (ISO 4217 3-character currency code
+
+
+ getMessage()
+
+ : string
+
+Gets message.
+
+
+ getNotificationEmail()
+
+ : string
+
+Gets notification email.
+
+
+ getNotificationURL()
+
+ : string
+
+Gets notification url.
+
+
+ getRecipientId()
+
+ : string
+
+Gets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+
+
+ getReference()
+
+ : string
+
+Gets reference.
+
+
+ getRequestDate()
+
+ : string|null
+
+Gets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+
+
+ getShopperId()
+
+ : string
+
+Gets shopper id.
+
+
+ getStatus()
+
+ : string|null
+
+Gets payout request status.
+
+
+ getToken()
+
+ : string
+
+Gets resource token.
+
+
+ getTransactions()
+
+ : array<string|int, PayoutTransaction >
+
+Gets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+
+
+ isIgnoreEmails()
+
+ : bool
+
+Gets boolean to prevent email updates on a specific payout.
+
+
+ setAccountId()
+
+ : void
+
+Sets BitPay account id that is associated to the payout,
+assigned by BitPay for a given account during the onboarding process.
+
+
+ setAmount()
+
+ : void
+
+Sets amount of cryptocurrency sent to the requested address.
+
+
+ setCode()
+
+ : void
+
+Sets error code.
+
+
+ setCurrency()
+
+ : mixed
+
+Sets currency code set for the batch amount (ISO 4217 3-character currency code).
+
+
+ setDateExecuted()
+
+ : void
+
+Sets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+ setEffectiveDate()
+
+ : void
+
+Sets effective date and time (UTC) for the payout.
+
+
+ setEmail()
+
+ : void
+
+Sets email.
+
+
+ setExchangeRates()
+
+ : void
+
+Sets exchange rates keyed by source and target currencies.
+
+
+ setGroupId()
+
+ : void
+
+Sets group id.
+
+
+ setId()
+
+ : void
+
+Sets Payout request id.
+
+
+ setIgnoreEmails()
+
+ : void
+
+Sets boolean to prevent email updates on a specific payout.
+
+
+ setLabel()
+
+ : void
+
+Sets label.
+
+
+ setLedgerCurrency()
+
+ : void
+
+Sets Ledger currency code (ISO 4217 3-character currency code)
+
+
+ setMessage()
+
+ : void
+
+Sets message.
+
+
+ setNotificationEmail()
+
+ : void
+
+Sets notification email.
+
+
+ setNotificationURL()
+
+ : void
+
+Sets notification url.
+
+
+ setRecipientId()
+
+ : void
+
+Sets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+
+
+ setReference()
+
+ : void
+
+Sets reference.
+
+
+ setRequestDate()
+
+ : void
+
+Sets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+
+
+ setShopperId()
+
+ : void
+
+Sets shopper id.
+
+
+ setStatus()
+
+ : void
+
+Sets payout request status.
+
+
+ setToken()
+
+ : void
+
+Sets resource token.
+
+
+ setTransactions()
+
+ : void
+
+Sets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return Payout values as array.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $accountId
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $accountId
+ = ''
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $dateExecuted
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $dateExecuted
+ = null
+
+
+
+
+
+
+
+
+ $effectiveDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $effectiveDate
+ = null
+
+
+
+
+
+
+
+
+ $email
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $email
+ = ''
+
+
+
+
+
+
+
+
+ $exchangeRates
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $exchangeRates
+ = null
+
+
+
+
+
+
+
+
+ $groupId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $groupId
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $ignoreEmails
+
+
+
+
+
+
+
+
+
+ protected
+ bool
+ $ignoreEmails
+ = false
+
+
+
+
+
+
+
+
+ $label
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $label
+ = ''
+
+
+
+
+
+
+
+
+ $ledgerCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $ledgerCurrency
+ = null
+
+
+
+
+
+
+
+
+ $message
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $message
+ = ''
+
+
+
+
+
+
+
+
+ $notificationEmail
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $notificationEmail
+ = ''
+
+
+
+
+
+
+
+
+ $notificationURL
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $notificationURL
+ = ''
+
+
+
+
+
+
+
+
+ $recipientId
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $recipientId
+ = ''
+
+
+
+
+
+
+
+
+ $reference
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $reference
+ = ''
+
+
+
+
+
+
+
+
+ $requestDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $requestDate
+ = null
+
+
+
+
+
+
+
+
+ $shopperId
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $shopperId
+ = ''
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $token
+ = ''
+
+
+
+
+
+
+
+
+ $transactions
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, PayoutTransaction >
+ $transactions
+ = []
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create a request Payout object.
+
+
+ public
+ __construct ( [ float|null $amount = null ] [ , string|null $currency = null ] [ , string|null $ledgerCurrency = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float|null
+ = null
+
+ float The amount for which the payout will be created.
+
+
+
+
+ $currency
+ : string|null
+ = null
+
+ string The three digit currency string for the PayoutBatch to use.
+
+
+
+
+ $ledgerCurrency
+ : string|null
+ = null
+
+ string Ledger currency code set for the payout request (ISO 4217 3-character
+currency code), it indicates on which ledger the payout request will be
+recorded. If not provided in the request, this parameter will be set by
+default to the active ledger currency on your account, e.g. your settlement
+currency.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Change amount value based on precision rounding.
+
+
+ public
+ formatAmount ( int $precision ) : void
+
+
+
+
+ Parameters
+
+
+ $precision
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+ getAccountId()
+
+
+
+
+
+ Gets BitPay account id that is associated to the payout,
+assigned by BitPay for a given account during the onboarding process.
+
+
+ public
+ getAccountId ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets amount of cryptocurrency sent to the requested address.
+
+
+ public
+ getAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ This field will be returned in case of error and contain an error code.
+
+
+ public
+ getCode ( ) : int|null
+
+
+
+
+
+
+
+
+ Return values
+ int|null
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets currency code set for the batch amount (ISO 4217 3-character currency code).
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDateExecuted()
+
+
+
+
+
+ Gets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+ public
+ getDateExecuted ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getEffectiveDate()
+
+
+
+
+
+ Gets Ledger currency code (ISO 4217 3-character currency code)
+
+
+ public
+ getEffectiveDate ( ) : string|null
+
+
+
+ it indicates on which ledger the payout request will be recorded. If not provided in the request,
+this parameter will be set by default to the active ledger currency on your account,
+e.g. your settlement currency.
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/api/#rest-api-resources-payouts
+
+ Supported ledger currency codes
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getEmail()
+
+
+
+
+
+ Gets email.
+
+
+ public
+ getEmail ( ) : string
+
+
+
+ Email address of an active recipient.
+Note: In the future, BitPay may allow recipients to update the email address tied to their personal account.
+BitPay encourages the use of recipientId or shopperId when programatically creating payouts requests.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getExchangeRates()
+
+
+
+
+
+ Gets exchange rates keyed by source and target currencies.
+
+
+ public
+ getExchangeRates ( ) : array<string|int, mixed>|null
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+
+
+
+
+
+ getGroupId()
+
+
+
+
+
+ Gets group id.
+
+
+ public
+ getGroupId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets Payout request id.
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getLabel()
+
+
+
+
+
+ Gets label.
+
+
+ public
+ getLabel ( ) : string
+
+
+
+ For merchant use, pass through - can be the customer name or unique merchant reference assigned by
+the merchant to the recipient.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getLedgerCurrency()
+
+
+
+
+
+ Gets Ledger currency code (ISO 4217 3-character currency code
+
+
+ public
+ getLedgerCurrency ( ) : string|null
+
+
+
+ it indicates on which ledger the payout request will be recorded. If not provided in the request,
+this parameter will be set by default to the active ledger currency on your account,
+e.g. your settlement currency.
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/api/#rest-api-resources-payouts
+
+ Supported ledger currency codes
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getMessage()
+
+
+
+
+
+ Gets message.
+
+
+ public
+ getMessage ( ) : string
+
+
+
+ In case of error, this field will contain a description message. Set to null if the request is successful.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getNotificationEmail()
+
+
+
+
+
+ Gets notification email.
+
+
+ public
+ getNotificationEmail ( ) : string
+
+
+
+ Merchant email address for notification of payout status change.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getNotificationURL()
+
+
+
+
+
+ Gets notification url.
+
+
+ public
+ getNotificationURL ( ) : string
+
+
+
+ URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getRecipientId()
+
+
+
+
+
+ Gets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+
+
+ public
+ getRecipientId ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getReference()
+
+
+
+
+
+ Gets reference.
+
+
+ public
+ getReference ( ) : string
+
+
+
+ Present only if specified by the merchant in the request.
+Merchants can pass their own unique identifier in this field for reconciliation purpose.
+Maximum string length is 100 characters.
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getRequestDate()
+
+
+
+
+
+ Gets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+
+
+ public
+ getRequestDate ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getShopperId()
+
+
+
+
+
+ Gets shopper id.
+
+
+ public
+ getShopperId ( ) : string
+
+
+
+ This is the unique id assigned by BitPay if the shopper used his personal BitPay account to authenticate and
+pay an invoice. For customers signing up for a brand new BitPay personal account,
+this id will only be created as part of the payout onboarding.
+The same field would also be available on paid invoices for customers who signed in with their
+BitPay personal accounts before completing the payment.
+This can allow merchants to monitor the activity of a customer (deposits and payouts).
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets payout request status.
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+ The possible values are:
+
+ new - initial status when the payout batch is created
+ funded - if there are enough funds available on the merchant account,
+ the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+ e.g. 2pm and 9pm UTC
+
+ processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+ transactions are broadcasted by BitPay
+
+ complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+ the typical target confirmation for the corresponding asset. For instance,
+ 6 confirmations for a bitcoin transaction.
+
+ cancelled - when the merchant cancels a payout batch (only possible for requests in the status new
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets resource token.
+
+
+ public
+ getToken ( ) : string
+
+
+
+
+ This token is actually derived from the API token -
+ used to submit the payout and is tied to the specific payout resource id created.
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getTransactions()
+
+
+
+
+
+ Gets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+
+
+ public
+ getTransactions ( ) : array<string|int, PayoutTransaction >
+
+
+
+
+
+
+
+
+
+
+
+
+ isIgnoreEmails()
+
+
+
+
+
+ Gets boolean to prevent email updates on a specific payout.
+
+
+ public
+ isIgnoreEmails ( ) : bool
+
+
+
+ Defaults to false if not provided - you will receive emails unless specified to true.
+
+
+
+
+
+
+
+
+
+
+ setAccountId()
+
+
+
+
+
+ Sets BitPay account id that is associated to the payout,
+assigned by BitPay for a given account during the onboarding process.
+
+
+ public
+ setAccountId ( string $accountId ) : void
+
+
+
+
+ Parameters
+
+
+ $accountId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets amount of cryptocurrency sent to the requested address.
+
+
+ public
+ setAmount ( float $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets error code.
+
+
+ public
+ setCode ( int|null $code ) : void
+
+
+
+
+ Parameters
+
+
+ $code
+ : int|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency code set for the batch amount (ISO 4217 3-character currency code).
+
+
+ public
+ setCurrency ( string $currency ) : mixed
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ setDateExecuted()
+
+
+
+
+
+ Sets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+ public
+ setDateExecuted ( string $dateExecuted ) : void
+
+
+
+
+ Parameters
+
+
+ $dateExecuted
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setEffectiveDate()
+
+
+
+
+
+ Sets effective date and time (UTC) for the payout.
+
+
+ public
+ setEffectiveDate ( string $effectiveDate ) : void
+
+
+
+ ISO-8601 format yyyy-mm-ddThh:mm:ssZ. If not provided, defaults to date and time of creation.
+
+
+ Parameters
+
+
+ $effectiveDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setEmail()
+
+
+
+
+
+ Sets email.
+
+
+ public
+ setEmail ( string $email ) : void
+
+
+
+ Email address of an active recipient.
+Note: In the future, BitPay may allow recipients to update the email address tied to their personal account.
+BitPay encourages the use of recipientId or shopperId when programatically creating payouts requests.
+
+
+ Parameters
+
+
+ $email
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setExchangeRates()
+
+
+
+
+
+ Sets exchange rates keyed by source and target currencies.
+
+
+ public
+ setExchangeRates ( array<string|int, mixed> $exchangeRates ) : void
+
+
+
+
+ Parameters
+
+
+ $exchangeRates
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+ setGroupId()
+
+
+
+
+
+ Sets group id.
+
+
+ public
+ setGroupId ( string|null $groupId ) : void
+
+
+
+
+ Parameters
+
+
+ $groupId
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets Payout request id.
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setIgnoreEmails()
+
+
+
+
+
+ Sets boolean to prevent email updates on a specific payout.
+
+
+ public
+ setIgnoreEmails ( bool $ignoreEmails ) : void
+
+
+
+ Defaults to false if not provided - you will receive emails unless specified to true.
+
+
+ Parameters
+
+
+ $ignoreEmails
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+ setLabel()
+
+
+
+
+
+ Sets label.
+
+
+ public
+ setLabel ( string $label ) : void
+
+
+
+ For merchant use, pass through - can be the customer name or unique merchant reference assigned by
+the merchant to the recipient.
+
+
+ Parameters
+
+
+ $label
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setLedgerCurrency()
+
+
+
+
+
+ Sets Ledger currency code (ISO 4217 3-character currency code)
+
+
+ public
+ setLedgerCurrency ( string $ledgerCurrency ) : void
+
+
+
+ it indicates on which ledger the payout request will be recorded. If not provided in the request,
+this parameter will be set by default to the active ledger currency on your account,
+e.g. your settlement currency.
+
+
+ Parameters
+
+
+ $ledgerCurrency
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ setMessage()
+
+
+
+
+
+ Sets message.
+
+
+ public
+ setMessage ( string $message ) : void
+
+
+
+ In case of error, this field will contain a description message. Set to null if the request is successful.
+
+
+ Parameters
+
+
+ $message
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationEmail()
+
+
+
+
+
+ Sets notification email.
+
+
+ public
+ setNotificationEmail ( string $notificationEmail ) : void
+
+
+
+ Merchant email address for notification of payout status change.
+
+
+ Parameters
+
+
+ $notificationEmail
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationURL()
+
+
+
+
+
+ Sets notification url.
+
+
+ public
+ setNotificationURL ( string $notificationURL ) : void
+
+
+
+ URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+
+
+ Parameters
+
+
+ $notificationURL
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setRecipientId()
+
+
+
+
+
+ Sets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+
+
+ public
+ setRecipientId ( string $recipientId ) : void
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setReference()
+
+
+
+
+
+ Sets reference.
+
+
+ public
+ setReference ( string $reference ) : void
+
+
+
+ Present only if specified by the merchant in the request.
+Merchants can pass their own unique identifier in this field for reconciliation purpose.
+Maximum string length is 100 characters.
+
+
+ Parameters
+
+
+ $reference
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setRequestDate()
+
+
+
+
+
+ Sets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+
+
+ public
+ setRequestDate ( string $requestDate ) : void
+
+
+
+
+ Parameters
+
+
+ $requestDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setShopperId()
+
+
+
+
+
+ Sets shopper id.
+
+
+ public
+ setShopperId ( string $shopperId ) : void
+
+
+
+ This is the unique id assigned by BitPay if the shopper used his personal BitPay account to authenticate and
+pay an invoice. For customers signing up for a brand new BitPay personal account,
+this id will only be created as part of the payout onboarding.
+The same field would also be available on paid invoices for customers who signed in with their
+BitPay personal accounts before completing the payment.
+This can allow merchants to monitor the activity of a customer (deposits and payouts).
+
+
+ Parameters
+
+
+ $shopperId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets payout request status.
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+ The possible values are:
+
+ new - initial status when the payout batch is created
+ funded - if there are enough funds available on the merchant account,
+ the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+ e.g. 2pm and 9pm UTC
+
+ processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+ transactions are broadcasted by BitPay
+
+ complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+ the typical target confirmation for the corresponding asset. For instance,
+ 6 confirmations for a bitcoin transaction.
+
+ cancelled - when the merchant cancels a payout batch (only possible for requests in the status new
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets resource token.
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+ This token is actually derived from the API token -
+used to submit the payout and is tied to the specific payout resource id created.
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactions()
+
+
+
+
+
+ Sets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+
+
+ public
+ setTransactions ( array<string|int, PayoutTransaction > $transactions ) : void
+
+
+
+
+ Parameters
+
+
+ $transactions
+ : array<string|int, PayoutTransaction >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutException
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return Payout values as array.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutGroup.html b/docs/classes/BitPaySDK-Model-Payout-PayoutGroup.html
new file mode 100644
index 00000000..400f06e2
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutGroup.html
@@ -0,0 +1,649 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutGroup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $failed
+
+ : array<string|int, PayoutGroupFailed >
+
+
+
+ $payouts
+
+ : array<string|int, Payout >
+
+
+
+
+
+ Methods
+
+
+
+
+
+ getFailed()
+
+ : array<string|int, PayoutGroupFailed >
+
+
+
+ getPayouts()
+
+ : array<string|int, Payout >
+
+
+
+ setFailed()
+
+ : void
+
+
+
+ setPayouts()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $failed
+
+
+
+
+
+
+
+
+
+ private
+ array<string|int, PayoutGroupFailed >
+ $failed
+ = []
+
+
+
+
+
+
+
+
+ $payouts
+
+
+
+
+
+
+
+
+
+ private
+ array<string|int, Payout >
+ $payouts
+ = []
+
+
+
+
+
+
+
+
+
+
+
+
+ getFailed()
+
+
+
+
+
+
+
+ public
+ getFailed ( ) : array<string|int, PayoutGroupFailed >
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayouts()
+
+
+
+
+
+
+
+ public
+ getPayouts ( ) : array<string|int, Payout >
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, Payout >
+
+
+
+
+
+ setFailed()
+
+
+
+
+
+
+
+ public
+ setFailed ( array<string|int, PayoutGroupFailed > $failed ) : void
+
+
+
+
+ Parameters
+
+
+ $failed
+ : array<string|int, PayoutGroupFailed >
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayouts()
+
+
+
+
+
+
+
+ public
+ setPayouts ( array<string|int, Payout > $payouts ) : void
+
+
+
+
+ Parameters
+
+
+ $payouts
+ : array<string|int, Payout >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html b/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html
new file mode 100644
index 00000000..48838c7e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html
@@ -0,0 +1,779 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutGroupFailed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $errMessage
+
+ : string
+
+
+
+ $payee
+
+ : string|null
+
+
+
+ $payoutId
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ getErrorMessage()
+
+ : string
+
+
+
+ getPayee()
+
+ : string|null
+
+
+
+ getPayoutId()
+
+ : string|null
+
+
+
+ setErrorMessage()
+
+ : void
+
+
+
+ setPayee()
+
+ : void
+
+
+
+ setPayoutId()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $errMessage
+
+
+
+
+
+
+
+
+
+ private
+ string
+ $errMessage
+ = ''
+
+
+
+
+
+
+
+
+ $payee
+
+
+
+
+
+
+
+
+
+ private
+ string|null
+ $payee
+
+
+
+
+
+
+
+
+
+ $payoutId
+
+
+
+
+
+
+
+
+
+ private
+ string|null
+ $payoutId
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getErrorMessage()
+
+
+
+
+
+
+
+ public
+ getErrorMessage ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getPayee()
+
+
+
+
+
+
+
+ public
+ getPayee ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getPayoutId()
+
+
+
+
+
+
+
+ public
+ getPayoutId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setErrorMessage()
+
+
+
+
+
+
+
+ public
+ setErrorMessage ( string $errMessage ) : void
+
+
+
+
+ Parameters
+
+
+ $errMessage
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayee()
+
+
+
+
+
+
+
+ public
+ setPayee ( string|null $payee ) : void
+
+
+
+
+ Parameters
+
+
+ $payee
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayoutId()
+
+
+
+
+
+
+
+ public
+ setPayoutId ( string|null $payoutId ) : void
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html
new file mode 100644
index 00000000..1782b7b9
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html
@@ -0,0 +1,1586 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $email
+
+ : string|null
+
+
+
+ $guid
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $label
+
+ : string|null
+
+
+
+ $notificationURL
+
+ : string|null
+
+
+
+ $shopperId
+
+ : string|null
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $token
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create a minimal Recipient object.
+
+
+ getEmail()
+
+ : string|null
+
+Gets email.
+
+
+ getGuid()
+
+ : string|null
+
+Gets guid.
+
+
+ getId()
+
+ : string|null
+
+Gets id.
+
+
+ getLabel()
+
+ : string|null
+
+Gets label.
+
+
+ getNotificationURL()
+
+ : string|null
+
+Gets notification url.
+
+
+ getShopperId()
+
+ : string|null
+
+Gets Shopper ID.
+
+
+ getStatus()
+
+ : string|null
+
+Gets status.
+
+
+ getToken()
+
+ : string|null
+
+Gets token.
+
+
+ setEmail()
+
+ : void
+
+Sets email.
+
+
+ setGuid()
+
+ : void
+
+Sets guid.
+
+
+ setId()
+
+ : void
+
+Sets id.
+
+
+ setLabel()
+
+ : void
+
+Sets label.
+
+
+ setNotificationURL()
+
+ : void
+
+Sets notification url.
+
+
+ setShopperId()
+
+ : void
+
+Sets Shopper ID.
+
+
+ setStatus()
+
+ : void
+
+Sets status.
+
+
+ setToken()
+
+ : void
+
+Sets token.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return an array with values of all fields.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $email
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $email
+ = null
+
+
+
+
+
+
+
+
+ $guid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $guid
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $label
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $label
+ = null
+
+
+
+
+
+
+
+
+ $notificationURL
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $notificationURL
+ = null
+
+
+
+
+
+
+
+
+ $shopperId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $shopperId
+ = null
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $token
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create a minimal Recipient object.
+
+
+ public
+ __construct ( [ string|null $email = null ] [ , string|null $label = null ] [ , string|null $notificationURL = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $email
+ : string|null
+ = null
+
+ string Recipient email address to which the invite shall be sent.
+
+
+
+
+ $label
+ : string|null
+ = null
+
+ string Recipient nickname assigned by the merchant (Optional).
+
+
+
+
+ $notificationURL
+ : string|null
+ = null
+
+ string URL to which BitPay sends webhook notifications to inform
+the merchant about the status of a given recipient. HTTPS is mandatory (Optional).
+
+
+
+
+
+
+
+
+
+
+
+ getEmail()
+
+
+
+
+
+ Gets email.
+
+
+ public
+ getEmail ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getGuid()
+
+
+
+
+
+ Gets guid.
+
+
+ public
+ getGuid ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets id.
+
+
+ public
+ getId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getLabel()
+
+
+
+
+
+ Gets label.
+
+
+ public
+ getLabel ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getNotificationURL()
+
+
+
+
+
+ Gets notification url.
+
+
+ public
+ getNotificationURL ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getShopperId()
+
+
+
+
+
+ Gets Shopper ID.
+
+
+ public
+ getShopperId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets status.
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets token.
+
+
+ public
+ getToken ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setEmail()
+
+
+
+
+
+ Sets email.
+
+
+ public
+ setEmail ( string|null $email ) : void
+
+
+
+
+ Parameters
+
+
+ $email
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setGuid()
+
+
+
+
+
+ Sets guid.
+
+
+ public
+ setGuid ( string $guid ) : void
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets id.
+
+
+ public
+ setId ( string|null $id ) : void
+
+
+
+
+ Parameters
+
+
+ $id
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setLabel()
+
+
+
+
+
+ Sets label.
+
+
+ public
+ setLabel ( string|null $label ) : void
+
+
+
+
+ Parameters
+
+
+ $label
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotificationURL()
+
+
+
+
+
+ Sets notification url.
+
+
+ public
+ setNotificationURL ( string|null $notificationURL ) : void
+
+
+
+
+ Parameters
+
+
+ $notificationURL
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setShopperId()
+
+
+
+
+
+ Sets Shopper ID.
+
+
+ public
+ setShopperId ( string|null $shopperId ) : void
+
+
+
+
+ Parameters
+
+
+ $shopperId
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets status.
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets token.
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return an array with values of all fields.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html
new file mode 100644
index 00000000..44791d54
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html
@@ -0,0 +1,912 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipients
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $guid
+
+ : string
+
+
+
+ $recipients
+
+ : array<string|int, mixed>
+
+
+
+ $token
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create an recipient-full request PayoutBatch object.
+
+
+ getGuid()
+
+ : string
+
+Gets guid.
+
+
+ getRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Gets an array with all recipients.
+
+
+ getToken()
+
+ : string
+
+Gets token.
+
+
+ setGuid()
+
+ : void
+
+Sets guid.
+
+
+ setRecipients()
+
+ : void
+
+Sets array with all recipients.
+
+
+ setToken()
+
+ : void
+
+Sets token.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return an array with paid and unpaid value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $guid
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $guid
+ = ''
+
+
+
+
+
+
+
+
+ $recipients
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $recipients
+ = []
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $token
+ = ''
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create an recipient-full request PayoutBatch object.
+
+
+ public
+ __construct ( [ $recipients = [] ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $recipients
+ :
+ = []
+
+ array array of JSON objects, with containing the following parameters.
+
+
+
+
+
+
+
+
+
+
+
+ getGuid()
+
+
+
+
+
+ Gets guid.
+
+
+ public
+ getGuid ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ getRecipients()
+
+
+
+
+
+ Gets an array with all recipients.
+
+
+ public
+ getRecipients ( ) : array<string|int, PayoutRecipient >
+
+
+
+
+
+
+
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets token.
+
+
+ public
+ getToken ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ setGuid()
+
+
+
+
+
+ Sets guid.
+
+
+ public
+ setGuid ( string $guid ) : void
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setRecipients()
+
+
+
+
+
+ Sets array with all recipients.
+
+
+ public
+ setRecipients ( array<string|int, PayoutRecipient > $recipients ) : void
+
+
+
+
+ Parameters
+
+
+ $recipients
+ : array<string|int, PayoutRecipient >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientException
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets token.
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return an array with paid and unpaid value.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html
new file mode 100644
index 00000000..593cc36a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html
@@ -0,0 +1,665 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface PayoutStatus
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ CANCELLED
+
+ = 'cancelled'
+
+Cancelled status.
+
+
+ COMPLETE
+
+ = 'complete'
+
+Complete status
+
+
+ FAILED
+
+ = 'failed'
+
+Failed status.
+
+
+ FUNDED
+
+ = 'funded'
+
+Funded status.
+
+
+ NEW
+
+ = 'new'
+
+New status.
+
+
+ PAID
+
+ = 'paid'
+
+Paid status.
+
+
+ PROCESSING
+
+ = 'processing'
+
+Processing status
+
+
+ UNPAID
+
+ = 'unpaid'
+
+Unpaid status.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CANCELLED
+
+
+
+
+
+
+ Cancelled status.
+
+
+ public
+ mixed
+ CANCELLED
+ = 'cancelled'
+
+
+
+
+
+
+
+
+
+
+ COMPLETE
+
+
+
+
+
+
+ Complete status
+
+
+ public
+ mixed
+ COMPLETE
+ = 'complete'
+
+
+
+
+
+
+
+
+
+
+ FAILED
+
+
+
+
+
+
+ Failed status.
+
+
+ public
+ mixed
+ FAILED
+ = 'failed'
+
+
+
+
+
+
+
+
+
+
+ FUNDED
+
+
+
+
+
+
+ Funded status.
+
+
+ public
+ mixed
+ FUNDED
+ = 'funded'
+
+
+
+
+
+
+
+
+
+
+ NEW
+
+
+
+
+
+
+ New status.
+
+
+ public
+ mixed
+ NEW
+ = 'new'
+
+
+
+
+
+
+
+
+
+
+ PAID
+
+
+
+
+
+
+ Paid status.
+
+
+ public
+ mixed
+ PAID
+ = 'paid'
+
+
+
+
+
+
+
+
+
+
+ PROCESSING
+
+
+
+
+
+
+ Processing status
+
+
+ public
+ mixed
+ PROCESSING
+ = 'processing'
+
+
+
+
+
+
+
+
+
+
+ UNPAID
+
+
+
+
+
+
+ Unpaid status.
+
+
+ public
+ mixed
+ UNPAID
+ = 'unpaid'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html b/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html
new file mode 100644
index 00000000..525d1b50
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html
@@ -0,0 +1,1044 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutTransaction
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contains the cryptocurrency transaction details for the executed payout.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float|null
+
+
+
+ $confirmations
+
+ : string|null
+
+
+
+ $date
+
+ : string|null
+
+
+
+ $txid
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmount()
+
+ : float|null
+
+Gets Amount of cryptocurrency sent to the requested address.
+
+
+ getConfirmations()
+
+ : string|null
+
+Gets the number of confirmations the transaction has received.
+
+
+ getDate()
+
+ : string|null
+
+Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+
+
+ getTxid()
+
+ : string|null
+
+Gets Cryptocurrency transaction hash for the executed payout.
+
+
+ setAmount()
+
+ : void
+
+Sets Amount of cryptocurrency sent to the requested address.
+
+
+ setConfirmations()
+
+ : void
+
+Sets the number of confirmations the transaction has received.
+
+
+ setDate()
+
+ : void
+
+Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+
+
+ setTxid()
+
+ : void
+
+Sets Cryptocurrency transaction hash for the executed payout.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets PayoutTransaction as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $confirmations
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $confirmations
+ = null
+
+
+
+
+
+
+
+
+ $date
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $date
+ = null
+
+
+
+
+
+
+
+
+ $txid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $txid
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets Amount of cryptocurrency sent to the requested address.
+
+
+ public
+ getAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getConfirmations()
+
+
+
+
+
+ Gets the number of confirmations the transaction has received.
+
+
+ public
+ getConfirmations ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDate()
+
+
+
+
+
+ Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+
+
+ public
+ getDate ( ) : string|null
+
+
+
+ ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getTxid()
+
+
+
+
+
+ Gets Cryptocurrency transaction hash for the executed payout.
+
+
+ public
+ getTxid ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets Amount of cryptocurrency sent to the requested address.
+
+
+ public
+ setAmount ( float|null $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setConfirmations()
+
+
+
+
+
+ Sets the number of confirmations the transaction has received.
+
+
+ public
+ setConfirmations ( string|null $confirmations ) : void
+
+
+
+
+ Parameters
+
+
+ $confirmations
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setDate()
+
+
+
+
+
+ Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+
+
+ public
+ setDate ( string|null $date ) : void
+
+
+
+ ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+
+
+ Parameters
+
+
+ $date
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setTxid()
+
+
+
+
+
+ Sets Cryptocurrency transaction hash for the executed payout.
+
+
+ public
+ setTxid ( string|null $txid ) : void
+
+
+
+
+ Parameters
+
+
+ $txid
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets PayoutTransaction as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ PayoutTransaction as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html b/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html
new file mode 100644
index 00000000..e0faa95e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html
@@ -0,0 +1,480 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RecipientReferenceMethod
+
+
+
+
+
+ List of recipient reference methods
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ EMAIL
+
+ = 1
+
+Email method will be used to target the recipient
+
+
+ RECIPIENT_ID
+
+ = 2
+
+Recipient id will be used to target the recipient
+
+
+ SHOPPER_ID
+
+ = 3
+
+Shopper id will be used to target the recipient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ EMAIL
+
+
+
+
+
+
+ Email method will be used to target the recipient
+
+
+ public
+ mixed
+ EMAIL
+ = 1
+
+
+
+
+
+
+
+
+
+
+ RECIPIENT_ID
+
+
+
+
+
+
+ Recipient id will be used to target the recipient
+
+
+ public
+ mixed
+ RECIPIENT_ID
+ = 2
+
+
+
+
+
+
+
+
+
+
+ SHOPPER_ID
+
+
+
+
+
+
+ Shopper id will be used to target the recipient
+
+
+ public
+ mixed
+ SHOPPER_ID
+ = 3
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html b/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html
new file mode 100644
index 00000000..4e391f22
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html
@@ -0,0 +1,591 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RecipientStatus
+
+
+
+
+
+ Interface RecipientStatus
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/payouts
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ ACTIVE
+
+ = 'active'
+
+Active recipient status.
+
+
+ INVITED
+
+ = 'invited'
+
+Invited recipient status.
+
+
+ PAUSED
+
+ = 'paused'
+
+Paused recipient status.
+
+
+ REMOVED
+
+ = 'removed'
+
+Removed recipient status.
+
+
+ UNVERIFIED
+
+ = 'unverified'
+
+Unverified recipient status.
+
+
+ VERIFIED
+
+ = 'verified'
+
+Verified recipient status.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ACTIVE
+
+
+
+
+
+
+ Active recipient status.
+
+
+ public
+ mixed
+ ACTIVE
+ = 'active'
+
+
+
+
+
+
+
+
+
+
+ INVITED
+
+
+
+
+
+
+ Invited recipient status.
+
+
+ public
+ mixed
+ INVITED
+ = 'invited'
+
+
+
+
+
+
+
+
+
+
+ PAUSED
+
+
+
+
+
+
+ Paused recipient status.
+
+
+ public
+ mixed
+ PAUSED
+ = 'paused'
+
+
+
+
+
+
+
+
+
+
+ REMOVED
+
+
+
+
+
+
+ Removed recipient status.
+
+
+ public
+ mixed
+ REMOVED
+ = 'removed'
+
+
+
+
+
+
+
+
+
+
+ UNVERIFIED
+
+
+
+
+
+
+ Unverified recipient status.
+
+
+ public
+ mixed
+ UNVERIFIED
+ = 'unverified'
+
+
+
+
+
+
+
+
+
+
+ VERIFIED
+
+
+
+
+
+
+ Verified recipient status.
+
+
+ public
+ mixed
+ VERIFIED
+ = 'verified'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Rate-Rate.html b/docs/classes/BitPaySDK-Model-Rate-Rate.html
new file mode 100644
index 00000000..629d8c37
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Rate-Rate.html
@@ -0,0 +1,905 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/rates
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $code
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $rate
+
+ : float|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getCode()
+
+ : string|null
+
+Gets ISO 4217 3-character currency code
+
+
+ getName()
+
+ : string|null
+
+Gets detailed currency name
+
+
+ getRate()
+
+ : float|null
+
+Gets rate for the requested baseCurrency /currency pair
+
+
+ setCode()
+
+ : void
+
+Sets ISO 4217 3-character currency code
+
+
+ setName()
+
+ : void
+
+Sets detailed currency name
+
+
+ setRate()
+
+ : void
+
+Sets rate for the requested baseCurrency /currency pair
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Rate as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $rate
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $rate
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Gets ISO 4217 3-character currency code
+
+
+ public
+ getCode ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets detailed currency name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getRate()
+
+
+
+
+
+ Gets rate for the requested baseCurrency /currency pair
+
+
+ public
+ getRate ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets ISO 4217 3-character currency code
+
+
+ public
+ setCode ( string $code ) : void
+
+
+
+
+ Parameters
+
+
+ $code
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets detailed currency name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setRate()
+
+
+
+
+
+ Sets rate for the requested baseCurrency /currency pair
+
+
+ public
+ setRate ( float $rate ) : void
+
+
+
+
+ Parameters
+
+
+ $rate
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Rate as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Rate-Rates.html b/docs/classes/BitPaySDK-Model-Rate-Rates.html
new file mode 100644
index 00000000..e21f7355
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Rate-Rates.html
@@ -0,0 +1,799 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/rates
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $rates
+
+ : array<string|int, mixed>
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Rates constructor.
+
+
+ getRate()
+
+ : float|null
+
+Gets rate for the requested currency code.
+
+
+ getRates()
+
+ : array<string|int, mixed>
+
+Gets rates.
+
+
+ toArray()
+
+ : array<string|int, array<string|int, mixed>>
+
+Return an array with rates value.
+
+
+ update()
+
+ : void
+
+Update rates.
+
+
+ validateRates()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $rates
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Rates constructor.
+
+
+ public
+ __construct ( array<string|int, mixed> $rates ) : mixed
+
+
+
+
+ Parameters
+
+
+ $rates
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ getRate()
+
+
+
+
+
+ Gets rate for the requested currency code.
+
+
+ public
+ getRate ( string $currencyCode ) : float|null
+
+
+
+
+ Parameters
+
+
+ $currencyCode
+ : string
+
+
+ 3-character currency code
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getRates()
+
+
+
+
+
+ Gets rates.
+
+
+ public
+ getRates ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return an array with rates value.
+
+
+ public
+ toArray ( ) : array<string|int, array<string|int, mixed>>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, array<string|int, mixed>>
+
+
+
+
+
+ update()
+
+
+
+
+
+ Update rates.
+
+
+ public
+ update ( Client $bp ) : void
+
+
+
+
+ Parameters
+
+
+ $bp
+ : Client
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ validateRates()
+
+
+
+
+
+
+
+ private
+ validateRates ( array<string|int, mixed> $rates ) : void
+
+
+
+
+ Parameters
+
+
+ $rates
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html b/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html
new file mode 100644
index 00000000..d5c1ea1e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html
@@ -0,0 +1,1600 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing relevant information from the paid invoice.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $date
+
+ : string|null
+
+
+
+ $orderId
+
+ : string|null
+
+
+
+ $overPaidAmount
+
+ : float|null
+
+
+
+ $payoutPercentage
+
+ : float|null
+
+
+
+ $price
+
+ : float|null
+
+
+
+ $refundInfo
+
+ : RefundInfo |null
+
+
+
+ $transactionCurrency
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getCurrency()
+
+ : string|null
+
+Gets Invoice currency
+
+
+ getDate()
+
+ : string|null
+
+Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ getOrderId()
+
+ : string|null
+
+Gets Invoice orderId provided during invoice creation.
+
+
+ getOverPaidAmount()
+
+ : float|null
+
+Gets over paid amount
+
+
+ getPayoutPercentage()
+
+ : float|null
+
+Gets The payout percentage defined by the merchant on his BitPay account settings
+
+
+ getPrice()
+
+ : float|null
+
+Gets Invoice price in the invoice original currency
+
+
+ getRefundInfo()
+
+ : RefundInfo |null
+
+Gets Object containing information about the refund executed for the invoice
+
+
+ getTransactionCurrency()
+
+ : string|null
+
+Gets Cryptocurrency selected by the consumer when paying the invoice.
+
+
+ setCurrency()
+
+ : void
+
+Sets Invoice currency
+
+
+ setDate()
+
+ : void
+
+Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ setOrderId()
+
+ : void
+
+Sets Invoice orderId provided during invoice creation.
+
+
+ setOverPaidAmount()
+
+ : void
+
+Sets over paid amount
+
+
+ setPayoutPercentage()
+
+ : void
+
+Sets The payout percentage defined by the merchant on his BitPay account settings
+
+
+ setPrice()
+
+ : void
+
+Sets Invoice price in the invoice original currency
+
+
+ setRefundInfo()
+
+ : void
+
+Sets Object containing information about the refund executed for the invoice
+
+
+ setTransactionCurrency()
+
+ : void
+
+Sets Cryptocurrency selected by the consumer when paying the invoice.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets InvoiceData as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $date
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $date
+ = null
+
+
+
+
+
+
+
+
+ $orderId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $orderId
+ = null
+
+
+
+
+
+
+
+
+ $overPaidAmount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $overPaidAmount
+ = null
+
+
+
+
+
+
+
+
+ $payoutPercentage
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $payoutPercentage
+ = null
+
+
+
+
+
+
+
+
+ $price
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $price
+ = null
+
+
+
+
+
+
+
+
+ $refundInfo
+
+
+
+
+
+
+
+
+
+ protected
+ RefundInfo |null
+ $refundInfo
+ = null
+
+
+
+
+
+
+
+
+ $transactionCurrency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $transactionCurrency
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets Invoice currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getDate()
+
+
+
+
+
+ Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ getDate ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getOrderId()
+
+
+
+
+
+ Gets Invoice orderId provided during invoice creation.
+
+
+ public
+ getOrderId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getOverPaidAmount()
+
+
+
+
+
+ Gets over paid amount
+
+
+ public
+ getOverPaidAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getPayoutPercentage()
+
+
+
+
+
+ Gets The payout percentage defined by the merchant on his BitPay account settings
+
+
+ public
+ getPayoutPercentage ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getPrice()
+
+
+
+
+
+ Gets Invoice price in the invoice original currency
+
+
+ public
+ getPrice ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getRefundInfo()
+
+
+
+
+
+ Gets Object containing information about the refund executed for the invoice
+
+
+ public
+ getRefundInfo ( ) : RefundInfo |null
+
+
+
+
+
+
+
+
+
+
+
+
+ getTransactionCurrency()
+
+
+
+
+
+ Gets Cryptocurrency selected by the consumer when paying the invoice.
+
+
+ public
+ getTransactionCurrency ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the transaction currency
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets Invoice currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDate()
+
+
+
+
+
+ Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ setDate ( string $date ) : void
+
+
+
+
+ Parameters
+
+
+ $date
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setOrderId()
+
+
+
+
+
+ Sets Invoice orderId provided during invoice creation.
+
+
+ public
+ setOrderId ( string $orderId ) : void
+
+
+
+
+ Parameters
+
+
+ $orderId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setOverPaidAmount()
+
+
+
+
+
+ Sets over paid amount
+
+
+ public
+ setOverPaidAmount ( float $overPaidAmount ) : void
+
+
+
+
+ Parameters
+
+
+ $overPaidAmount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayoutPercentage()
+
+
+
+
+
+ Sets The payout percentage defined by the merchant on his BitPay account settings
+
+
+ public
+ setPayoutPercentage ( float $payoutPercentage ) : void
+
+
+
+
+ Parameters
+
+
+ $payoutPercentage
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPrice()
+
+
+
+
+
+ Sets Invoice price in the invoice original currency
+
+
+ public
+ setPrice ( float $price ) : void
+
+
+
+
+ Parameters
+
+
+ $price
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setRefundInfo()
+
+
+
+
+
+ Sets Object containing information about the refund executed for the invoice
+
+
+ public
+ setRefundInfo ( RefundInfo $refundInfo ) : void
+
+
+
+
+ Parameters
+
+
+ $refundInfo
+ : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setTransactionCurrency()
+
+
+
+
+
+ Sets Cryptocurrency selected by the consumer when paying the invoice.
+
+
+ public
+ setTransactionCurrency ( string $transactionCurrency ) : void
+
+
+
+
+ Parameters
+
+
+ $transactionCurrency
+ : string
+
+
+ the transaction currency
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets InvoiceData as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html b/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html
new file mode 100644
index 00000000..b556c9cc
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html
@@ -0,0 +1,3872 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing the settlement info provided by the Merchant in his BitPay account settings.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $account
+
+ : string|null
+
+
+
+ $accountHolderAddress
+
+ : string|null
+
+
+
+ $accountHolderAddress2
+
+ : string|null
+
+
+
+ $accountHolderCity
+
+ : string|null
+
+
+
+ $accountHolderCountry
+
+ : string|null
+
+
+
+ $accountHolderName
+
+ : string|null
+
+
+
+ $accountHolderPostalCode
+
+ : string|null
+
+
+
+ $additionalInformation
+
+ : string|null
+
+
+
+ $address
+
+ : string|null
+
+
+
+ $bank
+
+ : string|null
+
+
+
+ $bankAddress
+
+ : string|null
+
+
+
+ $bankAddress2
+
+ : string|null
+
+
+
+ $bankCountry
+
+ : string|null
+
+
+
+ $bankName
+
+ : string|null
+
+
+
+ $city
+
+ : string|null
+
+
+
+ $iban
+
+ : string|null
+
+
+
+ $label
+
+ : string|null
+
+
+
+ $merchantEin
+
+ : string|null
+
+
+
+ $name
+
+ : string|null
+
+
+
+ $postal
+
+ : string|null
+
+
+
+ $routing
+
+ : string|null
+
+
+
+ $sort
+
+ : string|null
+
+
+
+ $swift
+
+ : string|null
+
+
+
+ $wire
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAccount()
+
+ : string|null
+
+Gets Bank account number of the merchant
+
+
+ getAccountHolderAddress()
+
+ : string|null
+
+Gets Bank account holder address
+
+
+ getAccountHolderAddress2()
+
+ : string|null
+
+Gets Bank account holder address2
+
+
+ getAccountHolderCity()
+
+ : string|null
+
+Gets Bank account holder city
+
+
+ getAccountHolderCountry()
+
+ : string|null
+
+Gets Bank account holder country
+
+
+ getAccountHolderName()
+
+ : string|null
+
+Gets Bank account holder name
+
+
+ getAccountHolderPostalCode()
+
+ : string|null
+
+Gets Bank account holder postal code
+
+
+ getAdditionalInformation()
+
+ : string|null
+
+Gets additional information
+
+
+ getAddress()
+
+ : string|null
+
+Gets address
+
+
+ getBank()
+
+ : string|null
+
+Gets Name of the bank used by the merchant
+
+
+ getBankAddress()
+
+ : string|null
+
+Gets bank address
+
+
+ getBankAddress2()
+
+ : string|null
+
+Gets bank address 2
+
+
+ getBankCountry()
+
+ : string|null
+
+Gets Country where the merchant's bank account is located
+
+
+ getBankName()
+
+ : string|null
+
+Gets bank name
+
+
+ getCity()
+
+ : string|null
+
+Gets City of the merchant bank, field return if the settlement currency is
+
+
+ getIban()
+
+ : string|null
+
+Gets iban
+
+
+ getLabel()
+
+ : string|null
+
+Gets label
+
+
+ getMerchantEin()
+
+ : string|null
+
+Gets merchant ein
+
+
+ getName()
+
+ : string|null
+
+Gets account holder name
+
+
+ getPostal()
+
+ : string|null
+
+Gets Postal code of the merchant bank, field return if the settlement currency is
+
+
+ getRouting()
+
+ : string|null
+
+Gets routing
+
+
+ getSort()
+
+ : string|null
+
+Gets sort
+
+
+ getSwift()
+
+ : string|null
+
+Gets SWIFT/BIC code of the merchant's bank.
+
+
+ getWire()
+
+ : string|null
+
+Gets wire
+
+
+ setAccount()
+
+ : void
+
+Sets Bank account number of the merchant
+
+
+ setAccountHolderAddress()
+
+ : void
+
+Sets Bank account holder address2
+
+
+ setAccountHolderAddress2()
+
+ : void
+
+Sets Bank account holder address2
+
+
+ setAccountHolderCity()
+
+ : void
+
+Sets Bank account holder city
+
+
+ setAccountHolderCountry()
+
+ : void
+
+Sets Bank account holder country
+
+
+ setAccountHolderName()
+
+ : void
+
+Sets Bank account holder name
+
+
+ setAccountHolderPostalCode()
+
+ : void
+
+Sets Bank account holder postal code
+
+
+ setAdditionalInformation()
+
+ : void
+
+Sets additional information
+
+
+ setAddress()
+
+ : void
+
+Sets address
+
+
+ setBank()
+
+ : void
+
+Sets Name of the bank used by the merchant
+
+
+ setBankAddress()
+
+ : void
+
+Sets bank address
+
+
+ setBankAddress2()
+
+ : void
+
+Sets bank address2
+
+
+ setBankCountry()
+
+ : void
+
+Sets Country where the merchant's bank account is located
+
+
+ setBankName()
+
+ : void
+
+Sets bank name
+
+
+ setCity()
+
+ : void
+
+Sets city of the merchant bank
+
+
+ setIban()
+
+ : void
+
+Sets iban
+
+
+ setLabel()
+
+ : void
+
+Sets label
+
+
+ setMerchantEin()
+
+ : void
+
+Sets merchant ein
+
+
+ setName()
+
+ : void
+
+Sets account holder name
+
+
+ setPostal()
+
+ : void
+
+Sets Postal code of the merchant bank
+
+
+ setRouting()
+
+ : void
+
+Sets routing
+
+
+ setSort()
+
+ : void
+
+Sets sort
+
+
+ setSwift()
+
+ : void
+
+Sets SWIFT/BIC code of the merchant's bank.
+
+
+ setWire()
+
+ : void
+
+Sets wire
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets PayoutInfo as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $account
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $account
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderAddress
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderAddress
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderAddress2
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderAddress2
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderCity
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderCity
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderCountry
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderCountry
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderName
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderName
+ = null
+
+
+
+
+
+
+
+
+ $accountHolderPostalCode
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountHolderPostalCode
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $additionalInformation
+ = null
+
+
+
+
+
+
+
+
+ $address
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $address
+ = null
+
+
+
+
+
+
+
+
+ $bank
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bank
+ = null
+
+
+
+
+
+
+
+
+ $bankAddress
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bankAddress
+ = null
+
+
+
+
+
+
+
+
+ $bankAddress2
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bankAddress2
+ = null
+
+
+
+
+
+
+
+
+ $bankCountry
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bankCountry
+ = null
+
+
+
+
+
+
+
+
+ $bankName
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bankName
+ = null
+
+
+
+
+
+
+
+
+ $city
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $city
+ = null
+
+
+
+
+
+
+
+
+ $iban
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $iban
+ = null
+
+
+
+
+
+
+
+
+ $label
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $label
+ = null
+
+
+
+
+
+
+
+
+ $merchantEin
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $merchantEin
+ = null
+
+
+
+
+
+
+
+
+ $name
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $name
+ = null
+
+
+
+
+
+
+
+
+ $postal
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $postal
+ = null
+
+
+
+
+
+
+
+
+ $routing
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $routing
+ = null
+
+
+
+
+
+
+
+
+ $sort
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $sort
+ = null
+
+
+
+
+
+
+
+
+ $swift
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $swift
+ = null
+
+
+
+
+
+
+
+
+ $wire
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $wire
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAccount()
+
+
+
+
+
+ Gets Bank account number of the merchant
+
+
+ public
+ getAccount ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account number
+
+
+
+
+
+
+
+ getAccountHolderAddress()
+
+
+
+
+
+ Gets Bank account holder address
+
+
+ public
+ getAccountHolderAddress ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder address
+
+
+
+
+
+
+
+ getAccountHolderAddress2()
+
+
+
+
+
+ Gets Bank account holder address2
+
+
+ public
+ getAccountHolderAddress2 ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder address2
+
+
+
+
+
+
+
+ getAccountHolderCity()
+
+
+
+
+
+ Gets Bank account holder city
+
+
+ public
+ getAccountHolderCity ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder city
+
+
+
+
+
+
+
+ getAccountHolderCountry()
+
+
+
+
+
+ Gets Bank account holder country
+
+
+ public
+ getAccountHolderCountry ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder country
+
+
+
+
+
+
+
+ getAccountHolderName()
+
+
+
+
+
+ Gets Bank account holder name
+
+
+ public
+ getAccountHolderName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder name
+
+
+
+
+
+
+
+ getAccountHolderPostalCode()
+
+
+
+
+
+ Gets Bank account holder postal code
+
+
+ public
+ getAccountHolderPostalCode ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the bank account holder postal code
+
+
+
+
+
+
+
+
+
+ Gets additional information
+
+
+ public
+ getAdditionalInformation ( ) : string|null
+
+
+
+ When providing the settlement info via the dashboard, this field can be used by the merchant to provide
+additional information about the receiving bank. Field returned if "wire": true in the "payoutInfo" object
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ the additional information
+
+
+
+
+
+
+
+ getAddress()
+
+
+
+
+
+ Gets address
+
+
+ public
+ getAddress ( ) : string|null
+
+
+
+ This field is used to indicate the wallet address used for the settlement,
+if the settlement currency selected by the merchant is one of the supported crypto currency:
+Bitcoin (BTC), Bitcoin Cash (BCH), Dogecoin (DOGE), Ether (ETH), Gemini US Dollar (GUSD),
+Circle USD Coin (USDC), Paxos Standard USD (PAX), Binance USD (BUSD), Dai (DAI), Wrapped Bitcoin (WBTC),
+and Ripple (XRP). If the settlement currency used is AUD, GBP, NZD, MXN, ZAR -
+this field is used to indicate the address of the merchant's bank
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBank()
+
+
+
+
+
+ Gets Name of the bank used by the merchant
+
+
+ public
+ getBank ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBankAddress()
+
+
+
+
+
+ Gets bank address
+
+
+ public
+ getBankAddress ( ) : string|null
+
+
+
+ Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBankAddress2()
+
+
+
+
+
+ Gets bank address 2
+
+
+ public
+ getBankAddress2 ( ) : string|null
+
+
+
+ Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBankCountry()
+
+
+
+
+
+ Gets Country where the merchant's bank account is located
+
+
+ public
+ getBankCountry ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getBankName()
+
+
+
+
+
+ Gets bank name
+
+
+ public
+ getBankName ( ) : string|null
+
+
+
+ Name of the bank used by the merchant. Field returned if "wire": true in the "payoutInfo" object
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCity()
+
+
+
+
+
+ Gets City of the merchant bank, field return if the settlement currency is
+
+
+ public
+ getCity ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getIban()
+
+
+
+
+
+ Gets iban
+
+
+ public
+ getIban ( ) : string|null
+
+
+
+ The merchant's bank account number, in the IBAN (International Bank Account Number) format.
+Field returned if "wire": true in the "payoutInfo" object
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getLabel()
+
+
+
+
+
+ Gets label
+
+
+ public
+ getLabel ( ) : string|null
+
+
+
+ As indicated by the merchant in his settlement settings
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getMerchantEin()
+
+
+
+
+
+ Gets merchant ein
+
+
+ public
+ getMerchantEin ( ) : string|null
+
+
+
+ for merchants receiving USD settlements via local ACH, this field contains the merchant's EIN
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getName()
+
+
+
+
+
+ Gets account holder name
+
+
+ public
+ getName ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPostal()
+
+
+
+
+
+ Gets Postal code of the merchant bank, field return if the settlement currency is
+
+
+ public
+ getPostal ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getRouting()
+
+
+
+
+
+ Gets routing
+
+
+ public
+ getRouting ( ) : string|null
+
+
+
+ for merchants receiving USD settlements via local ACH, this field contains the ABA provided by the merchant
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getSort()
+
+
+
+
+
+ Gets sort
+
+
+ public
+ getSort ( ) : string|null
+
+
+
+ used to pass country specific bank fields: BSB for AUD
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getSwift()
+
+
+
+
+
+ Gets SWIFT/BIC code of the merchant's bank.
+
+
+ public
+ getSwift ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getWire()
+
+
+
+
+
+ Gets wire
+
+
+ public
+ getWire ( ) : string|null
+
+
+
+ If set to true, this means BitPay will be settling the account using an international transfer via the SWIFT
+network instead of local settlement methods like ACH(United States) or SEPA (European Economic Area)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAccount()
+
+
+
+
+
+ Sets Bank account number of the merchant
+
+
+ public
+ setAccount ( string $account ) : void
+
+
+
+
+ Parameters
+
+
+ $account
+ : string
+
+
+ the bank account number
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderAddress()
+
+
+
+
+
+ Sets Bank account holder address2
+
+
+ public
+ setAccountHolderAddress ( string $accountHolderAddress ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderAddress
+ : string
+
+
+ the bank account holder address
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderAddress2()
+
+
+
+
+
+ Sets Bank account holder address2
+
+
+ public
+ setAccountHolderAddress2 ( string $accountHolderAddress2 ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderAddress2
+ : string
+
+
+ the bank account holder address2
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderCity()
+
+
+
+
+
+ Sets Bank account holder city
+
+
+ public
+ setAccountHolderCity ( string $accountHolderCity ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderCity
+ : string
+
+
+ the bank account holder city
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderCountry()
+
+
+
+
+
+ Sets Bank account holder country
+
+
+ public
+ setAccountHolderCountry ( string $accountHolderCountry ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderCountry
+ : string
+
+
+ the bank account holder country
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderName()
+
+
+
+
+
+ Sets Bank account holder name
+
+
+ public
+ setAccountHolderName ( string $accountHolderName ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderName
+ : string
+
+
+ the bank account holder name
+
+
+
+
+
+
+
+
+
+
+
+ setAccountHolderPostalCode()
+
+
+
+
+
+ Sets Bank account holder postal code
+
+
+ public
+ setAccountHolderPostalCode ( string $accountHolderPostalCode ) : void
+
+
+
+
+ Parameters
+
+
+ $accountHolderPostalCode
+ : string
+
+
+ the bank account holder postal code
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets additional information
+
+
+ public
+ setAdditionalInformation ( string $additionalInformation ) : void
+
+
+
+
+ Parameters
+
+
+ $additionalInformation
+ : string
+
+
+ the additional information
+
+
+
+
+
+
+
+
+
+
+
+ setAddress()
+
+
+
+
+
+ Sets address
+
+
+ public
+ setAddress ( string $address ) : void
+
+
+
+
+ Parameters
+
+
+ $address
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBank()
+
+
+
+
+
+ Sets Name of the bank used by the merchant
+
+
+ public
+ setBank ( string $bank ) : void
+
+
+
+
+ Parameters
+
+
+ $bank
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBankAddress()
+
+
+
+
+
+ Sets bank address
+
+
+ public
+ setBankAddress ( string $bankAddress ) : void
+
+
+
+
+ Parameters
+
+
+ $bankAddress
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBankAddress2()
+
+
+
+
+
+ Sets bank address2
+
+
+ public
+ setBankAddress2 ( string $bankAddress2 ) : void
+
+
+
+
+ Parameters
+
+
+ $bankAddress2
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBankCountry()
+
+
+
+
+
+ Sets Country where the merchant's bank account is located
+
+
+ public
+ setBankCountry ( string $bankCountry ) : void
+
+
+
+
+ Parameters
+
+
+ $bankCountry
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBankName()
+
+
+
+
+
+ Sets bank name
+
+
+ public
+ setBankName ( string $bankName ) : void
+
+
+
+
+ Parameters
+
+
+ $bankName
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCity()
+
+
+
+
+
+ Sets city of the merchant bank
+
+
+ public
+ setCity ( string $city ) : void
+
+
+
+
+ Parameters
+
+
+ $city
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setIban()
+
+
+
+
+
+ Sets iban
+
+
+ public
+ setIban ( string $iban ) : void
+
+
+
+
+ Parameters
+
+
+ $iban
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setLabel()
+
+
+
+
+
+ Sets label
+
+
+ public
+ setLabel ( string $label ) : void
+
+
+
+
+ Parameters
+
+
+ $label
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setMerchantEin()
+
+
+
+
+
+ Sets merchant ein
+
+
+ public
+ setMerchantEin ( string $merchantEin ) : void
+
+
+
+
+ Parameters
+
+
+ $merchantEin
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setName()
+
+
+
+
+
+ Sets account holder name
+
+
+ public
+ setName ( string $name ) : void
+
+
+
+
+ Parameters
+
+
+ $name
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPostal()
+
+
+
+
+
+ Sets Postal code of the merchant bank
+
+
+ public
+ setPostal ( string $postal ) : void
+
+
+
+
+ Parameters
+
+
+ $postal
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setRouting()
+
+
+
+
+
+ Sets routing
+
+
+ public
+ setRouting ( string $routing ) : void
+
+
+
+
+ Parameters
+
+
+ $routing
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSort()
+
+
+
+
+
+ Sets sort
+
+
+ public
+ setSort ( string $sort ) : void
+
+
+
+
+ Parameters
+
+
+ $sort
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setSwift()
+
+
+
+
+
+ Sets SWIFT/BIC code of the merchant's bank.
+
+
+ public
+ setSwift ( string $swift ) : void
+
+
+
+
+ Parameters
+
+
+ $swift
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setWire()
+
+
+
+
+
+ Sets wire
+
+
+ public
+ setWire ( string $wire ) : void
+
+
+
+
+ Parameters
+
+
+ $wire
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets PayoutInfo as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html b/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html
new file mode 100644
index 00000000..2bec1bfe
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html
@@ -0,0 +1,1046 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing information about the refund.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amounts
+
+ : array<string|int, mixed>|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $refundRequestEid
+
+ : string|null
+
+
+
+ $supportRequest
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmounts()
+
+ : array<string|int, mixed>|null
+
+Gets amounts.
+
+
+ getCurrency()
+
+ : string|null
+
+Gets currency.
+
+
+ getRefundRequestEid()
+
+ : string
+
+Gets Refund Request Eid.
+
+
+ getSupportRequest()
+
+ : string|null
+
+Gets support request.
+
+
+ setAmounts()
+
+ : void
+
+Sets amounts.
+
+
+ setCurrency()
+
+ : void
+
+Sets currency.
+
+
+ setRefundRequestEid()
+
+ : void
+
+Sets Refund Request Eid.
+
+
+ setSupportRequest()
+
+ : void
+
+Sets support request.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Refund info as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amounts
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>|null
+ $amounts
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $refundRequestEid
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $refundRequestEid
+ = null
+
+
+
+
+
+
+
+
+ $supportRequest
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $supportRequest
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmounts()
+
+
+
+
+
+ Gets amounts.
+
+
+ public
+ getAmounts ( ) : array<string|int, mixed>|null
+
+
+
+ This object will contain the crypto currency amount refunded by BitPay to the consumer
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>|null
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets currency.
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the settlement.
+Supported settlement currencies are listed on Settlement Docs
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getRefundRequestEid()
+
+
+
+
+
+ Gets Refund Request Eid.
+
+
+ public
+ getRefundRequestEid ( ) : string
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+
+
+
+
+
+
+
+ getSupportRequest()
+
+
+
+
+
+ Gets support request.
+
+
+ public
+ getSupportRequest ( ) : string|null
+
+
+
+ BitPay support request ID associated to the refund
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAmounts()
+
+
+
+
+
+ Sets amounts.
+
+
+ public
+ setAmounts ( array<string|int, mixed> $amounts ) : void
+
+
+
+
+ Parameters
+
+
+ $amounts
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency.
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the settlement.
+Supported settlement currencies are listed on Settlement Docs
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setRefundRequestEid()
+
+
+
+
+
+ Sets Refund Request Eid.
+
+
+ public
+ setRefundRequestEid ( string|null $refundRequestEid ) : void
+
+
+
+
+ Parameters
+
+
+ $refundRequestEid
+ : string|null
+
+
+
+
+
+
+
+
+
+
+
+
+ setSupportRequest()
+
+
+
+
+
+ Sets support request.
+
+
+ public
+ setSupportRequest ( string $supportRequest ) : void
+
+
+
+ BitPay support request ID associated to the refund
+
+
+ Parameters
+
+
+ $supportRequest
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Refund info as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-Settlement.html b/docs/classes/BitPaySDK-Model-Settlement-Settlement.html
new file mode 100644
index 00000000..de06d590
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-Settlement.html
@@ -0,0 +1,2856 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement data object.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $accountId
+
+ : string|null
+
+
+
+ $closingDate
+
+ : string|null
+
+
+
+ $currency
+
+ : string|null
+
+
+
+ $dateCompleted
+
+ : string|null
+
+
+
+ $dateCreated
+
+ : string|null
+
+
+
+ $dateExecuted
+
+ : string|null
+
+
+
+ $id
+
+ : string|null
+
+
+
+ $ledgerEntries
+
+ : array<string|int, mixed>
+
+
+
+ $ledgerEntriesSum
+
+ : float|null
+
+
+
+ $openingBalance
+
+ : float|null
+
+
+
+ $openingDate
+
+ : string|null
+
+
+
+ $payoutInfo
+
+ : PayoutInfo |null
+
+
+
+ $status
+
+ : string|null
+
+
+
+ $token
+
+ : string|null
+
+
+
+ $totalAmount
+
+ : float|null
+
+
+
+ $withHoldings
+
+ : array<string|int, mixed>
+
+
+
+ $withHoldingsSum
+
+ : float|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAccountId()
+
+ : string|null
+
+Gets account id
+
+
+ getClosingDate()
+
+ : string|null
+
+Gets closing date.
+
+
+ getCurrency()
+
+ : string|null
+
+Gets currency
+
+
+ getDateCompleted()
+
+ : string|null
+
+Gets date completed
+
+
+ getDateCreated()
+
+ : string|null
+
+Gets date created
+
+
+ getDateExecuted()
+
+ : string|null
+
+Gets date executed
+
+
+ getId()
+
+ : string|null
+
+Gets id
+
+
+ getLedgerEntries()
+
+ : array<string|int, SettlementLedgerEntry >
+
+Gets Array of ledger entries listing the various debits and credits which are settled in the report.
+
+
+ getLedgerEntriesSum()
+
+ : float|null
+
+Gets ledger entries sum.
+
+
+ getOpeningBalance()
+
+ : float|null
+
+Gets Balance of the ledger at the openingDate
+
+
+ getOpeningDate()
+
+ : string|null
+
+Gets opening date
+
+
+ getPayoutInfo()
+
+ : PayoutInfo |null
+
+Gets Object containing the settlement info provided by the Merchant in his BitPay account settings
+
+
+ getStatus()
+
+ : string|null
+
+Gets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+
+
+ getToken()
+
+ : string|null
+
+Gets API token for the corresponding settlement resource.
+
+
+ getTotalAmount()
+
+ : float|null
+
+Gets total amount sent to the merchant; 2 decimals.
+
+
+ getWithHoldings()
+
+ : array<string|int, WithHoldings >
+
+Gets with holdings
+
+
+ getWithHoldingsSum()
+
+ : float|null
+
+Gets Sum of all amounts that are withheld from settlement
+
+
+ setAccountId()
+
+ : void
+
+Sets account id
+
+
+ setClosingDate()
+
+ : void
+
+Sets closing date.
+
+
+ setCurrency()
+
+ : void
+
+Sets currency
+
+
+ setDateCompleted()
+
+ : void
+
+Sets date completed
+
+
+ setDateCreated()
+
+ : void
+
+Sets date created
+
+
+ setDateExecuted()
+
+ : void
+
+Sets date executed
+
+
+ setId()
+
+ : void
+
+Sets id
+
+
+ setLedgerEntries()
+
+ : void
+
+Sets Array of ledger entries listing the various debits and credits which are settled in the report.
+
+
+ setLedgerEntriesSum()
+
+ : void
+
+Sets ledger entries sum.
+
+
+ setOpeningBalance()
+
+ : void
+
+Sets Balance of the ledger at the openingDate
+
+
+ setOpeningDate()
+
+ : void
+
+Sets opening date
+
+
+ setPayoutInfo()
+
+ : void
+
+Sets Object containing the settlement info provided by the Merchant in his BitPay account settings
+
+
+ setStatus()
+
+ : void
+
+Sets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+
+
+ setToken()
+
+ : void
+
+Sets API token for the corresponding settlement resource.
+
+
+ setTotalAmount()
+
+ : void
+
+Sets total amount sent to the merchant; 2 decimals.
+
+
+ setWithHoldings()
+
+ : void
+
+Sets with holdings
+
+
+ setWithHoldingsSum()
+
+ : void
+
+Sets Sum of all amounts that are withheld from settlement
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Returns the Settlement object as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $accountId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $accountId
+ = null
+
+
+
+
+
+
+
+
+ $closingDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $closingDate
+ = null
+
+
+
+
+
+
+
+
+ $currency
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $currency
+ = null
+
+
+
+
+
+
+
+
+ $dateCompleted
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $dateCompleted
+ = null
+
+
+
+
+
+
+
+
+ $dateCreated
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $dateCreated
+ = null
+
+
+
+
+
+
+
+
+ $dateExecuted
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $dateExecuted
+ = null
+
+
+
+
+
+
+
+
+ $id
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $id
+ = null
+
+
+
+
+
+
+
+
+ $ledgerEntries
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $ledgerEntries
+ = []
+
+
+
+
+
+
+
+
+ $ledgerEntriesSum
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $ledgerEntriesSum
+ = null
+
+
+
+
+
+
+
+
+ $openingBalance
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $openingBalance
+ = null
+
+
+
+
+
+
+
+
+ $openingDate
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $openingDate
+ = null
+
+
+
+
+
+
+
+
+ $payoutInfo
+
+
+
+
+
+
+
+
+
+ protected
+ PayoutInfo |null
+ $payoutInfo
+ = null
+
+
+
+
+
+
+
+
+ $status
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $status
+ = null
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $token
+ = null
+
+
+
+
+
+
+
+
+ $totalAmount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $totalAmount
+ = null
+
+
+
+
+
+
+
+
+ $withHoldings
+
+
+
+
+
+
+
+
+
+ protected
+ array<string|int, mixed>
+ $withHoldings
+ = []
+
+
+
+
+
+
+
+
+ $withHoldingsSum
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $withHoldingsSum
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAccountId()
+
+
+
+
+
+ Gets account id
+
+
+ public
+ getAccountId ( ) : string|null
+
+
+
+ String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getClosingDate()
+
+
+
+
+
+ Gets closing date.
+
+
+ public
+ getClosingDate ( ) : string|null
+
+
+
+ Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getCurrency()
+
+
+
+
+
+ Gets currency
+
+
+ public
+ getCurrency ( ) : string|null
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the settlement.
+Supported settlement currencies are listed on https://bitpay.com/docs/settlement
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDateCompleted()
+
+
+
+
+
+ Gets date completed
+
+
+ public
+ getDateCompleted ( ) : string|null
+
+
+
+ Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDateCreated()
+
+
+
+
+
+ Gets date created
+
+
+ public
+ getDateCreated ( ) : string|null
+
+
+
+ Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDateExecuted()
+
+
+
+
+
+ Gets date executed
+
+
+ public
+ getDateExecuted ( ) : string|null
+
+
+
+ Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getId()
+
+
+
+
+
+ Gets id
+
+
+ public
+ getId ( ) : string|null
+
+
+
+ String identifying the settlement; this id will also be in the description of the corresponding bank settlement.
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getLedgerEntries()
+
+
+
+
+
+ Gets Array of ledger entries listing the various debits and credits which are settled in the report.
+
+
+ public
+ getLedgerEntries ( ) : array<string|int, SettlementLedgerEntry >
+
+
+
+ The total sum of all ledger entries is reported in the field ledgerEntriesSum.
+A description of all ledger codes can be found
+
+
+
+
+
+
+
+
+
+
+ getLedgerEntriesSum()
+
+
+
+
+
+ Gets ledger entries sum.
+
+
+ public
+ getLedgerEntriesSum ( ) : float|null
+
+
+
+ Sum of all ledger entries in the settlement, this means all the debits & credits
+which happened between openingDate and closingDate
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getOpeningBalance()
+
+
+
+
+
+ Gets Balance of the ledger at the openingDate
+
+
+ public
+ getOpeningBalance ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getOpeningDate()
+
+
+
+
+
+ Gets opening date
+
+
+ public
+ getOpeningDate ( ) : string|null
+
+
+
+ corresponds to the closingDate of the previous settlement executed.
+For the first settlement of an account the value will be the BitPay merchant account creation date.
+UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getPayoutInfo()
+
+
+
+
+
+ Gets Object containing the settlement info provided by the Merchant in his BitPay account settings
+
+
+ public
+ getPayoutInfo ( ) : PayoutInfo |null
+
+
+
+
+
+
+
+
+
+
+
+
+ getStatus()
+
+
+
+
+
+ Gets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+
+
+ public
+ getStatus ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getToken()
+
+
+
+
+
+ Gets API token for the corresponding settlement resource.
+
+
+ public
+ getToken ( ) : string|null
+
+
+
+ This token is actually derived from the merchant facade token used during the query.
+This token is required to fetch the reconciliation report
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getTotalAmount()
+
+
+
+
+
+ Gets total amount sent to the merchant; 2 decimals.
+
+
+ public
+ getTotalAmount ( ) : float|null
+
+
+
+ totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getWithHoldings()
+
+
+
+
+
+ Gets with holdings
+
+
+ public
+ getWithHoldings ( ) : array<string|int, WithHoldings >
+
+
+
+ Array of withholdings. Withholdings are kept on the ledger to be used later and thus withheld
+from this settlement. Each withholding is a JSON object containing a code, amount and description field.
+
+
+
+
+
+
+
+
+
+
+ getWithHoldingsSum()
+
+
+
+
+
+ Gets Sum of all amounts that are withheld from settlement
+
+
+ public
+ getWithHoldingsSum ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ setAccountId()
+
+
+
+
+
+ Sets account id
+
+
+ public
+ setAccountId ( string $accountId ) : void
+
+
+
+ String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.
+
+
+ Parameters
+
+
+ $accountId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setClosingDate()
+
+
+
+
+
+ Sets closing date.
+
+
+ public
+ setClosingDate ( string $closingDate ) : void
+
+
+
+ Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ Parameters
+
+
+ $closingDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrency()
+
+
+
+
+
+ Sets currency
+
+
+ public
+ setCurrency ( string $currency ) : void
+
+
+
+ ISO 4217 3-character currency code. This is the currency associated with the settlement.
+Supported settlement currencies are listed on https://bitpay.com/docs/settlement
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setDateCompleted()
+
+
+
+
+
+ Sets date completed
+
+
+ public
+ setDateCompleted ( string $dateCompleted ) : void
+
+
+
+ Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ Parameters
+
+
+ $dateCompleted
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setDateCreated()
+
+
+
+
+
+ Sets date created
+
+
+ public
+ setDateCreated ( string $dateCreated ) : void
+
+
+
+ Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ Parameters
+
+
+ $dateCreated
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setDateExecuted()
+
+
+
+
+
+ Sets date executed
+
+
+ public
+ setDateExecuted ( string $dateExecuted ) : void
+
+
+
+ Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ Parameters
+
+
+ $dateExecuted
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setId()
+
+
+
+
+
+ Sets id
+
+
+ public
+ setId ( string $id ) : void
+
+
+
+ String identifying the settlement; this id will also be in the description of the corresponding bank settlement.
+
+
+ Parameters
+
+
+ $id
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setLedgerEntries()
+
+
+
+
+
+ Sets Array of ledger entries listing the various debits and credits which are settled in the report.
+
+
+ public
+ setLedgerEntries ( array<string|int, SettlementLedgerEntry > $ledgerEntries ) : void
+
+
+
+ The total sum of all ledger entries is reported in the field ledgerEntriesSum.
+A description of all ledger codes can be found
+
+
+ Parameters
+
+
+ $ledgerEntries
+ : array<string|int, SettlementLedgerEntry >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementException
+
+
+
+
+
+
+
+
+
+ setLedgerEntriesSum()
+
+
+
+
+
+ Sets ledger entries sum.
+
+
+ public
+ setLedgerEntriesSum ( float $ledgerEntriesSum ) : void
+
+
+
+ Sum of all ledger entries in the settlement, this means all the debits & credits
+which happened between openingDate and closingDate
+
+
+ Parameters
+
+
+ $ledgerEntriesSum
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setOpeningBalance()
+
+
+
+
+
+ Sets Balance of the ledger at the openingDate
+
+
+ public
+ setOpeningBalance ( float $openingBalance ) : void
+
+
+
+
+ Parameters
+
+
+ $openingBalance
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setOpeningDate()
+
+
+
+
+
+ Sets opening date
+
+
+ public
+ setOpeningDate ( string $openingDate ) : void
+
+
+
+ corresponds to the closingDate of the previous settlement executed.
+For the first settlement of an account the value will be the BitPay merchant account creation date.
+UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ Parameters
+
+
+ $openingDate
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayoutInfo()
+
+
+
+
+
+ Sets Object containing the settlement info provided by the Merchant in his BitPay account settings
+
+
+ public
+ setPayoutInfo ( PayoutInfo $payoutInfo ) : void
+
+
+
+
+ Parameters
+
+
+ $payoutInfo
+ : PayoutInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setStatus()
+
+
+
+
+
+ Sets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+
+
+ public
+ setStatus ( string $status ) : void
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setToken()
+
+
+
+
+
+ Sets API token for the corresponding settlement resource.
+
+
+ public
+ setToken ( string $token ) : void
+
+
+
+ This token is actually derived from the merchant facade token used during the query.
+This token is required to fetch the reconciliation report
+
+
+ Parameters
+
+
+ $token
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setTotalAmount()
+
+
+
+
+
+ Sets total amount sent to the merchant; 2 decimals.
+
+
+ public
+ setTotalAmount ( float $totalAmount ) : void
+
+
+
+ totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum
+
+
+ Parameters
+
+
+ $totalAmount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ setWithHoldings()
+
+
+
+
+
+ Sets with holdings
+
+
+ public
+ setWithHoldings ( array<string|int, WithHoldings > $withHoldings ) : void
+
+
+
+ Array of withholdings. Withholdings are kept on the ledger to be used later and thus withheld
+from this settlement. Each withholding is a JSON object containing a code, amount and description field.
+
+
+ Parameters
+
+
+ $withHoldings
+ : array<string|int, WithHoldings >
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementException
+
+
+
+
+
+
+
+
+
+ setWithHoldingsSum()
+
+
+
+
+
+ Sets Sum of all amounts that are withheld from settlement
+
+
+ public
+ setWithHoldingsSum ( float $withHoldingsSum ) : void
+
+
+
+
+ Parameters
+
+
+ $withHoldingsSum
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Returns the Settlement object as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html b/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html
new file mode 100644
index 00000000..905952d7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html
@@ -0,0 +1,1479 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementLedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float|null
+
+
+
+ $code
+
+ : int|null
+
+
+
+ $description
+
+ : string|null
+
+
+
+ $invoiceData
+
+ : InvoiceData
+
+
+
+ $invoiceId
+
+ : string|null
+
+
+
+ $reference
+
+ : string|null
+
+
+
+ $timestamp
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getAmount()
+
+ : float|null
+
+Gets amount
+
+
+ getCode()
+
+ : int|null
+
+Gets code
+
+
+ getDescription()
+
+ : string|null
+
+Gets Ledger entry description.
+
+
+ getInvoiceData()
+
+ : InvoiceData
+
+Gets Invoice Data
+
+
+ getInvoiceId()
+
+ : string|null
+
+Gets BitPay invoice Id
+
+
+ getReference()
+
+ : string|null
+
+Gets reference
+
+
+ getTimestamp()
+
+ : string|null
+
+Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ setAmount()
+
+ : void
+
+Sets amount
+
+
+ setCode()
+
+ : void
+
+Sets code
+
+
+ setDescription()
+
+ : void
+
+Sets Ledger entry description.
+
+
+ setInvoiceData()
+
+ : void
+
+Sets Invoice Data
+
+
+ setInvoiceId()
+
+ : void
+
+Sets BitPay invoice Id
+
+
+ setReference()
+
+ : void
+
+Sets reference
+
+
+ setTimestamp()
+
+ : void
+
+Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets SettlementLedgerEntry as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ int|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $description
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $description
+ = null
+
+
+
+
+
+
+
+
+ $invoiceData
+
+
+
+
+
+
+
+
+
+ protected
+ InvoiceData
+ $invoiceData
+
+
+
+
+
+
+
+
+
+ $invoiceId
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $invoiceId
+ = null
+
+
+
+
+
+
+
+
+ $reference
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $reference
+ = null
+
+
+
+
+
+
+
+
+ $timestamp
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $timestamp
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets amount
+
+
+ public
+ getAmount ( ) : float|null
+
+
+
+ Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
+
+
+
+
+
+
+ Return values
+ float|null
+ —
+
+
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Gets code
+
+
+ public
+ getCode ( ) : int|null
+
+
+
+ Contains the Ledger entry code
+
+
+
+
+
+
+ Return values
+ int|null
+ —
+
+
+
+
+
+
+
+ getDescription()
+
+
+
+
+
+ Gets Ledger entry description.
+
+
+ public
+ getDescription ( ) : string|null
+
+
+
+ This field often contains an id depending on the type of entry
+(for instance payout id, settlement id, invoice orderId etc...)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getInvoiceData()
+
+
+
+
+
+ Gets Invoice Data
+
+
+ public
+ getInvoiceData ( ) : InvoiceData
+
+
+
+ Object containing relevant information from the paid invoice
+
+
+
+
+
+
+
+
+
+
+ getInvoiceId()
+
+
+
+
+
+ Gets BitPay invoice Id
+
+
+ public
+ getInvoiceId ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getReference()
+
+
+
+
+
+ Gets reference
+
+
+ public
+ getReference ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getTimestamp()
+
+
+
+
+
+ Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ getTimestamp ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets amount
+
+
+ public
+ setAmount ( float $amount ) : void
+
+
+
+ Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
+
+
+ Parameters
+
+
+ $amount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets code
+
+
+ public
+ setCode ( int $code ) : void
+
+
+
+ Contains the Ledger entry code
+
+
+ Parameters
+
+
+ $code
+ : int
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDescription()
+
+
+
+
+
+ Sets Ledger entry description.
+
+
+ public
+ setDescription ( string $description ) : void
+
+
+
+ This field often contains an id depending on the type of entry
+(for instance payout id, settlement id, invoice orderId etc...)
+
+
+ Parameters
+
+
+ $description
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceData()
+
+
+
+
+
+ Sets Invoice Data
+
+
+ public
+ setInvoiceData ( InvoiceData $invoiceData ) : void
+
+
+
+ Object containing relevant information from the paid invoice
+
+
+ Parameters
+
+
+ $invoiceData
+ : InvoiceData
+
+
+ information from the paid invoice
+
+
+
+
+
+
+
+
+
+
+
+ setInvoiceId()
+
+
+
+
+
+ Sets BitPay invoice Id
+
+
+ public
+ setInvoiceId ( string $invoiceId ) : void
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setReference()
+
+
+
+
+
+ Sets reference
+
+
+ public
+ setReference ( string $reference ) : void
+
+
+
+
+ Parameters
+
+
+ $reference
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setTimestamp()
+
+
+
+
+
+ Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+
+
+ public
+ setTimestamp ( string $timestamp ) : void
+
+
+
+
+ Parameters
+
+
+ $timestamp
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets SettlementLedgerEntry as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ SettlementLedgerEntry as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html b/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html
new file mode 100644
index 00000000..bcf65d9b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html
@@ -0,0 +1,1299 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/settlements
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $amount
+
+ : float|null
+
+
+
+ $bankCountry
+
+ : string|null
+
+
+
+ $code
+
+ : string|null
+
+
+
+ $description
+
+ : string|null
+
+
+
+ $label
+
+ : string|null
+
+
+
+ $notes
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+WithHoldings constructor.
+
+
+ getAmount()
+
+ : float|null
+
+Gets amount.
+
+
+ getBankCountry()
+
+ : string|null
+
+Gets bank country.
+
+
+ getCode()
+
+ : string|null
+
+Gets code.
+
+
+ getDescription()
+
+ : string|null
+
+Gets description.
+
+
+ getLabel()
+
+ : string|null
+
+Gets label.
+
+
+ getNotes()
+
+ : string|null
+
+Gets notes.
+
+
+ setAmount()
+
+ : void
+
+Sets amount.
+
+
+ setBankCountry()
+
+ : void
+
+Sets bank country.
+
+
+ setCode()
+
+ : void
+
+Sets code.
+
+
+ setDescription()
+
+ : void
+
+Sets description.
+
+
+ setLabel()
+
+ : void
+
+Sets label.
+
+
+ setNotes()
+
+ : void
+
+Sets notes.
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Return an array with class values.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $amount
+
+
+
+
+
+
+
+
+
+ protected
+ float|null
+ $amount
+ = null
+
+
+
+
+
+
+
+
+ $bankCountry
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $bankCountry
+ = null
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $description
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $description
+ = null
+
+
+
+
+
+
+
+
+ $label
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $label
+ = null
+
+
+
+
+
+
+
+
+ $notes
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $notes
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ WithHoldings constructor.
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAmount()
+
+
+
+
+
+ Gets amount.
+
+
+ public
+ getAmount ( ) : float|null
+
+
+
+
+
+
+
+
+ Return values
+ float|null
+
+
+
+
+
+ getBankCountry()
+
+
+
+
+
+ Gets bank country.
+
+
+ public
+ getBankCountry ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Gets code.
+
+
+ public
+ getCode ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getDescription()
+
+
+
+
+
+ Gets description.
+
+
+ public
+ getDescription ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getLabel()
+
+
+
+
+
+ Gets label.
+
+
+ public
+ getLabel ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getNotes()
+
+
+
+
+
+ Gets notes.
+
+
+ public
+ getNotes ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ setAmount()
+
+
+
+
+
+ Sets amount.
+
+
+ public
+ setAmount ( float $amount ) : void
+
+
+
+
+ Parameters
+
+
+ $amount
+ : float
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setBankCountry()
+
+
+
+
+
+ Sets bank country.
+
+
+ public
+ setBankCountry ( string $bankCountry ) : void
+
+
+
+
+ Parameters
+
+
+ $bankCountry
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets code.
+
+
+ public
+ setCode ( string $code ) : void
+
+
+
+
+ Parameters
+
+
+ $code
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDescription()
+
+
+
+
+
+ Sets description.
+
+
+ public
+ setDescription ( string $description ) : void
+
+
+
+
+ Parameters
+
+
+ $description
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setLabel()
+
+
+
+
+
+ Sets label.
+
+
+ public
+ setLabel ( string $label ) : void
+
+
+
+
+ Parameters
+
+
+ $label
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setNotes()
+
+
+
+
+
+ Sets notes.
+
+
+ public
+ setNotes ( string $notes ) : void
+
+
+
+
+ Parameters
+
+
+ $notes
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Return an array with class values.
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Wallet-Currencies.html b/docs/classes/BitPaySDK-Model-Wallet-Currencies.html
new file mode 100644
index 00000000..87b6df85
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Wallet-Currencies.html
@@ -0,0 +1,1630 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currencies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Details of what currencies support payments for this wallet
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/wallets
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $code
+
+ : string|null
+
+
+
+ $dappBrowser
+
+ : bool|null
+
+
+
+ $image
+
+ : string|null
+
+
+
+ $p2p
+
+ : bool|null
+
+
+
+ $payPro
+
+ : bool|null
+
+
+
+ $qr
+
+ : CurrencyQr |null
+
+
+
+ $walletConnect
+
+ : bool|null
+
+
+
+ $withdrawalFee
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getCode()
+
+ : string|null
+
+Gets code
+
+
+ getDappBrowser()
+
+ : bool|null
+
+Gets Dapp Browser
+
+
+ getImage()
+
+ : string|null
+
+Gets URL that displays currency image
+
+
+ getP2p()
+
+ : bool|null
+
+Gets p2p
+
+
+ getPayPro()
+
+ : bool|null
+
+Gets pay pro
+
+
+ getQr()
+
+ : CurrencyQr |null
+
+Gets CurrencyQr
+
+
+ getWalletConnect()
+
+ : bool|null
+
+Gets wallet connect
+
+
+ getWithdrawalFee()
+
+ : string|null
+
+Gets Custodial wallet withdrawal fee
+
+
+ setCode()
+
+ : void
+
+Sets code
+
+
+ setDappBrowser()
+
+ : void
+
+Sets Dapp Browser
+
+
+ setImage()
+
+ : void
+
+Sets URL that displays currency image
+
+
+ setP2p()
+
+ : void
+
+Sets p2p
+
+
+ setPayPro()
+
+ : void
+
+Sets pay pro
+
+
+ setQr()
+
+ : void
+
+Sets CurrencyQr
+
+
+ setWalletConnect()
+
+ : void
+
+Sets wallet connect
+
+
+ setWithdrawalFee()
+
+ : void
+
+Sets Custodial wallet withdrawal fee
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Currencies as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $code
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $code
+ = null
+
+
+
+
+
+
+
+
+ $dappBrowser
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $dappBrowser
+ = null
+
+
+
+
+
+
+
+
+ $image
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $image
+ = null
+
+
+
+
+
+
+
+
+ $p2p
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $p2p
+ = null
+
+
+
+
+
+
+
+
+ $payPro
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $payPro
+ = null
+
+
+
+
+
+
+
+
+ $qr
+
+
+
+
+
+
+
+
+
+ protected
+ CurrencyQr |null
+ $qr
+ = null
+
+
+
+
+
+
+
+
+ $walletConnect
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $walletConnect
+ = null
+
+
+
+
+
+
+
+
+ $withdrawalFee
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $withdrawalFee
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getCode()
+
+
+
+
+
+ Gets code
+
+
+ public
+ getCode ( ) : string|null
+
+
+
+ Identifying code for the currency
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getDappBrowser()
+
+
+
+
+
+ Gets Dapp Browser
+
+
+ public
+ getDappBrowser ( ) : bool|null
+
+
+
+ Indicates that this payment method operates via a browser plugin interacting with the invoice
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getImage()
+
+
+
+
+
+ Gets URL that displays currency image
+
+
+ public
+ getImage ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getP2p()
+
+
+
+
+
+ Gets p2p
+
+
+ public
+ getP2p ( ) : bool|null
+
+
+
+ Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getPayPro()
+
+
+
+
+
+ Gets pay pro
+
+
+ public
+ getPayPro ( ) : bool|null
+
+
+
+ Whether or not BitPay Payment Protocol is supported on this particular currency option
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getQr()
+
+
+
+
+
+ Gets CurrencyQr
+
+
+ public
+ getQr ( ) : CurrencyQr |null
+
+
+
+ Object containing QR code related information to show for this payment method
+
+
+
+
+
+
+
+
+
+
+ getWalletConnect()
+
+
+
+
+
+ Gets wallet connect
+
+
+ public
+ getWalletConnect ( ) : bool|null
+
+
+
+ Whether or not this wallet supports walletConnect
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getWithdrawalFee()
+
+
+
+
+
+ Gets Custodial wallet withdrawal fee
+
+
+ public
+ getWithdrawalFee ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ setCode()
+
+
+
+
+
+ Sets code
+
+
+ public
+ setCode ( string $code ) : void
+
+
+
+ Identifying code for the currency
+
+
+ Parameters
+
+
+ $code
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDappBrowser()
+
+
+
+
+
+ Sets Dapp Browser
+
+
+ public
+ setDappBrowser ( bool $dappBrowser ) : void
+
+
+
+ Indicates that this payment method operates via a browser plugin interacting with the invoice
+
+
+ Parameters
+
+
+ $dappBrowser
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setImage()
+
+
+
+
+
+ Sets URL that displays currency image
+
+
+ public
+ setImage ( string $image ) : void
+
+
+
+
+ Parameters
+
+
+ $image
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setP2p()
+
+
+
+
+
+ Sets p2p
+
+
+ public
+ setP2p ( bool $p2p ) : void
+
+
+
+ Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)
+
+
+ Parameters
+
+
+ $p2p
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayPro()
+
+
+
+
+
+ Sets pay pro
+
+
+ public
+ setPayPro ( bool $payPro ) : void
+
+
+
+ Whether or not BitPay Payment Protocol is supported on this particular currency option
+
+
+ Parameters
+
+
+ $payPro
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setQr()
+
+
+
+
+
+ Sets CurrencyQr
+
+
+ public
+ setQr ( CurrencyQr $qr ) : void
+
+
+
+ Object containing QR code related information to show for this payment method
+
+
+ Parameters
+
+
+ $qr
+ : CurrencyQr
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setWalletConnect()
+
+
+
+
+
+ Sets wallet connect
+
+
+ public
+ setWalletConnect ( bool $walletConnect ) : void
+
+
+
+ Whether or not this wallet supports walletConnect
+
+
+ Parameters
+
+
+ $walletConnect
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setWithdrawalFee()
+
+
+
+
+
+ Sets Custodial wallet withdrawal fee
+
+
+ public
+ setWithdrawalFee ( string $withdrawalFee ) : void
+
+
+
+
+ Parameters
+
+
+ $withdrawalFee
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Currencies as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html b/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html
new file mode 100644
index 00000000..5b929afe
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html
@@ -0,0 +1,774 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing QR code related information to show for this payment method
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/wallets
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $collapsed
+
+ : bool|null
+
+
+
+ $type
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+
+
+ getCollapsed()
+
+ : bool|null
+
+Gets collapsed
+
+
+ getType()
+
+ : string|null
+
+Gets Type
+
+
+ setCollapsed()
+
+ : void
+
+Sets collapsed
+
+
+ setType()
+
+ : void
+
+Sets Type
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets CurrencyQr as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $collapsed
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $collapsed
+ = null
+
+
+
+
+
+
+
+
+ $type
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $type
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getCollapsed()
+
+
+
+
+
+ Gets collapsed
+
+
+ public
+ getCollapsed ( ) : bool|null
+
+
+
+ UI hint for BitPay invoice, generally not relevant to customer integrations
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ getType()
+
+
+
+
+
+ Gets Type
+
+
+ public
+ getType ( ) : string|null
+
+
+
+ The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ The type of QR code to use
+
+
+
+
+
+
+
+ setCollapsed()
+
+
+
+
+
+ Sets collapsed
+
+
+ public
+ setCollapsed ( bool $collapsed ) : void
+
+
+
+ UI hint for BitPay invoice, generally not relevant to customer integrations
+
+
+ Parameters
+
+
+ $collapsed
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setType()
+
+
+
+
+
+ Sets Type
+
+
+ public
+ setType ( string $type ) : void
+
+
+
+ The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)
+
+
+ Parameters
+
+
+ $type
+ : string
+
+
+ The type of QR code to use
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets CurrencyQr as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Model-Wallet-Wallet.html b/docs/classes/BitPaySDK-Model-Wallet-Wallet.html
new file mode 100644
index 00000000..01f49f95
--- /dev/null
+++ b/docs/classes/BitPaySDK-Model-Wallet-Wallet.html
@@ -0,0 +1,1347 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+ see
+
+
+ https://bitpay.readme.io/reference/wallets
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $avatar
+
+ : string|null
+
+
+
+ $currencies
+
+ : Currencies
+
+
+
+ $displayName
+
+ : string|null
+
+
+
+ $image
+
+ : string|null
+
+
+
+ $key
+
+ : string|null
+
+
+
+ $payPro
+
+ : bool|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor, create a minimal request Wallet object.
+
+
+ getAvatar()
+
+ : string|null
+
+Gets avatar
+
+
+ getCurrencies()
+
+ : Currencies
+
+Gets currencies
+
+
+ getDisplayName()
+
+ : string|null
+
+Gets display name
+
+
+ getImage()
+
+ : string|null
+
+Gets image
+
+
+ getKey()
+
+ : string|null
+
+Gets A unique identifier for the wallet
+
+
+ getPayPro()
+
+ : bool|null
+
+Gets pay pro
+
+
+ setAvatar()
+
+ : void
+
+Sets avatar
+
+
+ setCurrencies()
+
+ : void
+
+Sets currencies
+
+
+ setDisplayName()
+
+ : void
+
+Sets display name
+
+
+ setImage()
+
+ : void
+
+Sets image
+
+
+ setKey()
+
+ : void
+
+Sets A unique identifier for the wallet
+
+
+ setPayPro()
+
+ : void
+
+Sets pay pro
+
+
+ toArray()
+
+ : array<string|int, mixed>
+
+Gets Wallet as array
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $avatar
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $avatar
+ = null
+
+
+
+
+
+
+
+
+ $currencies
+
+
+
+
+
+
+
+
+
+ protected
+ Currencies
+ $currencies
+
+
+
+
+
+
+
+
+
+ $displayName
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $displayName
+ = null
+
+
+
+
+
+
+
+
+ $image
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $image
+ = null
+
+
+
+
+
+
+
+
+ $key
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $key
+ = null
+
+
+
+
+
+
+
+
+ $payPro
+
+
+
+
+
+
+
+
+
+ protected
+ bool|null
+ $payPro
+ = null
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor, create a minimal request Wallet object.
+
+
+ public
+ __construct ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getAvatar()
+
+
+
+
+
+ Gets avatar
+
+
+ public
+ getAvatar ( ) : string|null
+
+
+
+ Filename of a wallet graphic (not fully qualified)
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getCurrencies()
+
+
+
+
+
+ Gets currencies
+
+
+ public
+ getCurrencies ( ) : Currencies
+
+
+
+ Details of what currencies support payments for this wallet
+
+
+
+
+
+
+
+
+
+
+ getDisplayName()
+
+
+
+
+
+ Gets display name
+
+
+ public
+ getDisplayName ( ) : string|null
+
+
+
+ Human readable display name for the wallet
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getImage()
+
+
+
+
+
+ Gets image
+
+
+ public
+ getImage ( ) : string|null
+
+
+
+ URL that displays wallet avatar image
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getKey()
+
+
+
+
+
+ Gets A unique identifier for the wallet
+
+
+ public
+ getKey ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+
+
+
+
+
+
+
+ getPayPro()
+
+
+
+
+
+ Gets pay pro
+
+
+ public
+ getPayPro ( ) : bool|null
+
+
+
+ Whether or not the wallet supports ANY BitPay Payment Protocol options
+
+
+
+
+
+
+ Return values
+ bool|null
+ —
+
+
+
+
+
+
+
+ setAvatar()
+
+
+
+
+
+ Sets avatar
+
+
+ public
+ setAvatar ( string $avatar ) : void
+
+
+
+ Filename of a wallet graphic (not fully qualified)
+
+
+ Parameters
+
+
+ $avatar
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCurrencies()
+
+
+
+
+
+ Sets currencies
+
+
+ public
+ setCurrencies ( Currencies $currencies ) : void
+
+
+
+ Details of what currencies support payments for this wallet
+
+
+ Parameters
+
+
+ $currencies
+ : Currencies
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setDisplayName()
+
+
+
+
+
+ Sets display name
+
+
+ public
+ setDisplayName ( string $displayName ) : void
+
+
+
+ Human readable display name for the wallet
+
+
+ Parameters
+
+
+ $displayName
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setImage()
+
+
+
+
+
+ Sets image
+
+
+ public
+ setImage ( string $image ) : void
+
+
+
+ URL that displays wallet avatar image
+
+
+ Parameters
+
+
+ $image
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setKey()
+
+
+
+
+
+ Sets A unique identifier for the wallet
+
+
+ public
+ setKey ( string $key ) : void
+
+
+
+
+ Parameters
+
+
+ $key
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayPro()
+
+
+
+
+
+ Sets pay pro
+
+
+ public
+ setPayPro ( bool $payPro ) : void
+
+
+
+ Whether or not the wallet supports ANY BitPay Payment Protocol options
+
+
+ Parameters
+
+
+ $payPro
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toArray()
+
+
+
+
+
+ Gets Wallet as array
+
+
+ public
+ toArray ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-PosClient.html b/docs/classes/BitPaySDK-PosClient.html
new file mode 100644
index 00000000..315bb679
--- /dev/null
+++ b/docs/classes/BitPaySDK-PosClient.html
@@ -0,0 +1,5923 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PosClient
+
+
+ extends Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client for handling POS facade specific calls.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $env
+
+ : string
+
+
+
+ $restCli
+
+ : RESTcli
+
+
+
+ $RESTcli
+
+ : RESTcli
+
+
+
+ $token
+
+ : Tokens
+
+
+
+ $tokenCache
+
+ : Tokens
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Constructor for the BitPay SDK to use with the POS facade.
+
+
+ cancelInvoice()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ cancelInvoiceByGuid()
+
+ : Invoice
+
+Cancel a BitPay invoice.
+
+
+ cancelPayout()
+
+ : bool
+
+Cancel a BitPay Payout.
+
+
+ cancelPayoutGroup()
+
+ : PayoutGroup
+
+
+
+ cancelRefund()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ cancelRefundByGuid()
+
+ : Refund
+
+Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ createBill()
+
+ : Bill
+
+Create a BitPay Bill.
+
+
+ createInvoice()
+
+ : Invoice
+
+Create a BitPay invoice.
+
+
+ createPayoutGroup()
+
+ : PayoutGroup
+
+
+
+ createRefund()
+
+ : Refund
+
+Create a refund for a BitPay invoice.
+
+
+ createWithData()
+
+ : Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
+
+ createWithFile()
+
+ : Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
+
+ deletePayoutRecipient()
+
+ : bool
+
+Delete a Payout Recipient.
+
+
+ deliverBill()
+
+ : bool
+
+Deliver a BitPay Bill.
+
+
+ getBill()
+
+ : Bill
+
+Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ getBills()
+
+ : array<string|int, Bill >
+
+Retrieve a collection of BitPay bills.
+
+
+ getCurrencies()
+
+ : array<string|int, mixed>
+
+Fetch the supported currencies.
+
+
+ getCurrencyPairRate()
+
+ : Rate
+
+Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ getCurrencyRates()
+
+ : Rates
+
+Retrieve all the rates for a given cryptocurrency
+
+
+ getInvoice()
+
+ : Invoice
+
+Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ getInvoiceByGuid()
+
+ : Invoice
+
+Retrieve a BitPay invoice by guid using the specified facade.
+
+
+ getInvoices()
+
+ : array<string|int, Invoice >
+
+Retrieve a collection of BitPay invoices.
+
+
+ getLedgerEntries()
+
+ : array<string|int, LedgerEntry >
+
+Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ getLedgers()
+
+ : array<string|int, Ledger >
+
+Retrieve a list of ledgers using the merchant facade.
+
+
+ getPayout()
+
+ : Payout
+
+Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ getPayoutRecipient()
+
+ : PayoutRecipient
+
+Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ getPayoutRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Retrieve a collection of BitPay Payout Recipients.
+
+
+ getPayouts()
+
+ : array<string|int, Payout >
+
+Retrieve a collection of BitPay payouts.
+
+
+ getRates()
+
+ : Rates
+
+Retrieve the exchange rate table maintained by BitPay.
+
+
+ getRefund()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice.
+
+
+ getRefundByGuid()
+
+ : Refund
+
+Retrieve a previously made refund request on a BitPay invoice.
+
+
+ getRefunds()
+
+ : array<string|int, Refund >
+
+Retrieve all refund requests on a BitPay invoice.
+
+
+ getSettlement()
+
+ : Settlement
+
+Retrieves a summary of the specified settlement.
+
+
+ getSettlementReconciliationReport()
+
+ : Settlement
+
+Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ getSettlements()
+
+ : array<string|int, Settlement >
+
+Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ getSupportedWallets()
+
+ : array<string|int, Wallet >
+
+Retrieve all supported wallets.
+
+
+ getTokens()
+
+ : array<string|int, mixed>
+
+Get Tokens.
+
+
+ payInvoice()
+
+ : Invoice
+
+Pay an invoice with a mock transaction
+
+
+ requestInvoiceNotification()
+
+ : bool
+
+Request a BitPay Invoice Webhook.
+
+
+ requestPayoutNotification()
+
+ : bool
+
+Notify BitPay Payout.
+
+
+ requestPayoutRecipientNotification()
+
+ : bool
+
+Notify BitPay Payout Recipient.
+
+
+ sendRefundNotification()
+
+ : bool
+
+Send a refund notification.
+
+
+ submitPayout()
+
+ : Payout
+
+Submit a BitPay Payout.
+
+
+ submitPayoutRecipients()
+
+ : array<string|int, PayoutRecipient >
+
+Submit BitPay Payout Recipients.
+
+
+ updateBill()
+
+ : Bill
+
+Update a BitPay Bill.
+
+
+ updateInvoice()
+
+ : Invoice
+
+Update a BitPay invoice.
+
+
+ updatePayoutRecipient()
+
+ : PayoutRecipient
+
+Update a Payout Recipient.
+
+
+ updateRefund()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ updateRefundByGuid()
+
+ : Refund
+
+Update the status of a BitPay invoice.
+
+
+ getBillClient()
+
+ : BillClient
+
+Gets bill client
+
+
+ getInvoiceClient()
+
+ : InvoiceClient
+
+Gets invoice client
+
+
+ getLedgerClient()
+
+ : LedgerClient
+
+Gets ledger client
+
+
+ getPayoutClient()
+
+ : PayoutClient
+
+Gets payout client
+
+
+ getPayoutRecipientsClient()
+
+ : PayoutRecipientsClient
+
+Gets payout recipients client
+
+
+ getRateClient()
+
+ : RateClient
+
+Gets rate client
+
+
+ getRefundClient()
+
+ : RefundClient
+
+Gets refund client
+
+
+ getSettlementClient()
+
+ : SettlementClient
+
+Gets settlement client
+
+
+ getWalletClient()
+
+ : WalletClient
+
+Gets wallet client
+
+
+ getConfigData()
+
+ : array<string|int, mixed>
+
+
+
+ getTokenClient()
+
+ : TokenClient
+
+Gets token client
+
+
+ init()
+
+ : void
+
+Initialize this object with the selected environment.
+
+
+ initKeys()
+
+ : PrivateKey |null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $env
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $env
+
+
+
+
+
+
+
+
+
+ $restCli
+
+
+
+
+
+
+
+
+
+ protected
+ RESTcli
+ $restCli
+
+
+
+
+
+
+
+
+
+ $RESTcli
+
+
+
+
+
+
+
+
+
+ protected
+ RESTcli
+ $RESTcli
+
+
+
+
+
+
+
+
+
+ $token
+
+
+
+
+
+
+
+
+
+ protected
+ Tokens
+ $token
+
+
+
+
+
+
+
+
+
+ $tokenCache
+
+
+
+
+
+
+
+
+
+ protected
+ Tokens
+ $tokenCache
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Constructor for the BitPay SDK to use with the POS facade.
+
+
+ public
+ __construct ( $token [ , string|null $environment = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $token
+ :
+
+
+ string The token generated on the BitPay account.
+
+
+
+
+ $environment
+ : string|null
+ = null
+
+ string The target environment [Default: Production].
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ cancelInvoice()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancelInvoice ( string $invoiceId [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-an-invoice
+
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ cancelInvoiceByGuid()
+
+
+
+
+
+ Cancel a BitPay invoice.
+
+
+ public
+ cancelInvoiceByGuid ( string $guid [ , bool $forceCancel = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the invoice to cancel.
+
+
+
+
+ $forceCancel
+ : bool
+ = false
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-an-invoice-by-guid
+
+ Cancel an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Cancelled invoice object.
+
+
+
+
+
+
+
+ cancelPayout()
+
+
+
+
+
+ Cancel a BitPay Payout.
+
+
+ public
+ cancelPayout ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to cancel.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ cancelPayoutGroup()
+
+
+
+
+
+
+
+ public
+ cancelPayoutGroup ( string $groupId ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $groupId
+ : string
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-payout-group
+
+
+
+
+
+ throws
+
+
+ PayoutCancellationException
+
+
+
+
+
+
+
+
+
+
+ cancelRefund()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancelRefund ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+ The refund Id for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-refund-request
+
+ Cancel a Refund Request
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ cancelRefundByGuid()
+
+
+
+
+
+ Cancel a previously submitted refund request on a BitPay invoice.
+
+
+ public
+ cancelRefundByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The refund Guid for the refund to be canceled.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/cancel-a-refund-by-guid-request
+
+ Cancel a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ RefundCancellationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Cancelled refund Object.
+
+
+
+
+
+
+
+ createBill()
+
+
+
+
+
+ Create a BitPay Bill.
+
+
+ public
+ createBill ( Bill $bill [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createInvoice()
+
+
+
+
+
+ Create a BitPay invoice.
+
+
+ public
+ createInvoice ( Invoice $invoice [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : Invoice
+
+
+ An Invoice object with request parameters defined.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-an-invoice
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createPayoutGroup()
+
+
+
+
+
+
+
+ public
+ createPayoutGroup ( array<string|int, Payout > $payouts ) : PayoutGroup
+
+
+
+
+ Parameters
+
+
+ $payouts
+ : array<string|int, Payout >
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-payout-group
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ createRefund()
+
+
+
+
+
+ Create a refund for a BitPay invoice.
+
+
+ public
+ createRefund ( string $invoiceId , float $amount , string $currency [ , bool $preview = false ] [ , bool $immediate = false ] [ , bool $buyerPaysRefundFee = false ] [ , string|null $guid = null ] ) : Refund
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice Id having the associated refund to be created.
+
+
+
+
+ $amount
+ : float
+
+
+ Amount to be refunded in the currency indicated.
+
+
+
+
+ $currency
+ : string
+
+
+ Reference currency used for the refund, usually the same as the currency used
+to create the invoice.
+
+
+
+
+ $preview
+ : bool
+ = false
+
+ Whether to create the refund request as a preview (which will not be acted on
+until status is updated)
+
+
+
+
+ $immediate
+ : bool
+ = false
+
+ Whether funds should be removed from merchant ledger immediately on submission
+or at time of processing
+
+
+
+
+ $buyerPaysRefundFee
+ : bool
+ = false
+
+ Whether the buyer should pay the refund fee (default is merchant)
+
+
+
+
+ $guid
+ : string|null
+ = null
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-refund-request
+
+ Create a Refund Request
+
+
+
+
+ throws
+
+
+ RefundCreationException
+
+ RefundCreationException class
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund An updated Refund Object
+
+
+
+
+
+
+
+ createWithData()
+
+
+
+
+
+ Constructor for use if the keys and SIN are managed by this library.
+
+
+ public
+ static createWithData ( string $environment , string $privateKey , Tokens $tokens [ , string|null $privateKeySecret = null ] [ , string|null $proxy = null ] ) : Client
+
+
+
+
+ Parameters
+
+
+ $environment
+ : string
+
+
+ Target environment. Options: Env.Test / Env.Prod
+
+
+
+
+ $privateKey
+ : string
+
+
+ Private Key file path or the HEX value.
+
+
+
+
+ $tokens
+ : Tokens
+
+
+ Tokens containing the available tokens.
+
+
+
+
+ $privateKeySecret
+ : string|null
+ = null
+
+ Private Key encryption password.
+
+
+
+
+ $proxy
+ : string|null
+ = null
+
+ The url of your proxy to forward requests through. Example:
+http://********.com:3128
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ createWithFile()
+
+
+
+
+
+ Constructor for use if the keys and SIN are managed by this library.
+
+
+ public
+ static createWithFile ( string $configFilePath ) : Client
+
+
+
+
+ Parameters
+
+
+ $configFilePath
+ : string
+
+
+ The path to the configuration file.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+ deletePayoutRecipient()
+
+
+
+
+
+ Delete a Payout Recipient.
+
+
+ public
+ deletePayoutRecipient ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be deleted.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/remove-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCancellationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the recipient was successfully deleted, false otherwise.
+
+
+
+
+
+
+
+ deliverBill()
+
+
+
+
+
+ Deliver a BitPay Bill.
+
+
+ public
+ deliverBill ( string $billId , string $billToken [ , bool $signRequest = true ] ) : bool
+
+
+
+
+ Parameters
+
+
+ $billId
+ : string
+
+
+ The id of the requested bill.
+
+
+
+
+ $billToken
+ : string
+
+
+ The token of the requested bill.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/deliver-a-bill-via-email
+
+ Deliver a Bill Via Email
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getBill()
+
+
+
+
+
+ Retrieve a BitPay bill by bill id using the specified facade.
+
+
+ public
+ getBill ( $billId [ , $facade = Facade::MERCHANT ] [ , $signRequest = true ] ) : Bill
+
+
+
+
+ Parameters
+
+
+ $billId
+ :
+
+
+ string The id of the bill to retrieve.
+
+
+
+
+ $facade
+ :
+ = Facade::MERCHANT
+
+ string The facade used to retrieve it.
+
+
+
+
+ $signRequest
+ :
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getBills()
+
+
+
+
+
+ Retrieve a collection of BitPay bills.
+
+
+ public
+ getBills ( [ string $status = null ] ) : array<string|int, Bill >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string
+ = null
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-bills-by-status
+
+ Retrieve Bills by Status
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Bill >
+
+
+
+
+
+ getCurrencies()
+
+
+
+
+
+ Fetch the supported currencies.
+
+
+ public
+ getCurrencies ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ CurrencyQueryException
+
+ CurrencyQueryException class
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+ —
+ A list of BitPay Invoice objects.
+
+
+
+
+
+
+
+ getCurrencyPairRate()
+
+
+
+
+
+ Retrieve the rate for a cryptocurrency / fiat pair
+
+
+ public
+ getCurrencyPairRate ( string $baseCurrency , string $currency ) : Rate
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the fiat-equivalent rate.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+ $currency
+ : string
+
+
+ The fiat currency for which you want to fetch the baseCurrency rate
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-the-rates-for-a-cryptocurrency-fiat-pair
+
+ Retrieve the rates for a cryptocurrency / fiat pair
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rate
+ —
+ A Rate object populated with the currency rate for the requested baseCurrency.
+
+
+
+
+
+
+
+ getCurrencyRates()
+
+
+
+
+
+ Retrieve all the rates for a given cryptocurrency
+
+
+ public
+ getCurrencyRates ( string $baseCurrency ) : Rates
+
+
+
+
+ Parameters
+
+
+ $baseCurrency
+ : string
+
+
+ The cryptocurrency for which you want to fetch the rates.
+Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-all-the-rates-for-a-given-cryptocurrency
+
+ Retrieve all the rates for a given cryptocurrency
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+ —
+ A Rates object populated with the currency rates for the requested baseCurrency.
+
+
+
+
+
+
+
+ getInvoice()
+
+
+
+
+
+ Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+authorized for the specified facade (the public facade requires no authorization).
+
+
+ public
+ getInvoice ( string $invoiceId [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to retrieve.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid
+
+ Retrieve an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getInvoiceByGuid()
+
+
+
+
+
+ Retrieve a BitPay invoice by guid using the specified facade.
+
+
+ public
+ getInvoiceByGuid ( string $guid [ , string $facade = Facade::MERCHANT ] [ , bool $signRequest = true ] ) : Invoice
+
+
+
+ The client must have been previously authorized for the specified facade.
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+ The guid of the invoice to retrieve.
+
+
+
+
+ $facade
+ : string
+ = Facade::MERCHANT
+
+ The facade used to create it.
+
+
+
+
+ $signRequest
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid
+
+ Retrieve an Invoice by GUID
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+
+
+
+
+
+
+ getInvoices()
+
+
+
+
+
+ Retrieve a collection of BitPay invoices.
+
+
+ public
+ getInvoices ( string $dateStart , string $dateEnd [ , string|null $status = null ] [ , string|null $orderId = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Invoice >
+
+
+
+
+ Parameters
+
+
+ $dateStart
+ : string
+
+
+ The start of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $dateEnd
+ : string
+
+
+ The end of the date window to query for invoices. Format YYYY-MM-DD.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The invoice status you want to query on.
+
+
+
+
+ $orderId
+ : string|null
+ = null
+
+ The optional order id specified at time of invoice creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results starting
+with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-invoices-filtered-by-query
+
+ Retrieve Invoices Filtered by Query
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Invoice >
+
+
+
+
+
+ getLedgerEntries()
+
+
+
+
+
+ Retrieve a list of ledgers by date range using the merchant facade.
+
+
+ public
+ getLedgerEntries ( string $currency , string $startDate , string $endDate ) : array<string|int, LedgerEntry >
+
+
+
+
+ Parameters
+
+
+ $currency
+ : string
+
+
+ The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $startDate
+ : string
+
+
+ The first date for the query filter.
+
+
+
+
+ $endDate
+ : string
+
+
+ The last date for the query filter.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-ledger-entries
+
+ Retrieve Ledger Entries
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, LedgerEntry >
+ —
+ A Ledger object populated with the BitPay ledger entries list.
+
+
+
+
+
+
+
+ getLedgers()
+
+
+
+
+
+ Retrieve a list of ledgers using the merchant facade.
+
+
+ public
+ getLedgers ( ) : array<string|int, Ledger >
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-account-balances
+
+ Retrieve Account Balances
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Ledger >
+ —
+ A list of Ledger objects populated with the currency and current balance of each one.
+
+
+
+
+
+
+
+ getPayout()
+
+
+
+
+
+ Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+for the payout facade.
+
+
+ public
+ getPayout ( string $payoutId ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the payout to retrieve.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipient()
+
+
+
+
+
+ Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+payout facade.
+
+
+ public
+ getPayoutRecipient ( string $recipientId ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to retrieve.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+ throws
+
+
+ PayoutRecipientQueryException
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipients()
+
+
+
+
+
+ Retrieve a collection of BitPay Payout Recipients.
+
+
+ public
+ getPayoutRecipients ( [ string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, PayoutRecipient >
+
+
+
+
+ Parameters
+
+
+ $status
+ : string|null
+ = null
+
+ The recipient status you want to query on.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-recipients-by-status
+
+ Retrieve Recipients by Status
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getPayouts()
+
+
+
+
+
+ Retrieve a collection of BitPay payouts.
+
+
+ public
+ getPayouts ( [ string|null $startDate = null ] [ , string|null $endDate = null ] [ , string|null $status = null ] [ , string|null $reference = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Payout >
+
+
+
+
+ Parameters
+
+
+ $startDate
+ : string|null
+ = null
+
+ The start date to filter the Payout Batches.
+
+
+
+
+ $endDate
+ : string|null
+ = null
+
+ The end date to filter the Payout Batches.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ The status to filter the Payout Batches.
+
+
+
+
+ $reference
+ : string|null
+ = null
+
+ The optional reference specified at payout request creation.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ Maximum results that the query will return (useful for paging results).
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+ Number of results to offset (ex. skip 10 will give you results
+starting with the 11th result).
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-payouts-filtered-by-query
+
+ Retrieve Payouts Filtered by Query
+
+
+
+
+ throws
+
+
+ PayoutQueryException
+
+
+
+
+
+
+ Return values
+ array<string|int, Payout >
+
+
+
+
+
+ getRates()
+
+
+
+
+
+ Retrieve the exchange rate table maintained by BitPay.
+
+
+ public
+ getRates ( ) : Rates
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://bitpay.com/bitcoin-exchange-rates
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Rates
+
+
+
+
+
+ getRefund()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice.
+
+
+ public
+ getRefund ( string $refundId ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-refund-request
+
+ Retrieve a Refund Request
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getRefundByGuid()
+
+
+
+
+
+ Retrieve a previously made refund request on a BitPay invoice.
+
+
+ public
+ getRefundByGuid ( string $guid ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-refund-by-guid-request
+
+ Retrieve a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ BitPay Refund object with the associated Refund object.
+
+
+
+
+
+
+
+ getRefunds()
+
+
+
+
+
+ Retrieve all refund requests on a BitPay invoice.
+
+
+ public
+ getRefunds ( string $invoiceId ) : array<string|int, Refund >
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The BitPay invoice object having the associated refunds.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-refunds-of-an-invoice
+
+ Retrieve Refunds of an Invoice
+
+
+
+
+ throws
+
+
+ RefundQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Refund >
+
+
+
+
+
+ getSettlement()
+
+
+
+
+
+ Retrieves a summary of the specified settlement.
+
+
+ public
+ getSettlement ( string $settlementId ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlementId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-a-settlement
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSettlementReconciliationReport()
+
+
+
+
+
+ Gets a detailed reconciliation report of the activity within the settlement period.
+
+
+ public
+ getSettlementReconciliationReport ( Settlement $settlement ) : Settlement
+
+
+
+
+ Parameters
+
+
+ $settlement
+ : Settlement
+
+
+ Settlement to generate report for.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/fetch-a-reconciliation-report
+
+ Fetch a Reconciliation Report
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSettlements()
+
+
+
+
+
+ Retrieves settlement reports for the calling merchant filtered by query.
+
+
+ public
+ getSettlements ( $currency , $dateStart , $dateEnd [ , string|null $status = null ] [ , int|null $limit = null ] [ , int|null $offset = null ] ) : array<string|int, Settlement >
+
+
+
+ The limit and offset parameters
+specify pages for large query sets.
+
+
+ Parameters
+
+
+ $currency
+ :
+
+
+ string The three digit currency string for the ledger to retrieve.
+
+
+
+
+ $dateStart
+ :
+
+
+ string The start date for the query.
+
+
+
+
+ $dateEnd
+ :
+
+
+ string The end date for the query.
+
+
+
+
+ $status
+ : string|null
+ = null
+
+ string Can be processing, completed, or failed.
+
+
+
+
+ $limit
+ : int|null
+ = null
+
+ int Maximum number of settlements to retrieve.
+
+
+
+
+ $offset
+ : int|null
+ = null
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-settlements
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ getSupportedWallets()
+
+
+
+
+
+ Retrieve all supported wallets.
+
+
+ public
+ getSupportedWallets ( ) : array<string|int, Wallet >
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-the-supported-wallets
+
+ Retrieve the Supported Wallets
+
+
+
+
+ throws
+
+
+ WalletQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, Wallet >
+
+
+
+
+
+ getTokens()
+
+
+
+
+
+ Get Tokens.
+
+
+ public
+ getTokens ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ JsonException
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ payInvoice()
+
+
+
+
+
+ Pay an invoice with a mock transaction
+
+
+ public
+ payInvoice ( string $invoiceId [ , string $status = 'confirmed' ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+ = 'confirmed'
+
+ Status the invoice will become. Acceptable values are confirmed (default) and complete.
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ InvoicePaymentException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Invoice
+ —
+ $invoice Invoice object.
+
+
+
+
+
+
+
+ requestInvoiceNotification()
+
+
+
+
+
+ Request a BitPay Invoice Webhook.
+
+
+ public
+ requestInvoiceNotification ( string $invoiceId ) : bool
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/retrieve-an-event-token
+
+ Retrieve an Event Token
+
+
+
+
+ throws
+
+
+ InvoiceQueryException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the webhook was successfully requested, false otherwise.
+
+
+
+
+
+
+
+ requestPayoutNotification()
+
+
+
+
+
+ Notify BitPay Payout.
+
+
+ public
+ requestPayoutNotification ( string $payoutId ) : bool
+
+
+
+
+ Parameters
+
+
+ $payoutId
+ : string
+
+
+ The id of the Payout to notify.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-payout-webhook-to-be-resent
+
+ Request a Payout Webhook to be Resent
+
+
+
+
+ throws
+
+
+ PayoutNotificationException
+
+
+
+
+
+
+
+
+
+
+
+ requestPayoutRecipientNotification()
+
+
+
+
+
+ Notify BitPay Payout Recipient.
+
+
+ public
+ requestPayoutRecipientNotification ( string $recipientId ) : bool
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The id of the recipient to notify.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-recipient-webhook-to-be-resent
+
+ Request a Recipient Webhook to be Resent
+
+
+
+
+ throws
+
+
+ PayoutRecipientNotificationException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ True if the notification was successfully sent, false otherwise.
+
+
+
+
+
+
+
+ sendRefundNotification()
+
+
+
+
+
+ Send a refund notification.
+
+
+ public
+ sendRefundNotification ( string $refundId ) : bool
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/request-a-refund-notification-to-be-resent
+
+ Request a Refund Notification to be Resent
+
+
+
+
+ throws
+
+
+ RefundCreationException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ $result An updated Refund Object
+
+
+
+
+
+
+
+ submitPayout()
+
+
+
+
+
+ Submit a BitPay Payout.
+
+
+ public
+ submitPayout ( Payout $payout ) : Payout
+
+
+
+
+ Parameters
+
+
+ $payout
+ : Payout
+
+
+ A Payout object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/create-a-payout
+
+
+
+
+
+ throws
+
+
+ PayoutCreationException
+
+
+
+
+
+
+
+
+
+
+ submitPayoutRecipients()
+
+
+
+
+
+ Submit BitPay Payout Recipients.
+
+
+ public
+ submitPayoutRecipients ( PayoutRecipients $recipients ) : array<string|int, PayoutRecipient >
+
+
+
+
+ Parameters
+
+
+ $recipients
+ : PayoutRecipients
+
+
+ A PayoutRecipients object with request parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/invite-recipients
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientCreationException
+
+
+
+
+
+
+ Return values
+ array<string|int, PayoutRecipient >
+ —
+ A list of BitPay PayoutRecipients objects.
+
+
+
+
+
+
+
+ updateBill()
+
+
+
+
+
+ Update a BitPay Bill.
+
+
+ public
+ updateBill ( Bill $bill , string $billId ) : Bill
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+ A Bill object with the parameters to update defined.
+
+
+
+
+ $billId
+ : string
+
+
+ The Id of the Bill to update.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-bill
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ updateInvoice()
+
+
+
+
+
+ Update a BitPay invoice.
+
+
+ public
+ updateInvoice ( string $invoiceId , string|null $buyerSms , string|null $smsCode , string|null $buyerEmail [ , bool $autoVerify = false ] ) : Invoice
+
+
+
+
+ Parameters
+
+
+ $invoiceId
+ : string
+
+
+ The id of the invoice to updated.
+
+
+
+
+ $buyerSms
+ : string|null
+
+
+ The buyer's cell number.
+
+
+
+
+ $smsCode
+ : string|null
+
+
+ The buyer's received verification code.
+
+
+
+
+ $buyerEmail
+ : string|null
+
+
+ The buyer's email address.
+
+
+
+
+ $autoVerify
+ : bool
+ = false
+
+ Skip the user verification on sandbox ONLY.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-an-invoice
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ InvoiceUpdateException
+
+
+
+
+
+
+
+
+
+
+ updatePayoutRecipient()
+
+
+
+
+
+ Update a Payout Recipient.
+
+
+ public
+ updatePayoutRecipient ( string $recipientId , PayoutRecipient $recipient ) : PayoutRecipient
+
+
+
+
+ Parameters
+
+
+ $recipientId
+ : string
+
+
+ The recipient id for the recipient to be updated.
+
+
+
+
+ $recipient
+ : PayoutRecipient
+
+
+ A PayoutRecipient object with updated parameters defined.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-recipient
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientUpdateException
+
+
+
+
+
+
+
+
+
+
+ updateRefund()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ updateRefund ( string $refundId , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $refundId
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-refund-request
+
+ Update a Refund Request
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ updateRefundByGuid()
+
+
+
+
+
+ Update the status of a BitPay invoice.
+
+
+ public
+ updateRefundByGuid ( string $guid , string $status ) : Refund
+
+
+
+
+ Parameters
+
+
+ $guid
+ : string
+
+
+
+
+
+
+ $status
+ : string
+
+
+ The new status for the refund to be updated.
+
+
+
+
+
+
+
+
+
+ see
+
+
+ https://developer.bitpay.com/reference/update-a-refund-by-guid-request
+
+ Update a Refund by GUID Request
+
+
+
+
+ throws
+
+
+ RefundUpdateException
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ Refund
+ —
+ $refund Refund A BitPay generated Refund object.
+
+
+
+
+
+
+
+ getBillClient()
+
+
+
+
+
+ Gets bill client
+
+
+ protected
+ getBillClient ( ) : BillClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getInvoiceClient()
+
+
+
+
+
+ Gets invoice client
+
+
+ protected
+ getInvoiceClient ( ) : InvoiceClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getLedgerClient()
+
+
+
+
+
+ Gets ledger client
+
+
+ protected
+ getLedgerClient ( ) : LedgerClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutClient()
+
+
+
+
+
+ Gets payout client
+
+
+ protected
+ getPayoutClient ( ) : PayoutClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutRecipientsClient()
+
+
+
+
+
+ Gets payout recipients client
+
+
+ protected
+ getPayoutRecipientsClient ( ) : PayoutRecipientsClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getRateClient()
+
+
+
+
+
+ Gets rate client
+
+
+ protected
+ getRateClient ( ) : RateClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getRefundClient()
+
+
+
+
+
+ Gets refund client
+
+
+ protected
+ getRefundClient ( ) : RefundClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getSettlementClient()
+
+
+
+
+
+ Gets settlement client
+
+
+ protected
+ getSettlementClient ( ) : SettlementClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getWalletClient()
+
+
+
+
+
+ Gets wallet client
+
+
+ protected
+ getWalletClient ( ) : WalletClient
+
+
+
+
+
+
+
+
+
+
+
+
+ getConfigData()
+
+
+
+
+
+
+
+ private
+ static getConfigData ( string $configFilePath ) : array<string|int, mixed>
+
+
+
+
+ Parameters
+
+
+ $configFilePath
+ : string
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ getTokenClient()
+
+
+
+
+
+ Gets token client
+
+
+ private
+ getTokenClient ( ) : TokenClient
+
+
+
+
+
+
+
+
+
+
+
+
+ init()
+
+
+
+
+
+ Initialize this object with the selected environment.
+
+
+ private
+ init ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ initKeys()
+
+
+
+
+
+
+
+ private
+ static initKeys ( string|null $privateKey , string|null $privateKeySecret ) : PrivateKey |null
+
+
+
+
+ Parameters
+
+
+ $privateKey
+ : string|null
+
+
+
+
+
+ $privateKeySecret
+ : string|null
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ PrivateKey |null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-ClientTest.html b/docs/classes/BitPaySDK-Test-ClientTest.html
new file mode 100644
index 00000000..9a044c9c
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-ClientTest.html
@@ -0,0 +1,8150 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ClientTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ CANCEL_REFUND_JSON_STRING
+
+ = '{
+ "id": "WoE46gSLkJQS48RJEiNw3L",
+ "invoice": "Hpqc63wvE1ZjzeeH4kEycF",
+ "reference": "Test refund",
+ "status": "cancelled",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 0.000594,
+ "transactionRefundFee": 0.000002,
+ "currency": "USD",
+ "lastRefundNotification": "2021-08-29T20:45:35.368Z",
+ "refundFee": 0.04,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2021-08-29T20:45:34.000Z"
+ }'
+
+
+
+ CORRECT_JSON_STRING
+
+ = '[
+ { "currency": "EUR", "balance": 0 },
+ { "currency": "USD", "balance": 2389.82 },
+ { "currency": "BTC", "balance": 0.000287 }
+ ]'
+
+
+
+ CORRUPT_JSON_STRING
+
+ = '{"code":"USD""name":"US Dollar","rate":21205.85}'
+
+
+
+ MERCHANT_TOKEN
+
+ = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb'
+
+
+
+ PAYOUT_TOKEN
+
+ = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb'
+
+
+
+ TEST_INVOICE_GUID
+
+ = 'chc9kj52-04g0-4b6f-941d-3a844e352758'
+
+
+
+ TEST_INVOICE_ID
+
+ = 'UZjwcYkWAKfTMn9J1yyfs4'
+
+
+
+ UPDATE_REFUND_JSON_STRING
+
+ = '{"id": "WoE46gSLkJQS48RJEiNw3L",
+ "invoice": "Hpqc63wvE1ZjzeeH4kEycF",
+ "reference": "Test refund",
+ "status": "created",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 0.000594,
+ "transactionRefundFee": 0.000002,
+ "currency": "USD",
+ "lastRefundNotification": "2021-08-29T20:45:35.368Z",
+ "refundFee": 0.04,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2021-08-29T20:45:34.000Z"
+ }'
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ exceptionClassProvider()
+
+ : array<string|int, mixed>
+
+
+
+ setUp()
+
+ : void
+
+
+
+ testCancelInvoice()
+
+ : mixed
+
+
+
+ testCancelInvoiceByGuid()
+
+ : mixed
+
+
+
+ testCancelInvoiceByGuidShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCancelInvoiceByGuidShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testCancelInvoiceShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCancelInvoiceShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testCancelPayout()
+
+ : mixed
+
+
+
+ testCancelPayoutGroup()
+
+ : void
+
+
+
+ testCancelPayoutShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testCancelPayoutShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testCancelPayoutShouldCatchUnexistentPropertyError()
+
+ : mixed
+
+
+
+ testCancelRefund()
+
+ : mixed
+
+
+
+ testCancelRefundByGuid()
+
+ : mixed
+
+
+
+ testCancelRefundByGuidShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCancelRefundByGuidShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testCancelRefundByGuidShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testCancelRefundShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCancelRefundShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testCancelRefundShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testCreateBill()
+
+ : mixed
+
+
+
+ testCreateBillException()
+
+ : mixed
+
+
+
+ testCreateBillShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCreateBillShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testCreateInvoice()
+
+ : mixed
+
+
+
+ testCreateInvoiceShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCreateInvoiceShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testCreatePayoutGroup()
+
+ : void
+
+
+
+ testCreateRefund()
+
+ : mixed
+
+
+
+ testCreateRefundShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testCreateRefundShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testCreateRefundShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testDeletePayoutRecipient()
+
+ : mixed
+
+
+
+ testDeletePayoutRecipientShouldCatchJsonDecodeException()
+
+ : mixed
+
+
+
+ testDeletePayoutRecipientShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testDeletePayoutRecipientShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testDeliverBill()
+
+ : mixed
+
+
+
+ testDeliverBillShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testDeliverBillShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetBill()
+
+ : mixed
+
+
+
+ testGetBills()
+
+ : mixed
+
+
+
+ testGetBillShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetBillShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetBillShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetBillsShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetBillsShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetBillsShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetCurrencyPairRate()
+
+ : mixed
+
+
+
+ testGetCurrencyPairRateShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetCurrencyPairRateShouldReturnExceptionWhenNoDataInJson()
+
+ : mixed
+
+
+
+ testGetCurrencyPairRateShouldThrowExceptionWhenResponseIsException()
+
+ : mixed
+
+
+
+ testGetCurrencyRates()
+
+ : mixed
+
+
+
+ testGetCurrencyRatesShouldFailWhenDataInvalid()
+
+ : mixed
+
+
+
+ testGetCurrencyRatesShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetCurrencyRatesShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetInvoice()
+
+ : mixed
+
+
+
+ testGetInvoiceByGuid()
+
+ : mixed
+
+
+
+ testGetInvoices()
+
+ : mixed
+
+
+
+ testGetInvoiceShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetInvoiceShouldCatchRestCliExceptions()
+
+ : void
+
+
+
+ testGetInvoicesShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetInvoicesShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testGetLedger()
+
+ : mixed
+
+
+
+ testGetLedgers()
+
+ : mixed
+
+
+
+ testGetLedgerShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetLedgerShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetLedgerShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetLedgersShouldCatchBitPayException()
+
+ : mixed
+
+
+
+ testGetLedgersShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetLedgersShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetPayout()
+
+ : mixed
+
+
+
+ testGetPayoutRecipient()
+
+ : mixed
+
+
+
+ testGetPayoutRecipients()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientShouldHandleJsonMapperException()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientsShouldHandleJsonMapperException()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientsShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetPayoutRecipientsShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetPayouts()
+
+ : mixed
+
+
+
+ testGetPayoutShouldHandleJsonMapperException()
+
+ : mixed
+
+
+
+ testGetPayoutShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetPayoutShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetPayoutsShouldHandleJsonMapperException()
+
+ : mixed
+
+
+
+ testGetPayoutsShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetPayoutsShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetRates()
+
+ : mixed
+
+
+
+ testGetRatesShouldHandleCorruptJson()
+
+ : mixed
+
+
+
+ testGetRatesShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetRatesShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetRefund()
+
+ : mixed
+
+
+
+ testGetRefundByGuid()
+
+ : mixed
+
+
+
+ testGetRefundByGuidShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetRefundByGuidShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetRefundByGuidShouldCatchRestCliJsonMapperException()
+
+ : mixed
+
+
+
+ testGetRefunds()
+
+ : mixed
+
+
+
+ testGetRefundShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetRefundShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetRefundShouldCatchRestCliJsonMapperException()
+
+ : mixed
+
+
+
+ testGetRefundsShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetRefundsShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetRefundsShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetSettlement()
+
+ : mixed
+
+
+
+ testGetSettlementReconciliationReport()
+
+ : mixed
+
+
+
+ testGetSettlementReconciliationReportShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetSettlementReconciliationReportShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetSettlementReconciliationReportShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetSettlements()
+
+ : mixed
+
+
+
+ testGetSettlementShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetSettlementShouldHandleRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetSettlementShouldHandleRestCliException()
+
+ : mixed
+
+
+
+ testGetSettlementsShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetSettlementsShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetSettlementsShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetSupportedWallets()
+
+ : mixed
+
+
+
+ testGetSupportedWalletsShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testGetSupportedWalletsShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testGetSupportedWalletsShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testGetTokens()
+
+ : void
+
+
+
+ testPayInvoice()
+
+ : mixed
+
+
+
+ testPayInvoiceShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testPayInvoiceShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testRequestInvoiceNotificationShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testRequestInvoiceNotificationShouldReturnFalseOnFailure()
+
+ : mixed
+
+
+
+ testRequestInvoiceNotificationShouldReturnTrueOnSuccess()
+
+ : mixed
+
+
+
+ testRequestNotification()
+
+ : mixed
+
+
+
+ testRequestNotificationShouldCatchJsonException()
+
+ : mixed
+
+
+
+ testRequestNotificationShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testRequestNotificationShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testRequestPayoutRecipientNotification()
+
+ : mixed
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchJsonDecodeException()
+
+ : mixed
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testSendRefundNotification()
+
+ : mixed
+
+
+
+ testSendRefundNotificationShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testSendRefundNotificationShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testSendRefundNotificationShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testSubmitPayout()
+
+ : mixed
+
+
+
+ testSubmitPayoutRecipients()
+
+ : mixed
+
+
+
+ testSubmitPayoutRecipientsShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testSubmitPayoutRecipientsShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testSubmitPayoutRecipientsShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testSubmitPayoutShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testSubmitPayoutShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testSubmitPayoutShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testUpdateBill()
+
+ : mixed
+
+
+
+ testUpdateBillShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testUpdateBillShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testUpdateBillShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testUpdateInvoice()
+
+ : mixed
+
+
+
+ testUpdateInvoiceShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testUpdateInvoiceShouldCatchRestCliExceptions()
+
+ : mixed
+
+
+
+ testUpdateInvoiceShouldThrowExceptionWhenBothBuyerEmailAndSmsProvided()
+
+ : mixed
+
+
+
+ testUpdateInvoiceShouldThrowExceptionWhenNoSmsCodeProvided()
+
+ : mixed
+
+
+
+ testUpdatePayoutRecipient()
+
+ : mixed
+
+
+
+ testUpdatePayoutRecipientShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testUpdatePayoutRecipientShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testUpdatePayoutRecipientShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testUpdateRefund()
+
+ : mixed
+
+
+
+ testUpdateRefundBuGuidShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testUpdateRefundBuGuidShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testUpdateRefundByGuid()
+
+ : mixed
+
+
+
+ testUpdateRefundByGuidShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testUpdateRefundShouldCatchJsonMapperException()
+
+ : mixed
+
+
+
+ testUpdateRefundShouldCatchRestCliBitPayException()
+
+ : mixed
+
+
+
+ testUpdateRefundShouldCatchRestCliException()
+
+ : mixed
+
+
+
+ testWithData()
+
+ : mixed
+
+
+
+ testWithDataException()
+
+ : mixed
+
+
+
+ testWithFileException()
+
+ : mixed
+
+
+
+ testWithFileJsonConfig()
+
+ : Client
+
+
+
+ testWithFileYmlConfig()
+
+ : mixed
+
+
+
+ getClient()
+
+ : mixed
+
+
+
+ getInvoiceRefundParams()
+
+ : array<string|int, mixed>
+
+
+
+ getPayoutParams()
+
+ : array<string|int, mixed>
+
+
+
+ getRestCliMock()
+
+ : mixed
+
+
+
+ getTestedClassInstance()
+
+ : Client
+
+
+
+ refreshResourceClients()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+ CANCEL_REFUND_JSON_STRING
+
+
+
+
+
+
+
+
+ private
+ mixed
+ CANCEL_REFUND_JSON_STRING
+ = '{
+ "id": "WoE46gSLkJQS48RJEiNw3L",
+ "invoice": "Hpqc63wvE1ZjzeeH4kEycF",
+ "reference": "Test refund",
+ "status": "cancelled",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 0.000594,
+ "transactionRefundFee": 0.000002,
+ "currency": "USD",
+ "lastRefundNotification": "2021-08-29T20:45:35.368Z",
+ "refundFee": 0.04,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2021-08-29T20:45:34.000Z"
+ }'
+
+
+
+
+
+
+
+
+
+
+ CORRECT_JSON_STRING
+
+
+
+
+
+
+
+
+ private
+ mixed
+ CORRECT_JSON_STRING
+ = '[
+ { "currency": "EUR", "balance": 0 },
+ { "currency": "USD", "balance": 2389.82 },
+ { "currency": "BTC", "balance": 0.000287 }
+ ]'
+
+
+
+
+
+
+
+
+
+
+ CORRUPT_JSON_STRING
+
+
+
+
+
+
+
+
+ private
+ mixed
+ CORRUPT_JSON_STRING
+ = '{"code":"USD""name":"US Dollar","rate":21205.85}'
+
+
+
+
+
+
+
+
+
+
+ MERCHANT_TOKEN
+
+
+
+
+
+
+
+
+ private
+ mixed
+ MERCHANT_TOKEN
+ = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb'
+
+
+
+
+
+
+
+
+
+
+ PAYOUT_TOKEN
+
+
+
+
+
+
+
+
+ private
+ mixed
+ PAYOUT_TOKEN
+ = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb'
+
+
+
+
+
+
+
+
+
+
+ TEST_INVOICE_GUID
+
+
+
+
+
+
+
+
+ private
+ mixed
+ TEST_INVOICE_GUID
+ = 'chc9kj52-04g0-4b6f-941d-3a844e352758'
+
+
+
+
+
+
+
+
+
+
+ TEST_INVOICE_ID
+
+
+
+
+
+
+
+
+ private
+ mixed
+ TEST_INVOICE_ID
+ = 'UZjwcYkWAKfTMn9J1yyfs4'
+
+
+
+
+
+
+
+
+
+
+ UPDATE_REFUND_JSON_STRING
+
+
+
+
+
+
+
+
+ private
+ mixed
+ UPDATE_REFUND_JSON_STRING
+ = '{"id": "WoE46gSLkJQS48RJEiNw3L",
+ "invoice": "Hpqc63wvE1ZjzeeH4kEycF",
+ "reference": "Test refund",
+ "status": "created",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 0.000594,
+ "transactionRefundFee": 0.000002,
+ "currency": "USD",
+ "lastRefundNotification": "2021-08-29T20:45:35.368Z",
+ "refundFee": 0.04,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2021-08-29T20:45:34.000Z"
+ }'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ exceptionClassProvider()
+
+
+
+
+
+
+
+ public
+ static exceptionClassProvider ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ setUp()
+
+
+
+
+
+
+
+ public
+ setUp ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ ReflectionException
+
+
+
+
+
+
+
+
+
+ testCancelInvoice()
+
+
+
+
+
+
+
+ public
+ testCancelInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceByGuid()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceByGuidShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceByGuidShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceByGuidShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceByGuidShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelInvoiceShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testCancelInvoiceShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testCancelPayout()
+
+
+
+
+
+
+
+ public
+ testCancelPayout ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelPayoutGroup()
+
+
+
+
+
+
+
+ public
+ testCancelPayoutGroup ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testCancelPayoutShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testCancelPayoutShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelPayoutShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCancelPayoutShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelPayoutShouldCatchUnexistentPropertyError()
+
+
+
+
+
+
+
+ public
+ testCancelPayoutShouldCatchUnexistentPropertyError ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefund()
+
+
+
+
+
+
+
+ public
+ testCancelRefund ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundByGuid()
+
+
+
+
+
+
+
+ public
+ testCancelRefundByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundByGuidShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundByGuidShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundByGuidShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundByGuidShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundByGuidShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundByGuidShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCancelRefundShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCancelRefundShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateBill()
+
+
+
+
+
+
+
+ public
+ testCreateBill ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateBillException()
+
+
+
+
+
+
+
+ public
+ testCreateBillException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateBillShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCreateBillShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateBillShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCreateBillShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateInvoice()
+
+
+
+
+
+
+
+ public
+ testCreateInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testCreateInvoiceShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCreateInvoiceShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateInvoiceShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testCreateInvoiceShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testCreatePayoutGroup()
+
+
+
+
+
+
+
+ public
+ testCreatePayoutGroup ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefund()
+
+
+
+
+
+
+
+ public
+ testCreateRefund ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefundShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testCreateRefundShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefundShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testCreateRefundShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testCreateRefundShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testCreateRefundShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeletePayoutRecipient()
+
+
+
+
+
+
+
+ public
+ testDeletePayoutRecipient ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeletePayoutRecipientShouldCatchJsonDecodeException()
+
+
+
+
+
+
+
+ public
+ testDeletePayoutRecipientShouldCatchJsonDecodeException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeletePayoutRecipientShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testDeletePayoutRecipientShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeletePayoutRecipientShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testDeletePayoutRecipientShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeliverBill()
+
+
+
+
+
+
+
+ public
+ testDeliverBill ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testDeliverBillShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testDeliverBillShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDeliverBillShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testDeliverBillShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBill()
+
+
+
+
+
+
+
+ public
+ testGetBill ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBills()
+
+
+
+
+
+
+
+ public
+ testGetBills ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetBillShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetBillShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetBillShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillsShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetBillsShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillsShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetBillsShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillsShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetBillsShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyPairRate()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyPairRate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyPairRateShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyPairRateShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyPairRateShouldReturnExceptionWhenNoDataInJson()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyPairRateShouldReturnExceptionWhenNoDataInJson ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyPairRateShouldThrowExceptionWhenResponseIsException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyPairRateShouldThrowExceptionWhenResponseIsException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyRates()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyRatesShouldFailWhenDataInvalid()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyRatesShouldFailWhenDataInvalid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyRatesShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyRatesShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencyRatesShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyRatesShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoice()
+
+
+
+
+
+
+
+ public
+ testGetInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceByGuid()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoices()
+
+
+
+
+
+
+
+ public
+ testGetInvoices ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceShouldCatchRestCliExceptions ( string $exceptionClass ) : void
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoicesShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetInvoicesShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoicesShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testGetInvoicesShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedger()
+
+
+
+
+
+
+
+ public
+ testGetLedger ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgers()
+
+
+
+
+
+
+
+ public
+ testGetLedgers ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetLedgerShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetLedgerShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetLedgerShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testGetLedgersShouldCatchBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testGetLedgersShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testGetLedgersShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayout()
+
+
+
+
+
+
+
+ public
+ testGetPayout ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipient()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipient ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipients()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipients ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientShouldHandleJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientShouldHandleJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientsShouldHandleJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientsShouldHandleJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientsShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientsShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutRecipientsShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutRecipientsShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayouts()
+
+
+
+
+
+
+
+ public
+ testGetPayouts ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutShouldHandleJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutShouldHandleJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutsShouldHandleJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutsShouldHandleJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutsShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutsShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutsShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetPayoutsShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRates()
+
+
+
+
+
+
+
+ public
+ testGetRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRatesShouldHandleCorruptJson()
+
+
+
+
+
+
+
+ public
+ testGetRatesShouldHandleCorruptJson ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRatesShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetRatesShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRatesShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetRatesShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefund()
+
+
+
+
+
+
+
+ public
+ testGetRefund ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundByGuid()
+
+
+
+
+
+
+
+ public
+ testGetRefundByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundByGuidShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetRefundByGuidShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundByGuidShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetRefundByGuidShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundByGuidShouldCatchRestCliJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetRefundByGuidShouldCatchRestCliJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefunds()
+
+
+
+
+
+
+
+ public
+ testGetRefunds ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetRefundShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetRefundShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundShouldCatchRestCliJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetRefundShouldCatchRestCliJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundsShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetRefundsShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundsShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetRefundsShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundsShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetRefundsShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlement()
+
+
+
+
+
+
+
+ public
+ testGetSettlement ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementReconciliationReport()
+
+
+
+
+
+
+
+ public
+ testGetSettlementReconciliationReport ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementReconciliationReportShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementReconciliationReportShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementReconciliationReportShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementReconciliationReportShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementReconciliationReportShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementReconciliationReportShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlements()
+
+
+
+
+
+
+
+ public
+ testGetSettlements ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementShouldHandleRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementShouldHandleRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementShouldHandleRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementShouldHandleRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementsShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementsShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementsShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementsShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementsShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetSettlementsShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportedWallets()
+
+
+
+
+
+
+
+ public
+ testGetSupportedWallets ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportedWalletsShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testGetSupportedWalletsShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportedWalletsShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testGetSupportedWalletsShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportedWalletsShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testGetSupportedWalletsShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTokens()
+
+
+
+
+
+
+
+ public
+ testGetTokens ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testPayInvoice()
+
+
+
+
+
+
+
+ public
+ testPayInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testPayInvoiceShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testPayInvoiceShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testPayInvoiceShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testPayInvoiceShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testRequestInvoiceNotificationShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testRequestInvoiceNotificationShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestInvoiceNotificationShouldReturnFalseOnFailure()
+
+
+
+
+
+
+
+ public
+ testRequestInvoiceNotificationShouldReturnFalseOnFailure ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestInvoiceNotificationShouldReturnTrueOnSuccess()
+
+
+
+
+
+
+
+ public
+ testRequestInvoiceNotificationShouldReturnTrueOnSuccess ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestNotification()
+
+
+
+
+
+
+
+ public
+ testRequestNotification ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestNotificationShouldCatchJsonException()
+
+
+
+
+
+
+
+ public
+ testRequestNotificationShouldCatchJsonException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestNotificationShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testRequestNotificationShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestNotificationShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testRequestNotificationShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestPayoutRecipientNotification()
+
+
+
+
+
+
+
+ public
+ testRequestPayoutRecipientNotification ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchJsonDecodeException()
+
+
+
+
+
+
+
+ public
+ testRequestPayoutRecipientNotificationShouldCatchJsonDecodeException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testRequestPayoutRecipientNotificationShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testRequestPayoutRecipientNotificationShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testRequestPayoutRecipientNotificationShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSendRefundNotification()
+
+
+
+
+
+
+
+ public
+ testSendRefundNotification ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testSendRefundNotificationShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testSendRefundNotificationShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testSendRefundNotificationShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testSendRefundNotificationShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testSendRefundNotificationShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testSendRefundNotificationShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayout()
+
+
+
+
+
+
+
+ public
+ testSubmitPayout ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutRecipients()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutRecipients ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutRecipientsShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutRecipientsShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+ depends
+
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutRecipientsShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutRecipientsShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutRecipientsShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutRecipientsShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSubmitPayoutShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testSubmitPayoutShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateBill()
+
+
+
+
+
+
+
+ public
+ testUpdateBill ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateBillShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testUpdateBillShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateBillShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testUpdateBillShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateBillShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testUpdateBillShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoice()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoiceShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoiceShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoiceShouldCatchRestCliExceptions()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoiceShouldCatchRestCliExceptions ( string $exceptionClass ) : mixed
+
+
+
+
+ Parameters
+
+
+ $exceptionClass
+ : string
+
+
+
+
+
+
+
+
+
+
+ dataProvider
+
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoiceShouldThrowExceptionWhenBothBuyerEmailAndSmsProvided()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoiceShouldThrowExceptionWhenBothBuyerEmailAndSmsProvided ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateInvoiceShouldThrowExceptionWhenNoSmsCodeProvided()
+
+
+
+
+
+
+
+ public
+ testUpdateInvoiceShouldThrowExceptionWhenNoSmsCodeProvided ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdatePayoutRecipient()
+
+
+
+
+
+
+
+ public
+ testUpdatePayoutRecipient ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientUpdateException
+
+
+
+
+
+
+
+
+
+ testUpdatePayoutRecipientShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testUpdatePayoutRecipientShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdatePayoutRecipientShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testUpdatePayoutRecipientShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdatePayoutRecipientShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testUpdatePayoutRecipientShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefund()
+
+
+
+
+
+
+
+ public
+ testUpdateRefund ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundBuGuidShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundBuGuidShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundBuGuidShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundBuGuidShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundByGuid()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundByGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundByGuidShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundByGuidShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundShouldCatchJsonMapperException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundShouldCatchJsonMapperException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundShouldCatchRestCliBitPayException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundShouldCatchRestCliBitPayException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdateRefundShouldCatchRestCliException()
+
+
+
+
+
+
+
+ public
+ testUpdateRefundShouldCatchRestCliException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testWithData()
+
+
+
+
+
+
+
+ public
+ testWithData ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testWithDataException()
+
+
+
+
+
+
+
+ public
+ testWithDataException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testWithFileException()
+
+
+
+
+
+
+
+ public
+ testWithFileException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testWithFileJsonConfig()
+
+
+
+
+
+
+
+ public
+ testWithFileJsonConfig ( ) : Client
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+ testWithFileYmlConfig()
+
+
+
+
+
+
+
+ public
+ testWithFileYmlConfig ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ getClient()
+
+
+
+
+
+
+
+ private
+ getClient ( RESTcli $restCli ) : mixed
+
+
+
+
+ Parameters
+
+
+ $restCli
+ : RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+ getInvoiceRefundParams()
+
+
+
+
+
+
+
+ private
+ getInvoiceRefundParams ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ getPayoutParams()
+
+
+
+
+
+
+
+ private
+ getPayoutParams ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ getRestCliMock()
+
+
+
+
+
+
+
+ private
+ getRestCliMock ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ getTestedClassInstance()
+
+
+
+
+
+
+
+ private
+ getTestedClassInstance ( ) : Client
+
+
+
+
+
+
+
+
+
+
+
+
+ refreshResourceClients()
+
+
+
+
+
+
+
+ private
+ refreshResourceClients ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ ReflectionException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BillCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BillCreationExceptionTest.html
new file mode 100644
index 00000000..3ed95121
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BillCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BillDeliveryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BillDeliveryExceptionTest.html
new file mode 100644
index 00000000..22b9f9ad
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BillDeliveryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillDeliveryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BillExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BillExceptionTest.html
new file mode 100644
index 00000000..216de4dd
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BillExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BillQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BillQueryExceptionTest.html
new file mode 100644
index 00000000..1bb062f4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BillQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BillUpdateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BillUpdateExceptionTest.html
new file mode 100644
index 00000000..cbd6bcc1
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BillUpdateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillUpdateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-BitPayExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-BitPayExceptionTest.html
new file mode 100644
index 00000000..e6d422e4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-BitPayExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPayExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-CurrencyExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-CurrencyExceptionTest.html
new file mode 100644
index 00000000..cd5d5c47
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-CurrencyExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-CurrencyQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-CurrencyQueryExceptionTest.html
new file mode 100644
index 00000000..7671dcfd
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-CurrencyQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCancellationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCancellationExceptionTest.html
new file mode 100644
index 00000000..b226326f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCancellationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCancellationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCreationExceptionTest.html
new file mode 100644
index 00000000..cf976bfe
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoiceExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceExceptionTest.html
new file mode 100644
index 00000000..c29b9da1
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoicePaymentExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoicePaymentExceptionTest.html
new file mode 100644
index 00000000..fb70cbf9
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoicePaymentExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoicePaymentExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoiceQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceQueryExceptionTest.html
new file mode 100644
index 00000000..22f765e1
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-InvoiceUpdateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceUpdateExceptionTest.html
new file mode 100644
index 00000000..ca9bc8d3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-InvoiceUpdateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceUpdateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-LedgerExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-LedgerExceptionTest.html
new file mode 100644
index 00000000..eada1546
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-LedgerExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-LedgerQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-LedgerQueryExceptionTest.html
new file mode 100644
index 00000000..e47a9009
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-LedgerQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCancellationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCancellationExceptionTest.html
new file mode 100644
index 00000000..273975d4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCancellationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCancellationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCreationExceptionTest.html
new file mode 100644
index 00000000..39d74c7b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchExceptionTest.html
new file mode 100644
index 00000000..3bf5a5f8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchNotificationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchNotificationExceptionTest.html
new file mode 100644
index 00000000..de7cd7e6
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchNotificationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchNotificationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchQueryExceptionTest.html
new file mode 100644
index 00000000..832ec8a7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutBatchQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutCancellationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutCancellationExceptionTest.html
new file mode 100644
index 00000000..b27fe617
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutCancellationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCancellationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutCreationExceptionTest.html
new file mode 100644
index 00000000..0ea25cc4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutExceptionTest.html
new file mode 100644
index 00000000..49b5ce84
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutNotificationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutNotificationExceptionTest.html
new file mode 100644
index 00000000..22e54e3d
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutNotificationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutNotificationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutQueryExceptionTest.html
new file mode 100644
index 00000000..a95e55cf
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCancellationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCancellationExceptionTest.html
new file mode 100644
index 00000000..4eb43dd7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCancellationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCancellationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCreationExceptionTest.html
new file mode 100644
index 00000000..7152f50b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientExceptionTest.html
new file mode 100644
index 00000000..932445df
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientNotificationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientNotificationExceptionTest.html
new file mode 100644
index 00000000..e0b08f8f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientNotificationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientNotificationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientQueryExceptionTest.html
new file mode 100644
index 00000000..69eb526e
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientUpdateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientUpdateExceptionTest.html
new file mode 100644
index 00000000..4b4d5562
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutRecipientUpdateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientUpdateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-PayoutUpdateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-PayoutUpdateExceptionTest.html
new file mode 100644
index 00000000..fdae5624
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-PayoutUpdateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutUpdateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RateExceptionTest.html
new file mode 100644
index 00000000..35bfea12
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RateQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RateQueryExceptionTest.html
new file mode 100644
index 00000000..47c00e27
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RateQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundCancellationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundCancellationExceptionTest.html
new file mode 100644
index 00000000..341137be
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundCancellationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCancellationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundCreationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundCreationExceptionTest.html
new file mode 100644
index 00000000..8e70cc99
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundCreationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCreationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundExceptionTest.html
new file mode 100644
index 00000000..516e46ed
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundNotificationExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundNotificationExceptionTest.html
new file mode 100644
index 00000000..2399564a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundNotificationExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundNotificationExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundQueryExceptionTest.html
new file mode 100644
index 00000000..0ea35b38
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-RefundUpdateExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-RefundUpdateExceptionTest.html
new file mode 100644
index 00000000..91112c7f
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-RefundUpdateExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundUpdateExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-SettlementExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-SettlementExceptionTest.html
new file mode 100644
index 00000000..8cc573d8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-SettlementExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-SettlementQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-SettlementQueryExceptionTest.html
new file mode 100644
index 00000000..d6273146
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-SettlementQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-WalletExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-WalletExceptionTest.html
new file mode 100644
index 00000000..9637d1ba
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-WalletExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Exceptions-WalletQueryExceptionTest.html b/docs/classes/BitPaySDK-Test-Exceptions-WalletQueryExceptionTest.html
new file mode 100644
index 00000000..f955c3b4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Exceptions-WalletQueryExceptionTest.html
@@ -0,0 +1,589 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletQueryExceptionTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testDefaultApiCode()
+
+ : mixed
+
+
+
+ testDefaultCode()
+
+ : mixed
+
+
+
+ testDefaultMessage()
+
+ : mixed
+
+
+
+ testGetApiCode()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultApiCode()
+
+
+
+
+
+
+
+ public
+ testDefaultApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultCode()
+
+
+
+
+
+
+
+ public
+ testDefaultCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testDefaultMessage()
+
+
+
+
+
+
+
+ public
+ testDefaultMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetApiCode()
+
+
+
+
+
+
+
+ public
+ testGetApiCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Bill-BillTest.html b/docs/classes/BitPaySDK-Test-Model-Bill-BillTest.html
new file mode 100644
index 00000000..729b8903
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Bill-BillTest.html
@@ -0,0 +1,1371 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAddress1()
+
+ : mixed
+
+
+
+ testGetAddress2()
+
+ : mixed
+
+
+
+ testGetCc()
+
+ : mixed
+
+
+
+ testGetCity()
+
+ : mixed
+
+
+
+ testGetCountry()
+
+ : mixed
+
+
+
+ testGetCreateDate()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetDueDate()
+
+ : mixed
+
+
+
+ testGetEmail()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetMerchant()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetNumber()
+
+ : mixed
+
+
+
+ testGetPassProcessingFee()
+
+ : mixed
+
+
+
+ testGetPhone()
+
+ : mixed
+
+
+
+ testGetState()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testGetUrl()
+
+ : mixed
+
+
+
+ testGetZip()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testSetItems()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Bill
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress1()
+
+
+
+
+
+
+
+ public
+ testGetAddress1 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress2()
+
+
+
+
+
+
+
+ public
+ testGetAddress2 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCc()
+
+
+
+
+
+
+
+ public
+ testGetCc ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCity()
+
+
+
+
+
+
+
+ public
+ testGetCity ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCountry()
+
+
+
+
+
+
+
+ public
+ testGetCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCreateDate()
+
+
+
+
+
+
+
+ public
+ testGetCreateDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetDueDate()
+
+
+
+
+
+
+
+ public
+ testGetDueDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmail()
+
+
+
+
+
+
+
+ public
+ testGetEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMerchant()
+
+
+
+
+
+
+
+ public
+ testGetMerchant ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNumber()
+
+
+
+
+
+
+
+ public
+ testGetNumber ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPassProcessingFee()
+
+
+
+
+
+
+
+ public
+ testGetPassProcessingFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPhone()
+
+
+
+
+
+
+
+ public
+ testGetPhone ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetState()
+
+
+
+
+
+
+
+ public
+ testGetState ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUrl()
+
+
+
+
+
+
+
+ public
+ testGetUrl ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetZip()
+
+
+
+
+
+
+
+ public
+ testGetZip ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testSetItems()
+
+
+
+
+
+
+
+ public
+ testSetItems ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Bill
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( Bill $bill ) : void
+
+
+
+
+ Parameters
+
+
+ $bill
+ : Bill
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Bill-ItemTest.html b/docs/classes/BitPaySDK-Test-Model-Bill-ItemTest.html
new file mode 100644
index 00000000..1b98380a
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Bill-ItemTest.html
@@ -0,0 +1,718 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testCreateFromArray()
+
+ : mixed
+
+
+
+ testGetDescription()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetPrice()
+
+ : mixed
+
+
+
+ testGetQuantity()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Item
+
+
+
+ objectSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testCreateFromArray()
+
+
+
+
+
+
+
+ public
+ testCreateFromArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDescription()
+
+
+
+
+
+
+
+ public
+ testGetDescription ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPrice()
+
+
+
+
+
+
+
+ public
+ testGetPrice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetQuantity()
+
+
+
+
+
+
+
+ public
+ testGetQuantity ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Item
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( Item $item ) : mixed
+
+
+
+
+ Parameters
+
+
+ $item
+ : Item
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-CurrencyTest.html b/docs/classes/BitPaySDK-Test-Model-CurrencyTest.html
new file mode 100644
index 00000000..949d164d
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-CurrencyTest.html
@@ -0,0 +1,1021 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAlts()
+
+ : mixed
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetCurrentlySettled()
+
+ : mixed
+
+
+
+ testGetDecimals()
+
+ : mixed
+
+
+
+ testGetMinimum()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetPayoutFields()
+
+ : mixed
+
+
+
+ testGetPlural()
+
+ : mixed
+
+
+
+ testGetPrecision()
+
+ : mixed
+
+
+
+ testGetSanctioned()
+
+ : mixed
+
+
+
+ testGetSettlementMinimum()
+
+ : mixed
+
+
+
+ testGetSymbol()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testIsValid()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Currency
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAlts()
+
+
+
+
+
+
+
+ public
+ testGetAlts ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrentlySettled()
+
+
+
+
+
+
+
+ public
+ testGetCurrentlySettled ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDecimals()
+
+
+
+
+
+
+
+ public
+ testGetDecimals ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMinimum()
+
+
+
+
+
+
+
+ public
+ testGetMinimum ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutFields()
+
+
+
+
+
+
+
+ public
+ testGetPayoutFields ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPlural()
+
+
+
+
+
+
+
+ public
+ testGetPlural ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPrecision()
+
+
+
+
+
+
+
+ public
+ testGetPrecision ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSanctioned()
+
+
+
+
+
+
+
+ public
+ testGetSanctioned ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSettlementMinimum()
+
+
+
+
+
+
+
+ public
+ testGetSettlementMinimum ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSymbol()
+
+
+
+
+
+
+
+ public
+ testGetSymbol ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testIsValid()
+
+
+
+
+
+
+
+ public
+ testIsValid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Currency
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( Currency $currency ) : mixed
+
+
+
+
+ Parameters
+
+
+ $currency
+ : Currency
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerProvidedInfoTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerProvidedInfoTest.html
new file mode 100644
index 00000000..8770e10b
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerProvidedInfoTest.html
@@ -0,0 +1,872 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerProvidedInfoTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetEmailAddress()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetPhoneNumber()
+
+ : mixed
+
+
+
+ testGetSelectedTransactionCurrency()
+
+ : mixed
+
+
+
+ testGetSelectedWallet()
+
+ : mixed
+
+
+
+ testGetSelectedWalletAsNull()
+
+ : void
+
+https://github.com/bitpay/php-bitpay-client-v2/issues/212
+
+
+ testGetSms()
+
+ : mixed
+
+
+
+ testGetSmsVerified()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : BuyerProvidedInfo
+
+
+
+ objectSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmailAddress()
+
+
+
+
+
+
+
+ public
+ testGetEmailAddress ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPhoneNumber()
+
+
+
+
+
+
+
+ public
+ testGetPhoneNumber ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSelectedTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testGetSelectedTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSelectedWallet()
+
+
+
+
+
+
+
+ public
+ testGetSelectedWallet ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSelectedWalletAsNull()
+
+
+
+
+
+ https://github.com/bitpay/php-bitpay-client-v2/issues/212
+
+
+ public
+ testGetSelectedWalletAsNull ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ testGetSms()
+
+
+
+
+
+
+
+ public
+ testGetSms ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSmsVerified()
+
+
+
+
+
+
+
+ public
+ testGetSmsVerified ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : BuyerProvidedInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( BuyerProvidedInfo $buyerProvidedInfo ) : mixed
+
+
+
+
+ Parameters
+
+
+ $buyerProvidedInfo
+ : BuyerProvidedInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerTest.html
new file mode 100644
index 00000000..217a9366
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-BuyerTest.html
@@ -0,0 +1,946 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAddress1()
+
+ : mixed
+
+
+
+ testGetAddress2()
+
+ : mixed
+
+
+
+ testGetCountry()
+
+ : mixed
+
+
+
+ testGetEmail()
+
+ : mixed
+
+
+
+ testGetLocality()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetNotify()
+
+ : mixed
+
+
+
+ testGetPhone()
+
+ : mixed
+
+
+
+ testGetPostalCode()
+
+ : mixed
+
+
+
+ testGetRegion()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Buyer
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress1()
+
+
+
+
+
+
+
+ public
+ testGetAddress1 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress2()
+
+
+
+
+
+
+
+ public
+ testGetAddress2 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCountry()
+
+
+
+
+
+
+
+ public
+ testGetCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmail()
+
+
+
+
+
+
+
+ public
+ testGetEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLocality()
+
+
+
+
+
+
+
+ public
+ testGetLocality ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotify()
+
+
+
+
+
+
+
+ public
+ testGetNotify ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPhone()
+
+
+
+
+
+
+
+ public
+ testGetPhone ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPostalCode()
+
+
+
+
+
+
+
+ public
+ testGetPostalCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRegion()
+
+
+
+
+
+
+
+ public
+ testGetRegion ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Buyer
+
+
+
+
+
+
+
+
+ Return values
+ Buyer
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( Buyer $buyer ) : mixed
+
+
+
+
+ Parameters
+
+
+ $buyer
+ : Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-InvoiceTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-InvoiceTest.html
new file mode 100644
index 00000000..0965e5c3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-InvoiceTest.html
@@ -0,0 +1,3062 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAcceptanceWindow()
+
+ : mixed
+
+
+
+ testGetAmountPaid()
+
+ : mixed
+
+
+
+ testGetAutoRedirect()
+
+ : mixed
+
+
+
+ testGetBillId()
+
+ : mixed
+
+
+
+ testGetBitpayIdRequired()
+
+ : mixed
+
+
+
+ testGetBuyer()
+
+ : mixed
+
+
+
+ testGetBuyerEmail()
+
+ : mixed
+
+
+
+ testGetBuyerProvidedEmail()
+
+ : mixed
+
+
+
+ testGetBuyerProvidedInfo()
+
+ : mixed
+
+
+
+ testGetBuyerSms()
+
+ : mixed
+
+
+
+ testGetCloseURL()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetCurrencyException()
+
+ : mixed
+
+
+
+ testGetCurrentTime()
+
+ : mixed
+
+
+
+ testGetDisplayAmountPaid()
+
+ : mixed
+
+
+
+ testGetExceptionStatus()
+
+ : mixed
+
+
+
+ testGetExchangeRates()
+
+ : mixed
+
+
+
+ testGetExpirationTime()
+
+ : mixed
+
+
+
+ testGetExtendedNotifications()
+
+ : mixed
+
+
+
+ testGetFeeDetected()
+
+ : mixed
+
+
+
+ testGetForcedBuyerSelectedTransactionCurrency()
+
+ : mixed
+
+
+
+ testGetForcedBuyerSelectedWallet()
+
+ : mixed
+
+
+
+ testGetFullNotifications()
+
+ : mixed
+
+
+
+ testGetGuid()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetInvoiceTime()
+
+ : mixed
+
+
+
+ testGetIsCancelled()
+
+ : mixed
+
+
+
+ testGetItemCode()
+
+ : mixed
+
+
+
+ testGetItemDesc()
+
+ : mixed
+
+
+
+ testGetItemizedDetailsAsArray()
+
+ : void
+
+
+
+ testGetJsonPayProRequired()
+
+ : mixed
+
+
+
+ testGetMerchantName()
+
+ : mixed
+
+
+
+ testGetMinerFees()
+
+ : mixed
+
+
+
+ testGetNonPayProPaymentReceived()
+
+ : mixed
+
+
+
+ testGetNotificationEmail()
+
+ : mixed
+
+
+
+ testGetNotificationURL()
+
+ : mixed
+
+
+
+ testGetOrderId()
+
+ : mixed
+
+
+
+ testGetOverpaidAmount()
+
+ : mixed
+
+
+
+ testGetPaymentCodes()
+
+ : mixed
+
+
+
+ testGetPaymentCurrencies()
+
+ : mixed
+
+
+
+ testGetPaymentDisplaySubTotals()
+
+ : mixed
+
+
+
+ testGetPaymentDisplayTotals()
+
+ : mixed
+
+
+
+ testGetPaymentSubTotals()
+
+ : mixed
+
+
+
+ testGetPaymentTotals()
+
+ : mixed
+
+
+
+ testGetPhysical()
+
+ : mixed
+
+
+
+ testGetPosData()
+
+ : mixed
+
+
+
+ testGetPrice()
+
+ : mixed
+
+
+
+ testGetRedirectURL()
+
+ : mixed
+
+
+
+ testGetRefundAddresses()
+
+ : mixed
+
+
+
+ testGetRefundAddressRequestPending()
+
+ : mixed
+
+
+
+ testGetRefundInfo()
+
+ : mixed
+
+
+
+ testGetSelectedTransactionCurrency()
+
+ : mixed
+
+
+
+ testGetShopper()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetSupportedTransactionCurrencies()
+
+ : mixed
+
+
+
+ testGetTargetConfirmations()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testgetTransactionCurrency()
+
+ : mixed
+
+
+
+ testGetTransactions()
+
+ : mixed
+
+
+
+ testGetTransactionSpeed()
+
+ : mixed
+
+
+
+ testGetUnderpaidAmount()
+
+ : mixed
+
+
+
+ testGetUniversalCodes()
+
+ : mixed
+
+
+
+ testGetUrl()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Invoice
+
+
+
+ getExampleExchangeRates()
+
+ : array<string|int, mixed>
+
+
+
+ setObjectSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAcceptanceWindow()
+
+
+
+
+
+
+
+ public
+ testGetAcceptanceWindow ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmountPaid()
+
+
+
+
+
+
+
+ public
+ testGetAmountPaid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAutoRedirect()
+
+
+
+
+
+
+
+ public
+ testGetAutoRedirect ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBillId()
+
+
+
+
+
+
+
+ public
+ testGetBillId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBitpayIdRequired()
+
+
+
+
+
+
+
+ public
+ testGetBitpayIdRequired ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyer()
+
+
+
+
+
+
+
+ public
+ testGetBuyer ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerEmail()
+
+
+
+
+
+
+
+ public
+ testGetBuyerEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerProvidedEmail()
+
+
+
+
+
+
+
+ public
+ testGetBuyerProvidedEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerProvidedInfo()
+
+
+
+
+
+
+
+ public
+ testGetBuyerProvidedInfo ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerSms()
+
+
+
+
+
+
+
+ public
+ testGetBuyerSms ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCloseURL()
+
+
+
+
+
+
+
+ public
+ testGetCloseURL ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetCurrencyException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrentTime()
+
+
+
+
+
+
+
+ public
+ testGetCurrentTime ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDisplayAmountPaid()
+
+
+
+
+
+
+
+ public
+ testGetDisplayAmountPaid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetExceptionStatus()
+
+
+
+
+
+
+
+ public
+ testGetExceptionStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetExchangeRates()
+
+
+
+
+
+
+
+ public
+ testGetExchangeRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetExpirationTime()
+
+
+
+
+
+
+
+ public
+ testGetExpirationTime ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetExtendedNotifications()
+
+
+
+
+
+
+
+ public
+ testGetExtendedNotifications ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetFeeDetected()
+
+
+
+
+
+
+
+ public
+ testGetFeeDetected ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetForcedBuyerSelectedTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testGetForcedBuyerSelectedTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetForcedBuyerSelectedWallet()
+
+
+
+
+
+
+
+ public
+ testGetForcedBuyerSelectedWallet ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetFullNotifications()
+
+
+
+
+
+
+
+ public
+ testGetFullNotifications ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetGuid()
+
+
+
+
+
+
+
+ public
+ testGetGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceTime()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceTime ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetIsCancelled()
+
+
+
+
+
+
+
+ public
+ testGetIsCancelled ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetItemCode()
+
+
+
+
+
+
+
+ public
+ testGetItemCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetItemDesc()
+
+
+
+
+
+
+
+ public
+ testGetItemDesc ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetItemizedDetailsAsArray()
+
+
+
+
+
+
+
+ public
+ testGetItemizedDetailsAsArray ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetJsonPayProRequired()
+
+
+
+
+
+
+
+ public
+ testGetJsonPayProRequired ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMerchantName()
+
+
+
+
+
+
+
+ public
+ testGetMerchantName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMinerFees()
+
+
+
+
+
+
+
+ public
+ testGetMinerFees ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNonPayProPaymentReceived()
+
+
+
+
+
+
+
+ public
+ testGetNonPayProPaymentReceived ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotificationEmail()
+
+
+
+
+
+
+
+ public
+ testGetNotificationEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotificationURL()
+
+
+
+
+
+
+
+ public
+ testGetNotificationURL ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOrderId()
+
+
+
+
+
+
+
+ public
+ testGetOrderId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOverpaidAmount()
+
+
+
+
+
+
+
+ public
+ testGetOverpaidAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentCodes()
+
+
+
+
+
+
+
+ public
+ testGetPaymentCodes ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentCurrencies()
+
+
+
+
+
+
+
+ public
+ testGetPaymentCurrencies ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentDisplaySubTotals()
+
+
+
+
+
+
+
+ public
+ testGetPaymentDisplaySubTotals ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentDisplayTotals()
+
+
+
+
+
+
+
+ public
+ testGetPaymentDisplayTotals ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentSubTotals()
+
+
+
+
+
+
+
+ public
+ testGetPaymentSubTotals ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentTotals()
+
+
+
+
+
+
+
+ public
+ testGetPaymentTotals ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPhysical()
+
+
+
+
+
+
+
+ public
+ testGetPhysical ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPosData()
+
+
+
+
+
+
+
+ public
+ testGetPosData ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPrice()
+
+
+
+
+
+
+
+ public
+ testGetPrice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRedirectURL()
+
+
+
+
+
+
+
+ public
+ testGetRedirectURL ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundAddresses()
+
+
+
+
+
+
+
+ public
+ testGetRefundAddresses ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundAddressRequestPending()
+
+
+
+
+
+
+
+ public
+ testGetRefundAddressRequestPending ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundInfo()
+
+
+
+
+
+
+
+ public
+ testGetRefundInfo ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSelectedTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testGetSelectedTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetShopper()
+
+
+
+
+
+
+
+ public
+ testGetShopper ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportedTransactionCurrencies()
+
+
+
+
+
+
+
+ public
+ testGetSupportedTransactionCurrencies ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTargetConfirmations()
+
+
+
+
+
+
+
+ public
+ testGetTargetConfirmations ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testgetTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testgetTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTransactions()
+
+
+
+
+
+
+
+ public
+ testGetTransactions ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTransactionSpeed()
+
+
+
+
+
+
+
+ public
+ testGetTransactionSpeed ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUnderpaidAmount()
+
+
+
+
+
+
+
+ public
+ testGetUnderpaidAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUniversalCodes()
+
+
+
+
+
+
+
+ public
+ testGetUniversalCodes ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUrl()
+
+
+
+
+
+
+
+ public
+ testGetUrl ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+ getExampleExchangeRates()
+
+
+
+
+
+
+
+ private
+ getExampleExchangeRates ( ) : array<string|int, mixed>
+
+
+
+
+
+
+
+
+ Return values
+ array<string|int, mixed>
+
+
+
+
+
+ setObjectSetters()
+
+
+
+
+
+
+
+ private
+ setObjectSetters ( Invoice $invoice ) : mixed
+
+
+
+
+ Parameters
+
+
+ $invoice
+ : Invoice
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-ItemizedDetailsTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-ItemizedDetailsTest.html
new file mode 100644
index 00000000..f694d9f2
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-ItemizedDetailsTest.html
@@ -0,0 +1,642 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemizedDetailsTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetDescription()
+
+ : mixed
+
+
+
+ testGetIsFee()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : ItemizedDetails
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDescription()
+
+
+
+
+
+
+
+ public
+ testGetDescription ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetIsFee()
+
+
+
+
+
+
+
+ public
+ testGetIsFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : ItemizedDetails
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( ItemizedDetails $itemizedDetails ) : mixed
+
+
+
+
+ Parameters
+
+
+ $itemizedDetails
+ : ItemizedDetails
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesItemTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesItemTest.html
new file mode 100644
index 00000000..c7fb6942
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesItemTest.html
@@ -0,0 +1,594 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesItemTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetFiatAmount()
+
+ : mixed
+
+
+
+ testGetSatoshisPerByte()
+
+ : mixed
+
+
+
+ testGetTotalFee()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetFiatAmount()
+
+
+
+
+
+
+
+ public
+ testGetFiatAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSatoshisPerByte()
+
+
+
+
+
+
+
+ public
+ testGetSatoshisPerByte ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTotalFee()
+
+
+
+
+
+
+
+ public
+ testGetTotalFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesTest.html
new file mode 100644
index 00000000..d0568590
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-MinerFeesTest.html
@@ -0,0 +1,898 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetBCH()
+
+ : mixed
+
+
+
+ testGetBTC()
+
+ : mixed
+
+
+
+ testGetBUSD()
+
+ : mixed
+
+
+
+ testGetDOGE()
+
+ : mixed
+
+
+
+ testGetETH()
+
+ : mixed
+
+
+
+ testGetGUSD()
+
+ : mixed
+
+
+
+ testGetLTC()
+
+ : mixed
+
+
+
+ testGetPAX()
+
+ : mixed
+
+
+
+ testGetUSDC()
+
+ : mixed
+
+
+
+ testGetXRP()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : MinerFees
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetBCH()
+
+
+
+
+
+
+
+ public
+ testGetBCH ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBTC()
+
+
+
+
+
+
+
+ public
+ testGetBTC ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBUSD()
+
+
+
+
+
+
+
+ public
+ testGetBUSD ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDOGE()
+
+
+
+
+
+
+
+ public
+ testGetDOGE ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetETH()
+
+
+
+
+
+
+
+ public
+ testGetETH ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetGUSD()
+
+
+
+
+
+
+
+ public
+ testGetGUSD ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLTC()
+
+
+
+
+
+
+
+ public
+ testGetLTC ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPAX()
+
+
+
+
+
+
+
+ public
+ testGetPAX ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUSDC()
+
+
+
+
+
+
+
+ public
+ testGetUSDC ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetXRP()
+
+
+
+
+
+
+
+ public
+ testGetXRP ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : MinerFees
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-RefundInfoTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundInfoTest.html
new file mode 100644
index 00000000..690943b4
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundInfoTest.html
@@ -0,0 +1,642 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfoTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmounts()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetSupportRequest()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : RefundInfo
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmounts()
+
+
+
+
+
+
+
+ public
+ testGetAmounts ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportRequest()
+
+
+
+
+
+
+
+ public
+ testGetSupportRequest ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( RefundInfo $refundInfo ) : mixed
+
+
+
+
+ Parameters
+
+
+ $refundInfo
+ : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-RefundTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundTest.html
new file mode 100644
index 00000000..cb676c74
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundTest.html
@@ -0,0 +1,1098 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetBuyerPaysRefundFee()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetGuid()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetImmediate()
+
+ : mixed
+
+
+
+ testGetInvoice()
+
+ : mixed
+
+
+
+ testGetInvoiceId()
+
+ : mixed
+
+
+
+ testGetLastRefundNotification()
+
+ : mixed
+
+
+
+ testGetPreview()
+
+ : mixed
+
+
+
+ testGetReference()
+
+ : mixed
+
+
+
+ testGetRefundFee()
+
+ : mixed
+
+
+
+ testGetRequestDate()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Refund
+
+
+
+ prepareRefund()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerPaysRefundFee()
+
+
+
+
+
+
+
+ public
+ testGetBuyerPaysRefundFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetGuid()
+
+
+
+
+
+
+
+ public
+ testGetGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testGetImmediate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoice()
+
+
+
+
+
+
+
+ public
+ testGetInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceId()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLastRefundNotification()
+
+
+
+
+
+
+
+ public
+ testGetLastRefundNotification ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPreview()
+
+
+
+
+
+
+
+ public
+ testGetPreview ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetReference()
+
+
+
+
+
+
+
+ public
+ testGetReference ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundFee()
+
+
+
+
+
+
+
+ public
+ testGetRefundFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRequestDate()
+
+
+
+
+
+
+
+ public
+ testGetRequestDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Refund
+
+
+
+
+
+
+
+
+
+
+
+
+ prepareRefund()
+
+
+
+
+
+
+
+ private
+ prepareRefund ( Refund $refund ) : void
+
+
+
+
+ Parameters
+
+
+ $refund
+ : Refund
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-RefundWebhookTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundWebhookTest.html
new file mode 100644
index 00000000..835c95b9
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-RefundWebhookTest.html
@@ -0,0 +1,946 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundWebhookTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetBuyerPaysRefundFee()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetInvoice()
+
+ : mixed
+
+
+
+ testGetLastRefundNotification()
+
+ : mixed
+
+
+
+ testGetRefundFee()
+
+ : mixed
+
+
+
+ testGetRequestDate()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetSupportRequest()
+
+ : mixed
+
+
+
+ testImmediate()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : RefundWebhook
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerPaysRefundFee()
+
+
+
+
+
+
+
+ public
+ testGetBuyerPaysRefundFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoice()
+
+
+
+
+
+
+
+ public
+ testGetInvoice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLastRefundNotification()
+
+
+
+
+
+
+
+ public
+ testGetLastRefundNotification ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundFee()
+
+
+
+
+
+
+
+ public
+ testGetRefundFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRequestDate()
+
+
+
+
+
+
+
+ public
+ testGetRequestDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportRequest()
+
+
+
+
+
+
+
+ public
+ testGetSupportRequest ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testImmediate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : RefundWebhook
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( RefundWebhook $refundWebhook ) : void
+
+
+
+
+ Parameters
+
+
+ $refundWebhook
+ : RefundWebhook
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-ShopperTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-ShopperTest.html
new file mode 100644
index 00000000..40822a56
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-ShopperTest.html
@@ -0,0 +1,556 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ShopperTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetUser()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyUser()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Shopper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetUser()
+
+
+
+
+
+
+
+ public
+ testGetUser ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyUser()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyUser ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Shopper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrenciesTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrenciesTest.html
new file mode 100644
index 00000000..4cc7f9f7
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrenciesTest.html
@@ -0,0 +1,784 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrenciesTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetBCH()
+
+ : mixed
+
+
+
+ testGetBTC()
+
+ : mixed
+
+
+
+ testGetETH()
+
+ : mixed
+
+
+
+ testGetGUSD()
+
+ : mixed
+
+
+
+ testGetPAX()
+
+ : mixed
+
+
+
+ testGetUSDC()
+
+ : mixed
+
+
+
+ testGetXRP()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : SupportedTransactionCurrencies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetBCH()
+
+
+
+
+
+
+
+ public
+ testGetBCH ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBTC()
+
+
+
+
+
+
+
+ public
+ testGetBTC ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetETH()
+
+
+
+
+
+
+
+ public
+ testGetETH ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetGUSD()
+
+
+
+
+
+
+
+ public
+ testGetGUSD ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPAX()
+
+
+
+
+
+
+
+ public
+ testGetPAX ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetUSDC()
+
+
+
+
+
+
+
+ public
+ testGetUSDC ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetXRP()
+
+
+
+
+
+
+
+ public
+ testGetXRP ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : SupportedTransactionCurrencies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrencyTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrencyTest.html
new file mode 100644
index 00000000..4bf04350
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-SupportedTransactionCurrencyTest.html
@@ -0,0 +1,642 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrencyTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetEnabled()
+
+ : mixed
+
+
+
+ testGetReason()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : SupportedTransactionCurrency
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetEnabled()
+
+
+
+
+
+
+
+ public
+ testGetEnabled ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetReason()
+
+
+
+
+
+
+
+ public
+ testGetReason ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : SupportedTransactionCurrency
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( SupportedTransactionCurrency $supportedTransactionCurrency ) : void
+
+
+
+
+ Parameters
+
+
+ $supportedTransactionCurrency
+ : SupportedTransactionCurrency
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Invoice-UniversalCodesTest.html b/docs/classes/BitPaySDK-Test-Model-Invoice-UniversalCodesTest.html
new file mode 100644
index 00000000..1da5ca45
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Invoice-UniversalCodesTest.html
@@ -0,0 +1,604 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UniversalCodesTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetPaymentString()
+
+ : mixed
+
+
+
+ testGetVerificationLink()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : UniversalCodes
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetPaymentString()
+
+
+
+
+
+
+
+ public
+ testGetPaymentString ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetVerificationLink()
+
+
+
+
+
+
+
+ public
+ testGetVerificationLink ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : UniversalCodes
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( UniversalCodes $universalCodes ) : mixed
+
+
+
+
+ Parameters
+
+
+ $universalCodes
+ : UniversalCodes
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Ledger-BuyerTest.html b/docs/classes/BitPaySDK-Test-Model-Ledger-BuyerTest.html
new file mode 100644
index 00000000..fbaa3496
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Ledger-BuyerTest.html
@@ -0,0 +1,908 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAddress1()
+
+ : mixed
+
+
+
+ testGetAddress2()
+
+ : mixed
+
+
+
+ testGetCity()
+
+ : mixed
+
+
+
+ testGetCountry()
+
+ : mixed
+
+
+
+ testGetEmail()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetNotify()
+
+ : mixed
+
+
+
+ testGetPhone()
+
+ : mixed
+
+
+
+ testGetState()
+
+ : mixed
+
+
+
+ testGetZip()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Buyer
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress1()
+
+
+
+
+
+
+
+ public
+ testGetAddress1 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress2()
+
+
+
+
+
+
+
+ public
+ testGetAddress2 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCity()
+
+
+
+
+
+
+
+ public
+ testGetCity ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCountry()
+
+
+
+
+
+
+
+ public
+ testGetCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmail()
+
+
+
+
+
+
+
+ public
+ testGetEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotify()
+
+
+
+
+
+
+
+ public
+ testGetNotify ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPhone()
+
+
+
+
+
+
+
+ public
+ testGetPhone ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetState()
+
+
+
+
+
+
+
+ public
+ testGetState ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetZip()
+
+
+
+
+
+
+
+ public
+ testGetZip ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Buyer
+
+
+
+
+
+
+
+
+ Return values
+ Buyer
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( Buyer $buyer ) : mixed
+
+
+
+
+ Parameters
+
+
+ $buyer
+ : Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerEntryTest.html b/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerEntryTest.html
new file mode 100644
index 00000000..4e67a0e8
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerEntryTest.html
@@ -0,0 +1,1098 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerEntryTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetBuyerFields()
+
+ : mixed
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetDescription()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetInvoiceAmount()
+
+ : mixed
+
+
+
+ testGetInvoiceCurrency()
+
+ : mixed
+
+
+
+ testGetInvoiceId()
+
+ : mixed
+
+
+
+ testGetScale()
+
+ : mixed
+
+
+
+ testGetSupportRequest()
+
+ : mixed
+
+
+
+ testGetTimestamp()
+
+ : mixed
+
+
+
+ testGetTransactionCurrency()
+
+ : mixed
+
+
+
+ testGetTxType()
+
+ : mixed
+
+
+
+ testGetType()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : LedgerEntry
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBuyerFields()
+
+
+
+
+
+
+
+ public
+ testGetBuyerFields ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDescription()
+
+
+
+
+
+
+
+ public
+ testGetDescription ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceAmount()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceCurrency()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceId()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetScale()
+
+
+
+
+
+
+
+ public
+ testGetScale ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportRequest()
+
+
+
+
+
+
+
+ public
+ testGetSupportRequest ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTimestamp()
+
+
+
+
+
+
+
+ public
+ testGetTimestamp ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testGetTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTxType()
+
+
+
+
+
+
+
+ public
+ testGetTxType ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetType()
+
+
+
+
+
+
+
+ public
+ testGetType ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( LedgerEntry $ledgerEntry ) : mixed
+
+
+
+
+ Parameters
+
+
+ $ledgerEntry
+ : LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerTest.html b/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerTest.html
new file mode 100644
index 00000000..ecc1fd34
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Ledger-LedgerTest.html
@@ -0,0 +1,556 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetBalance()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Ledger
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetBalance()
+
+
+
+
+
+
+
+ public
+ testGetBalance ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Ledger
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientTest.html b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientTest.html
new file mode 100644
index 00000000..4e08b132
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientTest.html
@@ -0,0 +1,784 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetEmail()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetLabel()
+
+ : mixed
+
+
+
+ testGetNotificationURL()
+
+ : mixed
+
+
+
+ testGetShopperId()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : PayoutRecipient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmail()
+
+
+
+
+
+
+
+ public
+ testGetEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLabel()
+
+
+
+
+
+
+
+ public
+ testGetLabel ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotificationURL()
+
+
+
+
+
+
+
+ public
+ testGetNotificationURL ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetShopperId()
+
+
+
+
+
+
+
+ public
+ testGetShopperId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : PayoutRecipient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientsTest.html b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientsTest.html
new file mode 100644
index 00000000..770e9a61
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutRecipientsTest.html
@@ -0,0 +1,685 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetGuid()
+
+ : mixed
+
+
+
+ testGetRecipientsArray()
+
+ : mixed
+
+
+
+ testGetRecipientsObject()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : PayoutRecipients
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetGuid()
+
+
+
+
+
+
+
+ public
+ testGetGuid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRecipientsArray()
+
+
+
+
+
+
+
+ public
+ testGetRecipientsArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ PayoutRecipientException
+
+
+
+
+
+
+
+
+
+ testGetRecipientsObject()
+
+
+
+
+
+
+
+ public
+ testGetRecipientsObject ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : PayoutRecipients
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Payout-PayoutTest.html b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutTest.html
new file mode 100644
index 00000000..edcc1b06
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Payout-PayoutTest.html
@@ -0,0 +1,1439 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testFormatAmount()
+
+ : mixed
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetCurrencyException()
+
+ : mixed
+
+
+
+ testGetEffectiveDate()
+
+ : mixed
+
+
+
+ testGetEmail()
+
+ : mixed
+
+
+
+ testGetExchangeRates()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetLabel()
+
+ : mixed
+
+
+
+ testGetLedgerCurrency()
+
+ : mixed
+
+
+
+ testGetLedgerCurrencyException()
+
+ : mixed
+
+
+
+ testGetMessage()
+
+ : mixed
+
+
+
+ testGetNotificationEmail()
+
+ : mixed
+
+
+
+ testGetNotificationUrl()
+
+ : mixed
+
+
+
+ testGetRecipientId()
+
+ : mixed
+
+
+
+ testGetReference()
+
+ : mixed
+
+
+
+ testGetRequestDate()
+
+ : mixed
+
+
+
+ testGetShopperId()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testGetTransactions()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testToArrayEmptyKey()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Payout
+
+
+
+ objectSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testFormatAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetCurrencyException()
+
+
+
+
+
+
+
+ public
+ testGetCurrencyException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetEffectiveDate()
+
+
+
+
+
+
+
+ public
+ testGetEffectiveDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetEmail()
+
+
+
+
+
+
+
+ public
+ testGetEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetExchangeRates()
+
+
+
+
+
+
+
+ public
+ testGetExchangeRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLabel()
+
+
+
+
+
+
+
+ public
+ testGetLabel ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerCurrency()
+
+
+
+
+
+
+
+ public
+ testGetLedgerCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetLedgerCurrencyException()
+
+
+
+
+
+
+
+ public
+ testGetLedgerCurrencyException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMessage()
+
+
+
+
+
+
+
+ public
+ testGetMessage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotificationEmail()
+
+
+
+
+
+
+
+ public
+ testGetNotificationEmail ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotificationUrl()
+
+
+
+
+
+
+
+ public
+ testGetNotificationUrl ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRecipientId()
+
+
+
+
+
+
+
+ public
+ testGetRecipientId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetReference()
+
+
+
+
+
+
+
+ public
+ testGetReference ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRequestDate()
+
+
+
+
+
+
+
+ public
+ testGetRequestDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetShopperId()
+
+
+
+
+
+
+
+ public
+ testGetShopperId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTransactions()
+
+
+
+
+
+
+
+ public
+ testGetTransactions ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testToArrayEmptyKey()
+
+
+
+
+
+
+
+ public
+ testToArrayEmptyKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Payout
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( Payout $payout ) : mixed
+
+
+
+
+ Parameters
+
+
+ $payout
+ : Payout
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Rate-RateTest.html b/docs/classes/BitPaySDK-Test-Model-Rate-RateTest.html
new file mode 100644
index 00000000..6d227ac3
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Rate-RateTest.html
@@ -0,0 +1,642 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetRate()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Rate
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRate()
+
+
+
+
+
+
+
+ public
+ testGetRate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Rate
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( Rate $rate ) : mixed
+
+
+
+
+ Parameters
+
+
+ $rate
+ : Rate
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Rate-RatesTest.html b/docs/classes/BitPaySDK-Test-Model-Rate-RatesTest.html
new file mode 100644
index 00000000..ad021afd
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Rate-RatesTest.html
@@ -0,0 +1,700 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RatesTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetRate()
+
+ : mixed
+
+
+
+ testGetRateException()
+
+ : mixed
+
+
+
+ testGetRates()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ testUpdate()
+
+ : void
+
+
+
+ testUpdateShouldThrowsExceptionsForInvalidRateFormat()
+
+ : void
+
+
+
+ createClassObject()
+
+ : Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetRate()
+
+
+
+
+
+
+
+ public
+ testGetRate ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ testGetRateException()
+
+
+
+
+
+
+
+ public
+ testGetRateException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRates()
+
+
+
+
+
+
+
+ public
+ testGetRates ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testUpdate()
+
+
+
+
+
+
+
+ public
+ testUpdate ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testUpdateShouldThrowsExceptionsForInvalidRateFormat ( ) : void
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Rates
+
+
+
+
+
+
+
+
+ Return values
+ Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-InvoiceDataTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-InvoiceDataTest.html
new file mode 100644
index 00000000..47e04534
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-InvoiceDataTest.html
@@ -0,0 +1,832 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceDataTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetDate()
+
+ : mixed
+
+
+
+ testGetOrderId()
+
+ : mixed
+
+
+
+ testGetOverPaidAmount()
+
+ : mixed
+
+
+
+ testGetPayoutPercentage()
+
+ : mixed
+
+
+
+ testGetPrice()
+
+ : mixed
+
+
+
+ testGetRefundInfo()
+
+ : mixed
+
+
+
+ testGetTransactionCurrency()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : InvoiceData
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDate()
+
+
+
+
+
+
+
+ public
+ testGetDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOrderId()
+
+
+
+
+
+
+
+ public
+ testGetOrderId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOverPaidAmount()
+
+
+
+
+
+
+
+ public
+ testGetOverPaidAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutPercentage()
+
+
+
+
+
+
+
+ public
+ testGetPayoutPercentage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPrice()
+
+
+
+
+
+
+
+ public
+ testGetPrice ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundInfo()
+
+
+
+
+
+
+
+ public
+ testGetRefundInfo ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTransactionCurrency()
+
+
+
+
+
+
+
+ public
+ testGetTransactionCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : InvoiceData
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( InvoiceData $invoiceData ) : mixed
+
+
+
+
+ Parameters
+
+
+ $invoiceData
+ : InvoiceData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-PayoutInfoTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-PayoutInfoTest.html
new file mode 100644
index 00000000..5ea65be5
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-PayoutInfoTest.html
@@ -0,0 +1,1440 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutInfoTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAccount()
+
+ : mixed
+
+
+
+ testGetAccountHolderAddress()
+
+ : mixed
+
+
+
+ testGetAccountHolderAddress2()
+
+ : mixed
+
+
+
+ testGetAccountHolderCity()
+
+ : mixed
+
+
+
+ testGetAccountHolderCountry()
+
+ : mixed
+
+
+
+ testGetAccountHolderName()
+
+ : mixed
+
+
+
+ testGetAccountHolderPostalCode()
+
+ : mixed
+
+
+
+ testGetAdditionalInformation()
+
+ : mixed
+
+
+
+ testGetAddress()
+
+ : mixed
+
+
+
+ testGetBank()
+
+ : mixed
+
+
+
+ testGetBankAddress()
+
+ : mixed
+
+
+
+ testGetBankAddress2()
+
+ : mixed
+
+
+
+ testGetBankCountry()
+
+ : mixed
+
+
+
+ testGetBankName()
+
+ : mixed
+
+
+
+ testGetCity()
+
+ : mixed
+
+
+
+ testGetIban()
+
+ : mixed
+
+
+
+ testGetLabel()
+
+ : mixed
+
+
+
+ testGetMerchantEin()
+
+ : mixed
+
+
+
+ testGetName()
+
+ : mixed
+
+
+
+ testGetPostal()
+
+ : mixed
+
+
+
+ testGetRouting()
+
+ : mixed
+
+
+
+ testGetSort()
+
+ : mixed
+
+
+
+ testGetSwift()
+
+ : mixed
+
+
+
+ testGetWire()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : PayoutInfo
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccount()
+
+
+
+
+
+
+
+ public
+ testGetAccount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderAddress()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderAddress ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderAddress2()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderAddress2 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderCity()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderCity ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderCountry()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderName()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountHolderPostalCode()
+
+
+
+
+
+
+
+ public
+ testGetAccountHolderPostalCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ testGetAdditionalInformation ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetAddress()
+
+
+
+
+
+
+
+ public
+ testGetAddress ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBank()
+
+
+
+
+
+
+
+ public
+ testGetBank ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBankAddress()
+
+
+
+
+
+
+
+ public
+ testGetBankAddress ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBankAddress2()
+
+
+
+
+
+
+
+ public
+ testGetBankAddress2 ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBankCountry()
+
+
+
+
+
+
+
+ public
+ testGetBankCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBankName()
+
+
+
+
+
+
+
+ public
+ testGetBankName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCity()
+
+
+
+
+
+
+
+ public
+ testGetCity ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetIban()
+
+
+
+
+
+
+
+ public
+ testGetIban ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLabel()
+
+
+
+
+
+
+
+ public
+ testGetLabel ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetMerchantEin()
+
+
+
+
+
+
+
+ public
+ testGetMerchantEin ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetName()
+
+
+
+
+
+
+
+ public
+ testGetName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPostal()
+
+
+
+
+
+
+
+ public
+ testGetPostal ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRouting()
+
+
+
+
+
+
+
+ public
+ testGetRouting ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSort()
+
+
+
+
+
+
+
+ public
+ testGetSort ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSwift()
+
+
+
+
+
+
+
+ public
+ testGetSwift ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetWire()
+
+
+
+
+
+
+
+ public
+ testGetWire ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : PayoutInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( PayoutInfo $payoutInfo ) : mixed
+
+
+
+
+ Parameters
+
+
+ $payoutInfo
+ : PayoutInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-RefundInfoTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-RefundInfoTest.html
new file mode 100644
index 00000000..4b102535
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-RefundInfoTest.html
@@ -0,0 +1,680 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfoTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmounts()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetRefundRequestEid()
+
+ : mixed
+
+
+
+ testGetSupportRequest()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : RefundInfo
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmounts()
+
+
+
+
+
+
+
+ public
+ testGetAmounts ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetRefundRequestEid()
+
+
+
+
+
+
+
+ public
+ testGetRefundRequestEid ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetSupportRequest()
+
+
+
+
+
+
+
+ public
+ testGetSupportRequest ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( RefundInfo $refundInfo ) : mixed
+
+
+
+
+ Parameters
+
+
+ $refundInfo
+ : RefundInfo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementLedgerEntryTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementLedgerEntryTest.html
new file mode 100644
index 00000000..569ed431
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementLedgerEntryTest.html
@@ -0,0 +1,794 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementLedgerEntryTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetDescription()
+
+ : mixed
+
+
+
+ testGetInvoiceData()
+
+ : mixed
+
+
+
+ testGetInvoiceId()
+
+ : mixed
+
+
+
+ testGetReference()
+
+ : mixed
+
+
+
+ testGetTimestamp()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : SettlementLedgerEntry
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDescription()
+
+
+
+
+
+
+
+ public
+ testGetDescription ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceData()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceData ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetInvoiceId()
+
+
+
+
+
+
+
+ public
+ testGetInvoiceId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetReference()
+
+
+
+
+
+
+
+ public
+ testGetReference ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTimestamp()
+
+
+
+
+
+
+
+ public
+ testGetTimestamp ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : SettlementLedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( SettlementLedgerEntry $settlementLedgerEntry ) : mixed
+
+
+
+
+ Parameters
+
+
+ $settlementLedgerEntry
+ : SettlementLedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementTest.html
new file mode 100644
index 00000000..6e630f73
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-SettlementTest.html
@@ -0,0 +1,1309 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+ Constants
+
+
+
+
+
+ LEDGER_ENTRY_AMOUNT
+
+ = 42.24
+
+
+
+ WITH_HOLDINGS_AMOUNT
+
+ = 12.34
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAccountId()
+
+ : mixed
+
+
+
+ testGetClosingDate()
+
+ : mixed
+
+
+
+ testGetCurrency()
+
+ : mixed
+
+
+
+ testGetDateCompleted()
+
+ : mixed
+
+
+
+ testGetDateCreated()
+
+ : mixed
+
+
+
+ testGetDateExecuted()
+
+ : mixed
+
+
+
+ testGetId()
+
+ : mixed
+
+
+
+ testGetLedgerEntries()
+
+ : mixed
+
+
+
+ testGetLedgerEntriesSum()
+
+ : mixed
+
+
+
+ testGetOpeningBalance()
+
+ : mixed
+
+
+
+ testGetOpeningDate()
+
+ : mixed
+
+
+
+ testGetPayoutInfo()
+
+ : mixed
+
+
+
+ testGetStatus()
+
+ : mixed
+
+
+
+ testGetToken()
+
+ : mixed
+
+
+
+ testGetTotalAmount()
+
+ : mixed
+
+
+
+ testGetWithHoldings()
+
+ : mixed
+
+
+
+ testGetWithHoldingsSum()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Settlement
+
+
+
+ prepareSettlementForTests()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+ LEDGER_ENTRY_AMOUNT
+
+
+
+
+
+
+
+
+ private
+ mixed
+ LEDGER_ENTRY_AMOUNT
+ = 42.24
+
+
+
+
+
+
+
+
+
+
+ WITH_HOLDINGS_AMOUNT
+
+
+
+
+
+
+
+
+ private
+ mixed
+ WITH_HOLDINGS_AMOUNT
+ = 12.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAccountId()
+
+
+
+
+
+
+
+ public
+ testGetAccountId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetClosingDate()
+
+
+
+
+
+
+
+ public
+ testGetClosingDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrency()
+
+
+
+
+
+
+
+ public
+ testGetCurrency ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDateCompleted()
+
+
+
+
+
+
+
+ public
+ testGetDateCompleted ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDateCreated()
+
+
+
+
+
+
+
+ public
+ testGetDateCreated ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDateExecuted()
+
+
+
+
+
+
+
+ public
+ testGetDateExecuted ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetId()
+
+
+
+
+
+
+
+ public
+ testGetId ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLedgerEntries()
+
+
+
+
+
+
+
+ public
+ testGetLedgerEntries ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementException
+
+
+
+
+
+
+
+
+
+ testGetLedgerEntriesSum()
+
+
+
+
+
+
+
+ public
+ testGetLedgerEntriesSum ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOpeningBalance()
+
+
+
+
+
+
+
+ public
+ testGetOpeningBalance ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetOpeningDate()
+
+
+
+
+
+
+
+ public
+ testGetOpeningDate ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayoutInfo()
+
+
+
+
+
+
+
+ public
+ testGetPayoutInfo ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetStatus()
+
+
+
+
+
+
+
+ public
+ testGetStatus ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetToken()
+
+
+
+
+
+
+
+ public
+ testGetToken ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetTotalAmount()
+
+
+
+
+
+
+
+ public
+ testGetTotalAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetWithHoldings()
+
+
+
+
+
+
+
+ public
+ testGetWithHoldings ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetWithHoldingsSum()
+
+
+
+
+
+
+
+ public
+ testGetWithHoldingsSum ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementException
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Settlement
+
+
+
+
+
+
+
+
+
+
+
+
+ prepareSettlementForTests()
+
+
+
+
+
+
+
+ private
+ prepareSettlementForTests ( Settlement $settlement ) : mixed
+
+
+
+
+ Parameters
+
+
+ $settlement
+ : Settlement
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ SettlementException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Settlement-WithHoldingsTest.html b/docs/classes/BitPaySDK-Test-Model-Settlement-WithHoldingsTest.html
new file mode 100644
index 00000000..93dbd312
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Settlement-WithHoldingsTest.html
@@ -0,0 +1,756 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WithHoldingsTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAmount()
+
+ : mixed
+
+
+
+ testGetBankCountry()
+
+ : mixed
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetDescription()
+
+ : mixed
+
+
+
+ testGetLabel()
+
+ : mixed
+
+
+
+ testGetNotes()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : WithHoldings
+
+
+
+ setSetters()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAmount()
+
+
+
+
+
+
+
+ public
+ testGetAmount ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetBankCountry()
+
+
+
+
+
+
+
+ public
+ testGetBankCountry ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDescription()
+
+
+
+
+
+
+
+ public
+ testGetDescription ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetLabel()
+
+
+
+
+
+
+
+ public
+ testGetLabel ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetNotes()
+
+
+
+
+
+
+
+ public
+ testGetNotes ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+ setSetters()
+
+
+
+
+
+
+
+ private
+ setSetters ( WithHoldings $withHoldings ) : mixed
+
+
+
+
+ Parameters
+
+
+ $withHoldings
+ : WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Wallet-CurrenciesTest.html b/docs/classes/BitPaySDK-Test-Model-Wallet-CurrenciesTest.html
new file mode 100644
index 00000000..5e9c350d
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Wallet-CurrenciesTest.html
@@ -0,0 +1,832 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrenciesTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetCode()
+
+ : mixed
+
+
+
+ testGetDappBrowser()
+
+ : mixed
+
+
+
+ testGetImage()
+
+ : mixed
+
+
+
+ testGetP2p()
+
+ : mixed
+
+
+
+ testGetPayPro()
+
+ : mixed
+
+
+
+ testGetQr()
+
+ : mixed
+
+
+
+ testGetWalletConnect()
+
+ : mixed
+
+
+
+ testGetWithdrawalFee()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Currencies
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetCode()
+
+
+
+
+
+
+
+ public
+ testGetCode ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDappBrowser()
+
+
+
+
+
+
+
+ public
+ testGetDappBrowser ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetImage()
+
+
+
+
+
+
+
+ public
+ testGetImage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetP2p()
+
+
+
+
+
+
+
+ public
+ testGetP2p ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayPro()
+
+
+
+
+
+
+
+ public
+ testGetPayPro ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetQr()
+
+
+
+
+
+
+
+ public
+ testGetQr ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetWalletConnect()
+
+
+
+
+
+
+
+ public
+ testGetWalletConnect ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetWithdrawalFee()
+
+
+
+
+
+
+
+ public
+ testGetWithdrawalFee ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Currencies
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( Currencies $currencies ) : void
+
+
+
+
+ Parameters
+
+
+ $currencies
+ : Currencies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Wallet-CurrencyQrTest.html b/docs/classes/BitPaySDK-Test-Model-Wallet-CurrencyQrTest.html
new file mode 100644
index 00000000..af4e9beb
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Wallet-CurrencyQrTest.html
@@ -0,0 +1,604 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQrTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetCollapsed()
+
+ : mixed
+
+
+
+ testGetType()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : CurrencyQr
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetCollapsed()
+
+
+
+
+
+
+
+ public
+ testGetCollapsed ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetType()
+
+
+
+
+
+
+
+ public
+ testGetType ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : CurrencyQr
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( CurrencyQr $currencyQr ) : void
+
+
+
+
+ Parameters
+
+
+ $currencyQr
+ : CurrencyQr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-Model-Wallet-WalletTest.html b/docs/classes/BitPaySDK-Test-Model-Wallet-WalletTest.html
new file mode 100644
index 00000000..723cc8cf
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-Model-Wallet-WalletTest.html
@@ -0,0 +1,756 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetAvatar()
+
+ : mixed
+
+
+
+ testGetCurrencies()
+
+ : mixed
+
+
+
+ testGetDisplayName()
+
+ : mixed
+
+
+
+ testGetImage()
+
+ : mixed
+
+
+
+ testGetKey()
+
+ : mixed
+
+
+
+ testGetPayPro()
+
+ : mixed
+
+
+
+ testInstanceOf()
+
+ : mixed
+
+
+
+ testToArray()
+
+ : mixed
+
+
+
+ createClassObject()
+
+ : Wallet
+
+
+
+ objectSetters()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetAvatar()
+
+
+
+
+
+
+
+ public
+ testGetAvatar ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetCurrencies()
+
+
+
+
+
+
+
+ public
+ testGetCurrencies ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetDisplayName()
+
+
+
+
+
+
+
+ public
+ testGetDisplayName ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetImage()
+
+
+
+
+
+
+
+ public
+ testGetImage ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetKey()
+
+
+
+
+
+
+
+ public
+ testGetKey ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testGetPayPro()
+
+
+
+
+
+
+
+ public
+ testGetPayPro ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testInstanceOf()
+
+
+
+
+
+
+
+ public
+ testInstanceOf ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testToArray()
+
+
+
+
+
+
+
+ public
+ testToArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ createClassObject()
+
+
+
+
+
+
+
+ private
+ createClassObject ( ) : Wallet
+
+
+
+
+
+
+
+
+
+
+
+
+ objectSetters()
+
+
+
+
+
+
+
+ private
+ objectSetters ( Wallet $wallet ) : void
+
+
+
+
+ Parameters
+
+
+ $wallet
+ : Wallet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Test-TokensTest.html b/docs/classes/BitPaySDK-Test-TokensTest.html
new file mode 100644
index 00000000..95e93c58
--- /dev/null
+++ b/docs/classes/BitPaySDK-Test-TokensTest.html
@@ -0,0 +1,582 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TokensTest
+
+
+ extends TestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ testGetTokenByFacade()
+
+ : mixed
+
+
+
+ testGetTokenByFacadeException()
+
+ : mixed
+
+
+
+ testLoadFromArray()
+
+ : mixed
+
+
+
+ accessProtected()
+
+ : mixed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testGetTokenByFacade()
+
+
+
+
+
+
+
+ public
+ testGetTokenByFacade ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ ReflectionException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+
+
+
+ testGetTokenByFacadeException()
+
+
+
+
+
+
+
+ public
+ testGetTokenByFacadeException ( ) : mixed
+
+
+
+
+
+
+
+
+
+
+
+ testLoadFromArray()
+
+
+
+
+
+
+
+ public
+ testLoadFromArray ( ) : mixed
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+
+
+
+ accessProtected()
+
+
+
+
+
+
+
+ private
+ accessProtected ( mixed $obj , mixed $prop ) : mixed
+
+
+
+
+ Parameters
+
+
+ $obj
+ : mixed
+
+
+
+
+
+ $prop
+ : mixed
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ ReflectionException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Tokens.html b/docs/classes/BitPaySDK-Tokens.html
new file mode 100644
index 00000000..957be797
--- /dev/null
+++ b/docs/classes/BitPaySDK-Tokens.html
@@ -0,0 +1,827 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Tokens
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Token object used to store the tokens for the different facades.
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $merchant
+
+ : string|null
+
+
+
+ $payout
+
+ : string|null
+
+
+
+ $pos
+
+ : string|null
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+Tokens constructor.
+
+
+ getPayoutToken()
+
+ : string|null
+
+
+
+ getTokenByFacade()
+
+ : string|null
+
+
+
+ loadFromArray()
+
+ : Tokens
+
+
+
+ setMerchantToken()
+
+ : void
+
+
+
+ setPayoutToken()
+
+ : void
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $merchant
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $merchant
+
+
+
+
+
+
+
+
+
+ $payout
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $payout
+
+
+
+
+
+
+
+
+
+ $pos
+
+
+
+
+
+
+
+
+
+ protected
+ string|null
+ $pos
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ Tokens constructor.
+
+
+ public
+ __construct ( [ string|null $merchant = null ] [ , string|null $payout = null ] [ , string|null $pos = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $merchant
+ : string|null
+ = null
+
+
+
+
+ $payout
+ : string|null
+ = null
+
+
+
+
+ $pos
+ : string|null
+ = null
+
+
+
+
+
+
+
+
+
+
+
+ getPayoutToken()
+
+
+
+
+
+
+
+ public
+ getPayoutToken ( ) : string|null
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ getTokenByFacade()
+
+
+
+
+
+
+
+ public
+ getTokenByFacade ( $facade ) : string|null
+
+
+
+
+ Parameters
+
+
+ $facade
+ :
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ string|null
+
+
+
+
+
+ loadFromArray()
+
+
+
+
+
+
+
+ public
+ static loadFromArray ( array<string|int, mixed> $tokens ) : Tokens
+
+
+
+
+ Parameters
+
+
+ $tokens
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setMerchantToken()
+
+
+
+
+
+
+
+ public
+ setMerchantToken ( string $merchant ) : void
+
+
+
+
+ Parameters
+
+
+ $merchant
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+ setPayoutToken()
+
+
+
+
+
+
+
+ public
+ setPayoutToken ( string $payout ) : void
+
+
+
+
+ Parameters
+
+
+ $payout
+ : string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Util-JsonMapperFactory.html b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html
new file mode 100644
index 00000000..b10175b6
--- /dev/null
+++ b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html
@@ -0,0 +1,409 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ JsonMapperFactory
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+ create()
+
+ : JsonMapper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create()
+
+
+
+
+
+
+
+ public
+ static create ( ) : JsonMapper
+
+
+
+
+
+
+
+
+ Return values
+ JsonMapper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html
new file mode 100644
index 00000000..c418f82c
--- /dev/null
+++ b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html
@@ -0,0 +1,1177 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ author
+
+
+
+
+
+
+
+ license
+
+
+
+ http://www.opensource.org/licenses/mit-license.php MIT
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+ $baseUrl
+
+ : string
+
+
+
+ $client
+
+ : Client
+
+
+
+ $ecKey
+
+ : PrivateKey
+
+
+
+ $identity
+
+ : string
+
+
+
+ $proxy
+
+ : string
+
+
+
+
+
+ Methods
+
+
+
+
+
+ __construct()
+
+ : mixed
+
+RESTcli constructor.
+
+
+ delete()
+
+ : string
+
+Send DELETE request.
+
+
+ get()
+
+ : string
+
+Send GET request.
+
+
+ init()
+
+ : void
+
+Initialize Client.
+
+
+ post()
+
+ : string
+
+Send POST request.
+
+
+ responseToJsonString()
+
+ : string
+
+Convert Response object into json
+
+
+ update()
+
+ : string
+
+Send PUT request.
+
+
+ isErrorStatus()
+
+ : bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $baseUrl
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $baseUrl
+
+
+
+
+
+
+
+
+
+ $client
+
+
+
+
+
+
+
+
+
+ protected
+ Client
+ $client
+
+
+
+
+
+
+
+
+
+ $ecKey
+
+
+
+
+
+
+
+
+
+ protected
+ PrivateKey
+ $ecKey
+
+
+
+
+
+
+
+
+
+ $identity
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $identity
+
+
+
+
+
+
+
+
+
+ $proxy
+
+
+
+
+
+
+
+
+
+ protected
+ string
+ $proxy
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __construct()
+
+
+
+
+
+ RESTcli constructor.
+
+
+ public
+ __construct ( string $environment , PrivateKey $ecKey [ , string|null $proxy = null ] ) : mixed
+
+
+
+
+ Parameters
+
+
+ $environment
+ : string
+
+
+
+
+
+ $ecKey
+ : PrivateKey
+
+
+
+
+
+ $proxy
+ : string|null
+ = null
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ delete()
+
+
+
+
+
+ Send DELETE request.
+
+
+ public
+ delete ( $uri [ , array<string|int, mixed>|null $parameters = null ] ) : string
+
+
+
+
+ Parameters
+
+
+ $uri
+ :
+
+
+
+
+
+ $parameters
+ : array<string|int, mixed>|null
+ = null
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ get()
+
+
+
+
+
+ Send GET request.
+
+
+ public
+ get ( $uri [ , array<string|int, mixed>|null $parameters = null ] [ , bool $signatureRequired = true ] ) : string
+
+
+
+
+ Parameters
+
+
+ $uri
+ :
+
+
+
+
+
+ $parameters
+ : array<string|int, mixed>|null
+ = null
+
+
+
+
+ $signatureRequired
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ string
+ —
+
+
+
+
+
+
+
+ init()
+
+
+
+
+
+ Initialize Client.
+
+
+ public
+ init ( ) : void
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+
+
+
+ post()
+
+
+
+
+
+ Send POST request.
+
+
+ public
+ post ( $uri [ , array<string|int, mixed> $formData = [] ] [ , bool $signatureRequired = true ] ) : string
+
+
+
+
+ Parameters
+
+
+ $uri
+ :
+
+
+
+
+
+ $formData
+ : array<string|int, mixed>
+ = []
+
+
+
+
+ $signatureRequired
+ : bool
+ = true
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ string
+ —
+
+
+
+
+
+
+
+ responseToJsonString()
+
+
+
+
+
+ Convert Response object into json
+
+
+ public
+ responseToJsonString ( Response $response ) : string
+
+
+
+
+ Parameters
+
+
+ $response
+ : Response
+
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+ throws
+
+
+ Exception
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ update()
+
+
+
+
+
+ Send PUT request.
+
+
+ public
+ update ( $uri [ , array<string|int, mixed> $formData = [] ] ) : string
+
+
+
+
+ Parameters
+
+
+ $uri
+ :
+
+
+
+
+
+ $formData
+ : array<string|int, mixed>
+ = []
+
+
+
+
+
+
+
+
+
+ throws
+
+
+ BitPayException
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+ isErrorStatus()
+
+
+
+
+
+
+
+ private
+ isErrorStatus ( array<string|int, mixed> $body ) : bool
+
+
+
+
+ Parameters
+
+
+ $body
+ : array<string|int, mixed>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/css/base.css b/docs/css/base.css
new file mode 100644
index 00000000..c9fce0c5
--- /dev/null
+++ b/docs/css/base.css
@@ -0,0 +1,1231 @@
+
+
+:root {
+ /* Typography */
+ --font-primary: 'Open Sans', Helvetica, Arial, sans-serif;
+ --font-secondary: 'Open Sans', Helvetica, Arial, sans-serif;
+ --font-monospace: 'Source Code Pro', monospace;
+ --line-height--primary: 1.6;
+ --letter-spacing--primary: .05rem;
+ --text-base-size: 1em;
+ --text-scale-ratio: 1.2;
+
+ --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio));
+ --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio));
+ --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio));
+ --text-md: var(--text-base-size);
+ --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio));
+ --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio));
+ --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio));
+ --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio));
+ --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio));
+ --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio));
+
+ --color-hue-red: 4;
+ --color-hue-pink: 340;
+ --color-hue-purple: 291;
+ --color-hue-deep-purple: 262;
+ --color-hue-indigo: 231;
+ --color-hue-blue: 207;
+ --color-hue-light-blue: 199;
+ --color-hue-cyan: 187;
+ --color-hue-teal: 174;
+ --color-hue-green: 122;
+ --color-hue-phpdocumentor-green: 96;
+ --color-hue-light-green: 88;
+ --color-hue-lime: 66;
+ --color-hue-yellow: 54;
+ --color-hue-amber: 45;
+ --color-hue-orange: 36;
+ --color-hue-deep-orange: 14;
+ --color-hue-brown: 16;
+
+ /* Colors */
+ --primary-color-hue: var(--color-hue-blue, --color-hue-phpdocumentor-green);
+ --primary-color-saturation: 57%;
+ --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%);
+ --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%);
+ --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 25%);
+ --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%);
+ --primary-color-lighten: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 20%), 85%);
+ --primary-color-lighter: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 45%), 97.5%);
+ --dark-gray: #d1d1d1;
+ --light-gray: #f0f0f0;
+
+ --text-color: var(--primary-color-darkest);
+
+ --header-height: var(--spacing-xxxxl);
+ --header-bg-color: var(--primary-color);
+ --code-background-color: var(--primary-color-lighter);
+ --code-border-color: --primary-color-lighten;
+ --button-border-color: var(--primary-color-darken);
+ --button-color: transparent;
+ --button-color-primary: var(--primary-color);
+ --button-text-color: #555;
+ --button-text-color-primary: white;
+ --popover-background-color: rgba(255, 255, 255, 0.75);
+ --link-color-primary: var(--primary-color-darker);
+ --link-hover-color-primary: var(--primary-color-darkest);
+ --form-field-border-color: var(--dark-gray);
+ --form-field-color: #fff;
+ --admonition-success-color: var(--primary-color);
+ --admonition-border-color: silver;
+ --table-separator-color: var(--primary-color-lighten);
+ --title-text-color: var(--primary-color);
+
+ --sidebar-border-color: var(--primary-color-lighten);
+
+ /* Grid */
+ --container-width: 1400px;
+
+ /* Spacing */
+ --spacing-base-size: 1rem;
+ --spacing-scale-ratio: 1.5;
+
+ --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio));
+ --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio));
+ --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio));
+ --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio));
+ --spacing-md: var(--spacing-base-size);
+ --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio));
+ --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio));
+ --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio));
+ --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio));
+ --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio));
+
+ --border-radius-base-size: 3px;
+}
+
+/* Base Styles
+-------------------------------------------------- */
+body {
+ color: var(--text-color);
+ font-family: var(--font-primary);
+ font-size: var(--text-md);
+ letter-spacing: var(--letter-spacing--primary);
+ line-height: var(--line-height--primary);
+ width: 100%;
+}
+
+.phpdocumentor h1,
+.phpdocumentor h2,
+.phpdocumentor h3,
+.phpdocumentor h4,
+.phpdocumentor h5,
+.phpdocumentor h6 {
+ margin-bottom: var(--spacing-lg);
+ margin-top: var(--spacing-lg);
+ font-weight: 600;
+}
+
+.phpdocumentor h1 {
+ font-size: var(--text-xxxxl);
+ letter-spacing: var(--letter-spacing--primary);
+ line-height: 1.2;
+ margin-top: 0;
+}
+
+.phpdocumentor h2 {
+ font-size: var(--text-xxxl);
+ letter-spacing: var(--letter-spacing--primary);
+ line-height: 1.25;
+}
+
+.phpdocumentor h3 {
+ font-size: var(--text-xxl);
+ letter-spacing: var(--letter-spacing--primary);
+ line-height: 1.3;
+}
+
+.phpdocumentor h4 {
+ font-size: var(--text-xl);
+ letter-spacing: calc(var(--letter-spacing--primary) / 2);
+ line-height: 1.35;
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor h5 {
+ font-size: var(--text-lg);
+ letter-spacing: calc(var(--letter-spacing--primary) / 4);
+ line-height: 1.5;
+ margin-bottom: var(--spacing-md);
+ margin-top: var(--spacing-md);
+}
+
+.phpdocumentor h6 {
+ font-size: var(--text-md);
+ letter-spacing: 0;
+ line-height: var(--line-height--primary);
+ margin-bottom: var(--spacing-md);
+ margin-top: var(--spacing-md);
+}
+.phpdocumentor h1 .headerlink,
+.phpdocumentor h2 .headerlink,
+.phpdocumentor h3 .headerlink,
+.phpdocumentor h4 .headerlink,
+.phpdocumentor h5 .headerlink,
+.phpdocumentor h6 .headerlink
+{
+ display: none;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor h1 .headerlink,
+ .phpdocumentor h2 .headerlink,
+ .phpdocumentor h3 .headerlink,
+ .phpdocumentor h4 .headerlink,
+ .phpdocumentor h5 .headerlink,
+ .phpdocumentor h6 .headerlink {
+ display: inline;
+ transition: all .3s ease-in-out;
+ opacity: 0;
+ text-decoration: none;
+ color: silver;
+ font-size: 80%;
+ }
+
+ .phpdocumentor h1:hover .headerlink,
+ .phpdocumentor h2:hover .headerlink,
+ .phpdocumentor h3:hover .headerlink,
+ .phpdocumentor h4:hover .headerlink,
+ .phpdocumentor h5:hover .headerlink,
+ .phpdocumentor h6:hover .headerlink {
+ opacity: 1;
+ }
+}
+.phpdocumentor p {
+ margin-top: 0;
+ margin-bottom: var(--spacing-md);
+}
+.phpdocumentor figure {
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor figcaption {
+ text-align: center;
+ font-style: italic;
+ font-size: 80%;
+}
+
+.phpdocumentor-uml-diagram svg {
+ max-width: 100%;
+ height: auto !important;
+}
+.phpdocumentor-line {
+ border-top: 1px solid #E1E1E1;
+ border-width: 0;
+ margin-bottom: var(--spacing-xxl);
+ margin-top: var(--spacing-xxl);
+}
+.phpdocumentor-section {
+ box-sizing: border-box;
+ margin: 0 auto;
+ max-width: var(--container-width);
+ padding: 0 var(--spacing-sm);
+ position: relative;
+ width: 100%;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-section {
+ padding: 0 var(--spacing-lg);
+ }
+}
+
+@media (min-width: 1200px) {
+ .phpdocumentor-section {
+ padding: 0;
+ width: 95%;
+ }
+}
+.phpdocumentor-column {
+ box-sizing: border-box;
+ float: left;
+ width: 100%;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-column {
+ margin-left: 4%;
+ }
+
+ .phpdocumentor-column:first-child {
+ margin-left: 0;
+ }
+
+ .-one.phpdocumentor-column {
+ width: 4.66666666667%;
+ }
+
+ .-two.phpdocumentor-column {
+ width: 13.3333333333%;
+ }
+
+ .-three.phpdocumentor-column {
+ width: 22%;
+ }
+
+ .-four.phpdocumentor-column {
+ width: 30.6666666667%;
+ }
+
+ .-five.phpdocumentor-column {
+ width: 39.3333333333%;
+ }
+
+ .-six.phpdocumentor-column {
+ width: 48%;
+ }
+
+ .-seven.phpdocumentor-column {
+ width: 56.6666666667%;
+ }
+
+ .-eight.phpdocumentor-column {
+ width: 65.3333333333%;
+ }
+
+ .-nine.phpdocumentor-column {
+ width: 74.0%;
+ }
+
+ .-ten.phpdocumentor-column {
+ width: 82.6666666667%;
+ }
+
+ .-eleven.phpdocumentor-column {
+ width: 91.3333333333%;
+ }
+
+ .-twelve.phpdocumentor-column {
+ margin-left: 0;
+ width: 100%;
+ }
+
+ .-one-third.phpdocumentor-column {
+ width: 30.6666666667%;
+ }
+
+ .-two-thirds.phpdocumentor-column {
+ width: 65.3333333333%;
+ }
+
+ .-one-half.phpdocumentor-column {
+ width: 48%;
+ }
+
+ /* Offsets */
+ .-offset-by-one.phpdocumentor-column {
+ margin-left: 8.66666666667%;
+ }
+
+ .-offset-by-two.phpdocumentor-column {
+ margin-left: 17.3333333333%;
+ }
+
+ .-offset-by-three.phpdocumentor-column {
+ margin-left: 26%;
+ }
+
+ .-offset-by-four.phpdocumentor-column {
+ margin-left: 34.6666666667%;
+ }
+
+ .-offset-by-five.phpdocumentor-column {
+ margin-left: 43.3333333333%;
+ }
+
+ .-offset-by-six.phpdocumentor-column {
+ margin-left: 52%;
+ }
+
+ .-offset-by-seven.phpdocumentor-column {
+ margin-left: 60.6666666667%;
+ }
+
+ .-offset-by-eight.phpdocumentor-column {
+ margin-left: 69.3333333333%;
+ }
+
+ .-offset-by-nine.phpdocumentor-column {
+ margin-left: 78.0%;
+ }
+
+ .-offset-by-ten.phpdocumentor-column {
+ margin-left: 86.6666666667%;
+ }
+
+ .-offset-by-eleven.phpdocumentor-column {
+ margin-left: 95.3333333333%;
+ }
+
+ .-offset-by-one-third.phpdocumentor-column {
+ margin-left: 34.6666666667%;
+ }
+
+ .-offset-by-two-thirds.phpdocumentor-column {
+ margin-left: 69.3333333333%;
+ }
+
+ .-offset-by-one-half.phpdocumentor-column {
+ margin-left: 52%;
+ }
+}
+.phpdocumentor a {
+ color: var(--link-color-primary);
+}
+
+.phpdocumentor a:hover {
+ color: var(--link-hover-color-primary);
+}
+.phpdocumentor-button {
+ background-color: var(--button-color);
+ border: 1px solid var(--button-border-color);
+ border-radius: var(--border-radius-base-size);
+ box-sizing: border-box;
+ color: var(--button-text-color);
+ cursor: pointer;
+ display: inline-block;
+ font-size: var(--text-sm);
+ font-weight: 600;
+ height: 38px;
+ letter-spacing: .1rem;
+ line-height: 38px;
+ padding: 0 var(--spacing-xxl);
+ text-align: center;
+ text-decoration: none;
+ text-transform: uppercase;
+ white-space: nowrap;
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor-button .-wide {
+ width: 100%;
+}
+
+.phpdocumentor-button:hover,
+.phpdocumentor-button:focus {
+ border-color: #888;
+ color: #333;
+ outline: 0;
+}
+
+.phpdocumentor-button.-primary {
+ background-color: var(--button-color-primary);
+ border-color: var(--button-color-primary);
+ color: var(--button-text-color-primary);
+}
+
+.phpdocumentor-button.-primary:hover,
+.phpdocumentor-button.-primary:focus {
+ background-color: var(--link-color-primary);
+ border-color: var(--link-color-primary);
+ color: var(--button-text-color-primary);
+}
+.phpdocumentor form {
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor-field {
+ background-color: var(--form-field-color);
+ border: 1px solid var(--form-field-border-color);
+ border-radius: var(--border-radius-base-size);
+ box-shadow: none;
+ box-sizing: border-box;
+ height: 38px;
+ padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */
+ margin-bottom: var(--spacing-md);
+}
+
+/* Removes awkward default styles on some inputs for iOS */
+input[type="email"],
+input[type="number"],
+input[type="search"],
+input[type="text"],
+input[type="tel"],
+input[type="url"],
+input[type="password"],
+textarea {
+ -moz-appearance: none;
+ -webkit-appearance: none;
+ appearance: none;
+}
+
+.phpdocumentor-textarea {
+ min-height: 65px;
+ padding-bottom: var(--spacing-xxxs);
+ padding-top: var(--spacing-xxxs);
+}
+
+.phpdocumentor-field:focus {
+ border: 1px solid var(--button-color-primary);
+ outline: 0;
+}
+
+label.phpdocumentor-label {
+ display: block;
+ margin-bottom: var(--spacing-xs);
+}
+
+.phpdocumentor-fieldset {
+ border-width: 0;
+ padding: 0;
+}
+
+input[type="checkbox"].phpdocumentor-field,
+input[type="radio"].phpdocumentor-field {
+ display: inline;
+}
+.phpdocumentor-column ul,
+div.phpdocumentor-list > ul,
+ul.phpdocumentor-list {
+ list-style: circle;
+}
+
+.phpdocumentor-column ol,
+div.phpdocumentor-list > ol,
+ol.phpdocumentor-list {
+ list-style: decimal;
+}
+
+
+.phpdocumentor-column ul,
+div.phpdocumentor-list > ul,
+ol.phpdocumentor-list,
+ul.phpdocumentor-list {
+ margin-top: 0;
+ padding-left: var(--spacing-md);
+ margin-bottom: var(--spacing-sm);
+}
+
+.phpdocumentor-column ul.-clean,
+div.phpdocumentor-list > ul.-clean,
+ul.phpdocumentor-list.-clean {
+ list-style: none;
+ padding-left: 0;
+}
+
+dl {
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor-column ul ul,
+div.phpdocumentor-list > ul ul,
+ul.phpdocumentor-list ul.phpdocumentor-list,
+ul.phpdocumentor-list ol.phpdocumentor-list,
+ol.phpdocumentor-list ol.phpdocumentor-list,
+ol.phpdocumentor-list ul.phpdocumentor-list {
+ font-size: var(--text-sm);
+ margin: 0 0 0 calc(var(--spacing-xs) * 2);
+}
+
+.phpdocumentor-column ul li,
+.phpdocumentor-list li {
+ padding-bottom: var(--spacing-xs);
+}
+
+.phpdocumentor dl dt {
+ margin-bottom: var(--spacing-xs);
+}
+
+.phpdocumentor dl dd {
+ margin-bottom: var(--spacing-md);
+}
+.phpdocumentor pre {
+ margin-bottom: var(--spacing-md);
+}
+
+.phpdocumentor-code {
+ font-family: var(--font-monospace);
+ background: var(--code-background-color);
+ border: 1px solid var(--code-border-color);
+ border-radius: var(--border-radius-base-size);
+ font-size: var(--text-sm);
+ padding: var(--spacing-sm) var(--spacing-md);
+ width: 100%;
+ box-sizing: border-box;
+}
+
+.phpdocumentor-code.-dark {
+ background: var(--primary-color-darkest);
+ color: var(--light-gray);
+ box-shadow: 0 2px 3px var(--dark-gray);
+}
+
+pre > .phpdocumentor-code {
+ display: block;
+ white-space: pre;
+}
+.phpdocumentor blockquote {
+ border-left: 4px solid var(--primary-color-darken);
+ margin: var(--spacing-md) 0;
+ padding: var(--spacing-xs) var(--spacing-sm);
+ color: var(--primary-color-darker);
+ font-style: italic;
+}
+
+.phpdocumentor blockquote p:last-of-type {
+ margin-bottom: 0;
+}
+.phpdocumentor table {
+ margin-bottom: var(--spacing-md);
+}
+
+th.phpdocumentor-heading,
+td.phpdocumentor-cell {
+ border-bottom: 1px solid var(--table-separator-color);
+ padding: var(--spacing-sm) var(--spacing-md);
+ text-align: left;
+}
+
+th.phpdocumentor-heading:first-child,
+td.phpdocumentor-cell:first-child {
+ padding-left: 0;
+}
+
+th.phpdocumentor-heading:last-child,
+td.phpdocumentor-cell:last-child {
+ padding-right: 0;
+}
+.phpdocumentor-label-line {
+ display: flex;
+ flex-direction: row;
+ gap: 1rem
+}
+
+.phpdocumentor-label {
+ background: #f6f6f6;
+ border-radius: .25rem;
+ font-size: 80%;
+ display: inline-block;
+ overflow: hidden
+}
+
+/*
+It would be better if the phpdocumentor-element class were to become a flex element with a gap, but for #3337 that
+is too big a fix and needs to be done in a new design iteration.
+*/
+.phpdocumentor-signature + .phpdocumentor-label-line .phpdocumentor-label {
+ margin-top: var(--spacing-sm);
+}
+
+.phpdocumentor-label span {
+ display: inline-block;
+ padding: .125rem .5rem;
+}
+
+.phpdocumentor-label--success span:last-of-type {
+ background: #abe1ab;
+}
+
+.phpdocumentor-header {
+ display: flex;
+ flex-direction: row;
+ align-items: stretch;
+ flex-wrap: wrap;
+ justify-content: space-between;
+ height: auto;
+ padding: var(--spacing-md) var(--spacing-md);
+}
+
+.phpdocumentor-header__menu-button {
+ position: absolute;
+ top: -100%;
+ left: -100%;
+}
+
+.phpdocumentor-header__menu-icon {
+ font-size: 2rem;
+ color: var(--primary-color);
+}
+
+.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav {
+ max-height: 250px;
+ padding-top: var(--spacing-md);
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-header {
+ flex-direction: row;
+ padding: var(--spacing-lg) var(--spacing-lg);
+ min-height: var(--header-height);
+ }
+
+ .phpdocumentor-header__menu-icon {
+ display: none;
+ }
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-header {
+ padding-top: 0;
+ padding-bottom: 0;
+ }
+}
+@media (min-width: 1200px) {
+ .phpdocumentor-header {
+ padding: 0;
+ }
+}
+.phpdocumentor-title {
+ box-sizing: border-box;
+ color: var(--title-text-color);
+ font-size: var(--text-xxl);
+ letter-spacing: .05rem;
+ font-weight: normal;
+ width: auto;
+ margin: 0;
+ display: flex;
+ align-items: center;
+}
+
+.phpdocumentor-title.-without-divider {
+ border: none;
+}
+
+.phpdocumentor-title__link {
+ transition: all .3s ease-out;
+ display: flex;
+ color: var(--title-text-color);
+ text-decoration: none;
+ font-weight: normal;
+ white-space: nowrap;
+ transform: scale(.75);
+ transform-origin: left;
+}
+
+.phpdocumentor-title__link:hover {
+ transform: perspective(15rem) translateX(.5rem);
+ font-weight: 600;
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-title {
+ width: 22%;
+ border-right: var(--sidebar-border-color) solid 1px;
+ }
+
+ .phpdocumentor-title__link {
+ transform-origin: left;
+ }
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-title__link {
+ transform: scale(.85);
+ }
+}
+
+@media (min-width: 1200px) {
+ .phpdocumentor-title__link {
+ transform: scale(1);
+ }
+}
+.phpdocumentor-topnav {
+ display: flex;
+ align-items: center;
+ margin: 0;
+ max-height: 0;
+ overflow: hidden;
+ transition: max-height 0.2s ease-out;
+ flex-basis: 100%;
+}
+
+.phpdocumentor-topnav__menu {
+ text-align: right;
+ list-style: none;
+ margin: 0;
+ padding: 0;
+ flex: 1;
+ display: flex;
+ flex-flow: row wrap;
+ justify-content: center;
+}
+
+.phpdocumentor-topnav__menu-item {
+ margin: 0;
+ width: 100%;
+ display: inline-block;
+ text-align: center;
+ padding: var(--spacing-sm) 0
+}
+
+.phpdocumentor-topnav__menu-item.-social {
+ width: auto;
+ padding: var(--spacing-sm)
+}
+
+.phpdocumentor-topnav__menu-item a {
+ display: inline-block;
+ color: var(--text-color);
+ text-decoration: none;
+ font-size: var(--text-lg);
+ transition: all .3s ease-out;
+ border-bottom: 1px dotted transparent;
+ line-height: 1;
+}
+
+.phpdocumentor-topnav__menu-item a:hover {
+ transform: perspective(15rem) translateY(.1rem);
+ border-bottom: 1px dotted var(--text-color);
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-topnav {
+ max-height: none;
+ overflow: visible;
+ flex-basis: auto;
+ }
+
+ .phpdocumentor-topnav__menu {
+ display: flex;
+ flex-flow: row wrap;
+ justify-content: flex-end;
+ }
+
+ .phpdocumentor-topnav__menu-item,
+ .phpdocumentor-topnav__menu-item.-social {
+ width: auto;
+ display: inline;
+ text-align: right;
+ padding: 0 0 0 var(--spacing-md)
+ }
+}
+.phpdocumentor-sidebar {
+ margin: 0;
+ overflow: hidden;
+ max-height: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list {
+ padding: var(--spacing-xs) var(--spacing-md);
+ list-style: none;
+ margin: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar li {
+ white-space: nowrap;
+ text-overflow: ellipsis;
+ overflow: hidden;
+ padding: 0 0 var(--spacing-xxxs) var(--spacing-md);
+}
+
+.phpdocumentor .phpdocumentor-sidebar abbr,
+.phpdocumentor .phpdocumentor-sidebar a {
+ text-decoration: none;
+ border-bottom: none;
+ color: var(--text-color);
+ font-size: var(--text-md);
+ padding-left: 0;
+ transition: padding-left .4s ease-out;
+}
+
+.phpdocumentor .phpdocumentor-sidebar a:hover,
+.phpdocumentor .phpdocumentor-sidebar a.-active {
+ padding-left: 5px;
+ font-weight: 600;
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category > * {
+ border-left: 1px solid var(--primary-color-lighten);
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category {
+ margin-bottom: var(--spacing-lg);
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category-header {
+ font-size: var(--text-md);
+ margin-top: 0;
+ margin-bottom: var(--spacing-xs);
+ color: var(--link-color-primary);
+ font-weight: 600;
+ border-left: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar__root-package,
+.phpdocumentor .phpdocumentor-sidebar__root-namespace {
+ font-size: var(--text-md);
+ margin: 0;
+ padding-top: var(--spacing-xs);
+ padding-left: var(--spacing-md);
+ color: var(--text-color);
+ font-weight: normal;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-sidebar {
+ border-right: var(--sidebar-border-color) solid 1px;
+ }
+}
+
+.phpdocumentor-sidebar__menu-button {
+ position: absolute;
+ top: -100%;
+ left: -100%;
+}
+
+.phpdocumentor-sidebar__menu-icon {
+ font-size: var(--text-md);
+ font-weight: 600;
+ background: var(--primary-color);
+ color: white;
+ margin: 0 0 var(--spacing-lg);
+ display: block;
+ padding: var(--spacing-sm);
+ text-align: center;
+ border-radius: 3px;
+ text-transform: uppercase;
+ letter-spacing: .15rem;
+}
+
+.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar {
+ max-height: 100%;
+ padding-top: var(--spacing-md);
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-sidebar {
+ overflow: visible;
+ max-height: 100%;
+ }
+
+ .phpdocumentor-sidebar__menu-icon {
+ display: none;
+ }
+}
+.phpdocumentor-admonition {
+ border: 1px solid var(--admonition-border-color);
+ border-radius: var(--border-radius-base-size);
+ border-color: var(--primary-color-lighten);
+ background-color: var(--primary-color-lighter);
+ padding: var(--spacing-lg);
+ margin: var(--spacing-lg) 0;
+ display: flex;
+ flex-direction: row;
+ align-items: flex-start;
+}
+
+.phpdocumentor-admonition p:last-of-type {
+ margin-bottom: 0;
+}
+
+.phpdocumentor-admonition--success,
+.phpdocumentor-admonition.-success {
+ border-color: var(--admonition-success-color);
+}
+
+.phpdocumentor-admonition__icon {
+ margin-right: var(--spacing-md);
+ color: var(--primary-color);
+ max-width: 3rem;
+}
+.phpdocumentor ul.phpdocumentor-breadcrumbs {
+ font-size: var(--text-md);
+ list-style: none;
+ margin: 0;
+ padding: 0;
+}
+
+.phpdocumentor ul.phpdocumentor-breadcrumbs a {
+ color: var(--text-color);
+ text-decoration: none;
+}
+
+.phpdocumentor ul.phpdocumentor-breadcrumbs > li {
+ display: inline-block;
+ margin: 0;
+}
+
+.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before {
+ color: var(--dark-gray);
+ content: "\\\A0";
+ padding: 0;
+}
+.phpdocumentor .phpdocumentor-back-to-top {
+ position: fixed;
+ bottom: 2rem;
+ font-size: 2.5rem;
+ opacity: .25;
+ transition: all .3s ease-in-out;
+ right: 2rem;
+}
+
+.phpdocumentor .phpdocumentor-back-to-top:hover {
+ color: var(--link-color-primary);
+ opacity: 1;
+}
+.phpdocumentor-search {
+ position: relative;
+ display: none; /** disable by default for non-js flow */
+ opacity: .3; /** white-out default for loading indication */
+ transition: opacity .3s, background .3s;
+ margin: var(--spacing-sm) 0;
+ flex: 1;
+ min-width: 100%;
+}
+
+.phpdocumentor-search label {
+ display: flex;
+ align-items: center;
+ flex: 1;
+}
+
+.phpdocumentor-search__icon {
+ color: var(--primary-color);
+ margin-right: var(--spacing-sm);
+ width: 1rem;
+ height: 1rem;
+}
+
+.phpdocumentor-search--enabled {
+ display: flex;
+}
+
+.phpdocumentor-search--active {
+ opacity: 1;
+}
+
+.phpdocumentor-search input:disabled {
+ background-color: lightgray;
+}
+
+.phpdocumentor-search__field:focus,
+.phpdocumentor-search__field {
+ margin-bottom: 0;
+ border: 0;
+ border-bottom: 2px solid var(--primary-color);
+ padding: 0;
+ border-radius: 0;
+ flex: 1;
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-search {
+ min-width: auto;
+ max-width: 20rem;
+ margin: 0 0 0 auto;
+ }
+}
+.phpdocumentor-search-results {
+ backdrop-filter: blur(5px);
+ background: var(--popover-background-color);
+ position: fixed;
+ top: 0;
+ left: 0;
+ right: 0;
+ bottom: 0;
+ padding: 0;
+ opacity: 1;
+ pointer-events: all;
+
+ transition: opacity .3s, background .3s;
+}
+
+.phpdocumentor-search-results--hidden {
+ background: transparent;
+ backdrop-filter: blur(0);
+ opacity: 0;
+ pointer-events: none;
+}
+
+.phpdocumentor-search-results__dialog {
+ width: 100%;
+ background: white;
+ max-height: 100%;
+ display: flex;
+ flex-direction: column;
+}
+
+.phpdocumentor-search-results__body {
+ overflow: auto;
+}
+
+.phpdocumentor-search-results__header {
+ padding: var(--spacing-lg);
+ display: flex;
+ justify-content: space-between;
+ background: var(--primary-color-darken);
+ color: white;
+ align-items: center;
+}
+
+.phpdocumentor-search-results__close {
+ font-size: var(--text-xl);
+ background: none;
+ border: none;
+ padding: 0;
+ margin: 0;
+}
+
+.phpdocumentor .phpdocumentor-search-results__title {
+ font-size: var(--text-xl);
+ margin-bottom: 0;
+}
+
+.phpdocumentor-search-results__entries {
+ list-style: none;
+ padding: 0 var(--spacing-lg);
+ margin: 0;
+}
+
+.phpdocumentor-search-results__entry {
+ border-bottom: 1px solid var(--table-separator-color);
+ padding: var(--spacing-sm) 0;
+ text-align: left;
+}
+
+.phpdocumentor-search-results__entry a {
+ display: block;
+}
+
+.phpdocumentor-search-results__entry small {
+ margin-top: var(--spacing-xs);
+ margin-bottom: var(--spacing-md);
+ color: var(--primary-color-darker);
+ display: block;
+ word-break: break-word;
+}
+
+.phpdocumentor-search-results__entry h3 {
+ font-size: var(--text-lg);
+ margin: 0;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-search-results {
+ padding: 0 var(--spacing-lg);
+ }
+
+ .phpdocumentor-search-results__entry h3 {
+ font-size: var(--text-xxl);
+ }
+
+ .phpdocumentor-search-results__dialog {
+ margin: var(--spacing-xl) auto;
+ max-width: 40rem;
+ background: white;
+ border: 1px solid silver;
+ box-shadow: 0 2px 5px silver;
+ max-height: 40rem;
+ border-radius: 3px;
+ }
+}
+.phpdocumentor-modal {
+ position: fixed;
+ width: 100vw;
+ height: 100vh;
+ opacity: 0;
+ visibility: hidden;
+ transition: all 0.3s ease;
+ top: 0;
+ left: 0;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ z-index: 1;
+}
+
+.phpdocumentor-modal__open {
+ visibility: visible;
+ opacity: 1;
+ transition-delay: 0s;
+}
+
+.phpdocumentor-modal-bg {
+ position: absolute;
+ background: gray;
+ opacity: 50%;
+ width: 100%;
+ height: 100%;
+}
+
+.phpdocumentor-modal-container {
+ border-radius: 1em;
+ background: #fff;
+ position: relative;
+ padding: 2em;
+ box-sizing: border-box;
+ max-width:100vw;
+}
+
+.phpdocumentor-modal__close {
+ position: absolute;
+ right: 0.75em;
+ top: 0.75em;
+ outline: none;
+ appearance: none;
+ color: var(--primary-color);
+ background: none;
+ border: 0px;
+ font-weight: bold;
+ cursor: pointer;
+}
+.phpdocumentor-on-this-page__sidebar {
+ display: none;
+}
+
+.phpdocumentor-on-this-page__title {
+ display: block;
+ font-weight: bold;
+ margin-bottom: var(--spacing-sm);
+ color: var(--link-color-primary);
+}
+
+@media (min-width: 1000px) {
+ .phpdocumentor-on-this-page__sidebar {
+ display: block;
+ position: relative;
+ }
+
+ .phpdocumentor-on-this-page__content::-webkit-scrollbar,
+ [scrollbars]::-webkit-scrollbar {
+ height: 8px;
+ width: 8px;
+ }
+
+ .phpdocumentor-on-this-page__content::-webkit-scrollbar-corner,
+ [scrollbars]::-webkit-scrollbar-corner {
+ background: 0;
+ }
+
+ .phpdocumentor-on-this-page__content::-webkit-scrollbar-thumb,
+ [scrollbars]::-webkit-scrollbar-thumb {
+ background: rgba(128,134,139,0.26);
+ border-radius: 8px;
+ }
+
+ .phpdocumentor-on-this-page__content {
+ position: sticky;
+ height: calc(100vh - var(--header-height));
+ overflow-y: auto;
+ border-left: 1px solid var(--sidebar-border-color);
+ padding-left: var(--spacing-lg);
+ font-size: 90%;
+ top: -1px; /* Needed for the javascript to make the .-stuck trick work */
+ flex: 0 1 auto;
+ width: 15vw;
+ }
+
+ .phpdocumentor-on-this-page__content.-stuck {
+ height: 100vh;
+ }
+
+ .phpdocumentor-on-this-page__content li {
+ word-break: break-all;
+ line-height: normal;
+ }
+}
+
+/* Used for screen readers and such */
+.visually-hidden {
+ display: none;
+}
+
+.float-right {
+ float: right;
+}
+
+.float-left {
+ float: left;
+}
diff --git a/docs/css/normalize.css b/docs/css/normalize.css
new file mode 100644
index 00000000..653dc00a
--- /dev/null
+++ b/docs/css/normalize.css
@@ -0,0 +1,427 @@
+/*! normalize.css v3.0.2 | MIT License | git.io/normalize */
+
+/**
+ * 1. Set default font family to sans-serif.
+ * 2. Prevent iOS text size adjust after orientation change, without disabling
+ * user zoom.
+ */
+
+html {
+ font-family: sans-serif; /* 1 */
+ -ms-text-size-adjust: 100%; /* 2 */
+ -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/**
+ * Remove default margin.
+ */
+
+body {
+ margin: 0;
+}
+
+/* HTML5 display definitions
+ ========================================================================== */
+
+/**
+ * Correct `block` display not defined for any HTML5 element in IE 8/9.
+ * Correct `block` display not defined for `details` or `summary` in IE 10/11
+ * and Firefox.
+ * Correct `block` display not defined for `main` in IE 11.
+ */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+menu,
+nav,
+section,
+summary {
+ display: block;
+}
+
+/**
+ * 1. Correct `inline-block` display not defined in IE 8/9.
+ * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
+ */
+
+audio,
+canvas,
+progress,
+video {
+ display: inline-block; /* 1 */
+ vertical-align: baseline; /* 2 */
+}
+
+/**
+ * Prevent modern browsers from displaying `audio` without controls.
+ * Remove excess height in iOS 5 devices.
+ */
+
+audio:not([controls]) {
+ display: none;
+ height: 0;
+}
+
+/**
+ * Address `[hidden]` styling not present in IE 8/9/10.
+ * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
+ */
+
+[hidden],
+template {
+ display: none !important;
+}
+
+/* Links
+ ========================================================================== */
+
+/**
+ * Remove the gray background color from active links in IE 10.
+ */
+
+a {
+ background-color: transparent;
+}
+
+/**
+ * Improve readability when focused and also mouse hovered in all browsers.
+ */
+
+a:active,
+a:hover {
+ outline: 0;
+}
+
+/* Text-level semantics
+ ========================================================================== */
+
+/**
+ * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
+ */
+
+abbr[title] {
+ border-bottom: 1px dotted;
+}
+
+/**
+ * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
+ */
+
+b,
+strong {
+ font-weight: bold;
+}
+
+/**
+ * Address styling not present in Safari and Chrome.
+ */
+
+dfn {
+ font-style: italic;
+}
+
+/**
+ * Address variable `h1` font-size and margin within `section` and `article`
+ * contexts in Firefox 4+, Safari, and Chrome.
+ */
+
+h1 {
+ font-size: 2em;
+ margin: 0.67em 0;
+}
+
+/**
+ * Address styling not present in IE 8/9.
+ */
+
+mark {
+ background: #ff0;
+ color: #000;
+}
+
+/**
+ * Address inconsistent and variable font size in all browsers.
+ */
+
+small {
+ font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` affecting `line-height` in all browsers.
+ */
+
+sub,
+sup {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline;
+}
+
+sup {
+ top: -0.5em;
+}
+
+sub {
+ bottom: -0.25em;
+}
+
+/* Embedded content
+ ========================================================================== */
+
+/**
+ * Remove border when inside `a` element in IE 8/9/10.
+ */
+
+img {
+ border: 0;
+}
+
+/**
+ * Correct overflow not hidden in IE 9/10/11.
+ */
+
+svg:not(:root) {
+ overflow: hidden;
+}
+
+/* Grouping content
+ ========================================================================== */
+
+/**
+ * Address margin not present in IE 8/9 and Safari.
+ */
+
+figure {
+ margin: 1em 40px;
+}
+
+/**
+ * Address differences between Firefox and other browsers.
+ */
+
+hr {
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+ height: 0;
+}
+
+/**
+ * Contain overflow in all browsers.
+ */
+
+pre {
+ overflow: auto;
+}
+
+/**
+ * Address odd `em`-unit font size rendering in all browsers.
+ */
+
+code,
+kbd,
+pre,
+samp {
+ font-family: var(--font-monospace);
+ font-size: 1em;
+}
+
+/* Forms
+ ========================================================================== */
+
+/**
+ * Known limitation: by default, Chrome and Safari on OS X allow very limited
+ * styling of `select`, unless a `border` property is set.
+ */
+
+/**
+ * 1. Correct color not being inherited.
+ * Known issue: affects color of disabled elements.
+ * 2. Correct font properties not being inherited.
+ * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+ color: inherit; /* 1 */
+ font: inherit; /* 2 */
+ margin: 0; /* 3 */
+}
+
+/**
+ * Address `overflow` set to `hidden` in IE 8/9/10/11.
+ */
+
+button {
+ overflow: visible;
+}
+
+/**
+ * Address inconsistent `text-transform` inheritance for `button` and `select`.
+ * All other form control elements do not inherit `text-transform` values.
+ * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
+ * Correct `select` style inheritance in Firefox.
+ */
+
+button,
+select {
+ text-transform: none;
+}
+
+/**
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ * and `video` controls.
+ * 2. Correct inability to style clickable `input` types in iOS.
+ * 3. Improve usability and consistency of cursor style between image-type
+ * `input` and others.
+ */
+
+button,
+html input[type="button"], /* 1 */
+input[type="reset"],
+input[type="submit"] {
+ -webkit-appearance: button; /* 2 */
+ cursor: pointer; /* 3 */
+}
+
+/**
+ * Re-set default cursor for disabled elements.
+ */
+
+button[disabled],
+html input[disabled] {
+ cursor: default;
+}
+
+/**
+ * Remove inner padding and border in Firefox 4+.
+ */
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+ border: 0;
+ padding: 0;
+}
+
+/**
+ * Address Firefox 4+ setting `line-height` on `input` using `!important` in
+ * the UA stylesheet.
+ */
+
+input {
+ line-height: normal;
+}
+
+/**
+ * It's recommended that you don't attempt to style these elements.
+ * Firefox's implementation doesn't respect box-sizing, padding, or width.
+ *
+ * 1. Address box sizing set to `content-box` in IE 8/9/10.
+ * 2. Remove excess padding in IE 8/9/10.
+ */
+
+input[type="checkbox"],
+input[type="radio"] {
+ box-sizing: border-box; /* 1 */
+ padding: 0; /* 2 */
+}
+
+/**
+ * Fix the cursor style for Chrome's increment/decrement buttons. For certain
+ * `font-size` values of the `input`, it causes the cursor style of the
+ * decrement button to change from `default` to `text`.
+ */
+
+input[type="number"]::-webkit-inner-spin-button,
+input[type="number"]::-webkit-outer-spin-button {
+ height: auto;
+}
+
+/**
+ * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
+ * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
+ * (include `-moz` to future-proof).
+ */
+
+input[type="search"] {
+ -webkit-appearance: textfield; /* 1 */
+ -moz-box-sizing: content-box;
+ -webkit-box-sizing: content-box; /* 2 */
+ box-sizing: content-box;
+}
+
+/**
+ * Remove inner padding and search cancel button in Safari and Chrome on OS X.
+ * Safari (but not Chrome) clips the cancel button when the search input has
+ * padding (and `textfield` appearance).
+ */
+
+input[type="search"]::-webkit-search-cancel-button,
+input[type="search"]::-webkit-search-decoration {
+ -webkit-appearance: none;
+}
+
+/**
+ * Define consistent border, margin, and padding.
+ */
+
+fieldset {
+ border: 1px solid #c0c0c0;
+ margin: 0 2px;
+ padding: 0.35em 0.625em 0.75em;
+}
+
+/**
+ * 1. Correct `color` not being inherited in IE 8/9/10/11.
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
+ */
+
+legend {
+ border: 0; /* 1 */
+ padding: 0; /* 2 */
+}
+
+/**
+ * Remove default vertical scrollbar in IE 8/9/10/11.
+ */
+
+textarea {
+ overflow: auto;
+}
+
+/**
+ * Don't inherit the `font-weight` (applied by a rule above).
+ * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
+ */
+
+optgroup {
+ font-weight: bold;
+}
+
+/* Tables
+ ========================================================================== */
+
+/**
+ * Remove most spacing between table cells.
+ */
+
+table {
+ border-collapse: collapse;
+ border-spacing: 0;
+}
+
+td,
+th {
+ padding: 0;
+}
diff --git a/docs/css/template.css b/docs/css/template.css
new file mode 100644
index 00000000..ba27e58b
--- /dev/null
+++ b/docs/css/template.css
@@ -0,0 +1,271 @@
+
+.phpdocumentor-content {
+ position: relative;
+ display: flex;
+ gap: var(--spacing-md);
+}
+
+.phpdocumentor-content > section:first-of-type {
+ width: 75%;
+ flex: 1 1 auto;
+}
+
+@media (min-width: 1900px) {
+ .phpdocumentor-content > section:first-of-type {
+ width: 100%;
+ flex: 1 1 auto;
+ }
+}
+
+.phpdocumentor .phpdocumentor-content__title {
+ margin-top: 0;
+}
+.phpdocumentor-summary {
+ font-style: italic;
+}
+.phpdocumentor-description {
+ margin-bottom: var(--spacing-md);
+}
+.phpdocumentor-element {
+ position: relative;
+}
+
+.phpdocumentor-element .phpdocumentor-element {
+ border: 1px solid var(--primary-color-lighten);
+ margin-bottom: var(--spacing-md);
+ padding: var(--spacing-xs);
+ border-radius: 5px;
+}
+
+.phpdocumentor-element.-deprecated .phpdocumentor-element__name {
+ text-decoration: line-through;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-element .phpdocumentor-element {
+ margin-bottom: var(--spacing-lg);
+ padding: var(--spacing-md);
+ }
+}
+
+.phpdocumentor-element__modifier {
+ font-size: var(--text-xxs);
+ padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2);
+ color: var(--text-color);
+ background-color: var(--light-gray);
+ border-radius: 3px;
+ text-transform: uppercase;
+}
+
+.phpdocumentor .phpdocumentor-elements__header {
+ margin-top: var(--spacing-xxl);
+ margin-bottom: var(--spacing-lg);
+}
+
+.phpdocumentor .phpdocumentor-element__name {
+ line-height: 1;
+ margin-top: 0;
+ font-weight: 300;
+ font-size: var(--text-lg);
+ word-break: break-all;
+ margin-bottom: var(--spacing-sm);
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor .phpdocumentor-element__name {
+ font-size: var(--text-xl);
+ margin-bottom: var(--spacing-xs);
+ }
+}
+
+@media (min-width: 1200px) {
+ .phpdocumentor .phpdocumentor-element__name {
+ margin-bottom: var(--spacing-md);
+ }
+}
+
+.phpdocumentor-element__package,
+.phpdocumentor-element__extends,
+.phpdocumentor-element__implements {
+ display: block;
+ font-size: var(--text-xxs);
+ font-weight: normal;
+ opacity: .7;
+}
+
+.phpdocumentor-element__package .phpdocumentor-breadcrumbs {
+ display: inline;
+}
+.phpdocumentor .phpdocumentor-signature {
+ display: block;
+ font-size: var(--text-sm);
+ border: 1px solid #f0f0f0;
+}
+
+.phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name {
+ text-decoration: line-through;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor .phpdocumentor-signature {
+ margin-left: calc(var(--spacing-xl) * -1);
+ width: calc(100% + var(--spacing-xl));
+ }
+}
+
+.phpdocumentor-table-of-contents {
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry {
+ margin-bottom: var(--spacing-xxs);
+ margin-left: 2rem;
+ display: flex;
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a {
+ flex: 0 1 auto;
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span {
+ flex: 1;
+ white-space: nowrap;
+ text-overflow: ellipsis;
+ overflow: hidden;
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after {
+ content: '';
+ height: 12px;
+ width: 12px;
+ left: 16px;
+ position: absolute;
+}
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after {
+ background: url('data:image/svg+xml;utf8, ') no-repeat;
+}
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after {
+ left: 13px;
+ background: url('data:image/svg+xml;utf8, ') no-repeat;
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before {
+ width: 1.25rem;
+ height: 1.25rem;
+ line-height: 1.25rem;
+ background: transparent url('data:image/svg+xml;utf8, ') no-repeat center center;
+ content: '';
+ position: absolute;
+ left: 0;
+ border-radius: 50%;
+ font-weight: 600;
+ color: white;
+ text-align: center;
+ font-size: .75rem;
+ margin-top: .2rem;
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before {
+ content: 'M';
+ color: '';
+ background-image: url('data:image/svg+xml;utf8, ');
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before {
+ content: 'M';
+ color: ' 207';
+ background-image: url('data:image/svg+xml;utf8, ');
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before {
+ content: 'P'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before {
+ content: 'C';
+ background-color: transparent;
+ background-image: url('data:image/svg+xml;utf8, ');
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before {
+ content: 'C'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before {
+ content: 'I'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before {
+ content: 'T'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before {
+ content: 'N'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before {
+ content: 'P'
+}
+
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before {
+ content: 'E'
+}
+
+.phpdocumentor-table-of-contents dd {
+ font-style: italic;
+ margin-left: 2rem;
+}
+.phpdocumentor-element-found-in {
+ display: none;
+}
+
+@media (min-width: 550px) {
+ .phpdocumentor-element-found-in {
+ display: block;
+ font-size: var(--text-sm);
+ color: gray;
+ margin-bottom: 1rem;
+ }
+}
+
+@media (min-width: 1200px) {
+ .phpdocumentor-element-found-in {
+ position: absolute;
+ top: var(--spacing-sm);
+ right: var(--spacing-sm);
+ font-size: var(--text-sm);
+ margin-bottom: 0;
+ }
+}
+
+.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source {
+ flex: 0 1 auto;
+ display: inline-flex;
+}
+
+.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after {
+ width: 1.25rem;
+ height: 1.25rem;
+ line-height: 1.25rem;
+ background: transparent url('data:image/svg+xml;utf8, ') no-repeat center center;
+ content: '';
+ left: 0;
+ border-radius: 50%;
+ font-weight: 600;
+ text-align: center;
+ font-size: .75rem;
+ margin-top: .2rem;
+}
+.phpdocumentor-class-graph {
+ width: 100%; height: 600px; border:1px solid black; overflow: hidden
+}
+
+.phpdocumentor-class-graph__graph {
+ width: 100%;
+}
+.phpdocumentor-tag-list__definition {
+ display: flex;
+}
+
+.phpdocumentor-tag-link {
+ margin-right: var(--spacing-sm);
+}
diff --git a/docs/files/setup-configgenerator.html b/docs/files/setup-configgenerator.html
new file mode 100644
index 00000000..bdcdd61c
--- /dev/null
+++ b/docs/files/setup-configgenerator.html
@@ -0,0 +1,309 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ConfigGenerator.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-billclient.html b/docs/files/src-bitpaysdk-client-billclient.html
new file mode 100644
index 00000000..39f2520e
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-billclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillClient Handles interactions with the bill endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-invoiceclient.html b/docs/files/src-bitpaysdk-client-invoiceclient.html
new file mode 100644
index 00000000..f38b96d2
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-invoiceclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceClient Handles interactions with the invoice endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-ledgerclient.html b/docs/files/src-bitpaysdk-client-ledgerclient.html
new file mode 100644
index 00000000..f7342173
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-ledgerclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerClient Handles interactions with the ledger endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-payoutclient.html b/docs/files/src-bitpaysdk-client-payoutclient.html
new file mode 100644
index 00000000..e3919b12
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-payoutclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutClient Handles interactions with the payout endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html b/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html
new file mode 100644
index 00000000..8d7a4d66
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientsClient Handles interactions with the recipients endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-rateclient.html b/docs/files/src-bitpaysdk-client-rateclient.html
new file mode 100644
index 00000000..970ab551
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-rateclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateClient Handles interactions with the rate endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-refundclient.html b/docs/files/src-bitpaysdk-client-refundclient.html
new file mode 100644
index 00000000..673d4bca
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-refundclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundClient Handles interactions with the refund endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-settlementclient.html b/docs/files/src-bitpaysdk-client-settlementclient.html
new file mode 100644
index 00000000..3c4028ef
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-settlementclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementClient Handles interactions with the settlement endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-tokenclient.html b/docs/files/src-bitpaysdk-client-tokenclient.html
new file mode 100644
index 00000000..64b729ed
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-tokenclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TokenClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ TokenClient Handles interactions with the token endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client-walletclient.html b/docs/files/src-bitpaysdk-client-walletclient.html
new file mode 100644
index 00000000..1a0ac7f9
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client-walletclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletClient Handles interactions with the wallet endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-client.html b/docs/files/src-bitpaysdk-client.html
new file mode 100644
index 00000000..42ea29fd
--- /dev/null
+++ b/docs/files/src-bitpaysdk-client.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Client Client class to interact with the BitPay API.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-env.html b/docs/files/src-bitpaysdk-env.html
new file mode 100644
index 00000000..0758088c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-env.html
@@ -0,0 +1,301 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Env.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ Env Constants used throughout the SDK.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-billcreationexception.html b/docs/files/src-bitpaysdk-exceptions-billcreationexception.html
new file mode 100644
index 00000000..293e9b64
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-billcreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillCreationException Bill creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-billdeliveryexception.html b/docs/files/src-bitpaysdk-exceptions-billdeliveryexception.html
new file mode 100644
index 00000000..ceb3b56f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-billdeliveryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillDeliveryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillDeliveryException Bill delivery exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-billexception.html b/docs/files/src-bitpaysdk-exceptions-billexception.html
new file mode 100644
index 00000000..ad23576c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-billexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillException Bill exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-billqueryexception.html b/docs/files/src-bitpaysdk-exceptions-billqueryexception.html
new file mode 100644
index 00000000..f04c107b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-billqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillQueryException Bill query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-billupdateexception.html b/docs/files/src-bitpaysdk-exceptions-billupdateexception.html
new file mode 100644
index 00000000..c1968fb2
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-billupdateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillUpdateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillUpdateException Bill update exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-bitpayexception.html b/docs/files/src-bitpaysdk-exceptions-bitpayexception.html
new file mode 100644
index 00000000..2dce28a8
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-bitpayexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPayException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BitPayException Generic exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-currencyexception.html b/docs/files/src-bitpaysdk-exceptions-currencyexception.html
new file mode 100644
index 00000000..b2995985
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-currencyexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyException Generic currency exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-currencyqueryexception.html b/docs/files/src-bitpaysdk-exceptions-currencyqueryexception.html
new file mode 100644
index 00000000..e3a963bd
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-currencyqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyQueryException Currency query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoicecancellationexception.html b/docs/files/src-bitpaysdk-exceptions-invoicecancellationexception.html
new file mode 100644
index 00000000..8b667c0b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoicecancellationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCancellationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceCancellationException Invoice cancellation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoicecreationexception.html b/docs/files/src-bitpaysdk-exceptions-invoicecreationexception.html
new file mode 100644
index 00000000..f260c874
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoicecreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceCreationException Invoice creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoiceexception.html b/docs/files/src-bitpaysdk-exceptions-invoiceexception.html
new file mode 100644
index 00000000..cd5e5218
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoiceexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceException Generic invoice exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoicepaymentexception.html b/docs/files/src-bitpaysdk-exceptions-invoicepaymentexception.html
new file mode 100644
index 00000000..669703e3
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoicepaymentexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoicePaymentException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoicePaymentException Invoice payment exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoicequeryexception.html b/docs/files/src-bitpaysdk-exceptions-invoicequeryexception.html
new file mode 100644
index 00000000..37f1d761
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoicequeryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceQueryException Invoice query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-invoiceupdateexception.html b/docs/files/src-bitpaysdk-exceptions-invoiceupdateexception.html
new file mode 100644
index 00000000..a9a3e01b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-invoiceupdateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceUpdateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceUpdateException Invoice update exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-ledgerexception.html b/docs/files/src-bitpaysdk-exceptions-ledgerexception.html
new file mode 100644
index 00000000..8bc78dd8
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-ledgerexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerException Generic ledger exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-ledgerqueryexception.html b/docs/files/src-bitpaysdk-exceptions-ledgerqueryexception.html
new file mode 100644
index 00000000..6a9dedfd
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-ledgerqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerQueryException Ledger query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutbatchcancellationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutbatchcancellationexception.html
new file mode 100644
index 00000000..e88c5440
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutbatchcancellationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCancellationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchCancellationException Payout batch cancellation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutbatchcreationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutbatchcreationexception.html
new file mode 100644
index 00000000..4a9da5cd
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutbatchcreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchCreationException Payout batch creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutbatchexception.html b/docs/files/src-bitpaysdk-exceptions-payoutbatchexception.html
new file mode 100644
index 00000000..fada75ce
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutbatchexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchException Generic payout batch exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutbatchnotificationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutbatchnotificationexception.html
new file mode 100644
index 00000000..1af82c87
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutbatchnotificationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchNotificationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchNotificationException Payout batch notification exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutbatchqueryexception.html b/docs/files/src-bitpaysdk-exceptions-payoutbatchqueryexception.html
new file mode 100644
index 00000000..2f01f4aa
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutbatchqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchQueryException Payout batch query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutcancellationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutcancellationexception.html
new file mode 100644
index 00000000..e10c8d1a
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutcancellationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCancellationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutCancellationException Payout cancellation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutcreationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutcreationexception.html
new file mode 100644
index 00000000..a8b29e6f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutcreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutCreationException Generic payout creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutexception.html b/docs/files/src-bitpaysdk-exceptions-payoutexception.html
new file mode 100644
index 00000000..18f2deb3
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutException Generic payout batch exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutnotificationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutnotificationexception.html
new file mode 100644
index 00000000..401f20ca
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutnotificationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutNotificationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutNotificationException Payout notification exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutqueryexception.html b/docs/files/src-bitpaysdk-exceptions-payoutqueryexception.html
new file mode 100644
index 00000000..d79dcc12
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutQueryException Payout query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientcancellationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientcancellationexception.html
new file mode 100644
index 00000000..12a9259f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientcancellationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCancellationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientCancellationException Payout recipient cancellation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientcreationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientcreationexception.html
new file mode 100644
index 00000000..f3e7d04b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientcreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientCreationException Payout recipient creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientexception.html
new file mode 100644
index 00000000..4ee57af0
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientException Generic recipient exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientnotificationexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientnotificationexception.html
new file mode 100644
index 00000000..40666047
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientnotificationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientNotificationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientNotificationException Payout recipient notification exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientqueryexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientqueryexception.html
new file mode 100644
index 00000000..db1759f3
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientQueryException Payout recipient query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutrecipientupdateexception.html b/docs/files/src-bitpaysdk-exceptions-payoutrecipientupdateexception.html
new file mode 100644
index 00000000..c7db3310
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutrecipientupdateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientUpdateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientUpdateException Payout recipient update exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-payoutupdateexception.html b/docs/files/src-bitpaysdk-exceptions-payoutupdateexception.html
new file mode 100644
index 00000000..d4d78be5
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-payoutupdateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutUpdateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutUpdateException Payout update exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-rateexception.html b/docs/files/src-bitpaysdk-exceptions-rateexception.html
new file mode 100644
index 00000000..9ca9093c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-rateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateException Generic rate exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-ratequeryexception.html b/docs/files/src-bitpaysdk-exceptions-ratequeryexception.html
new file mode 100644
index 00000000..c2494697
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-ratequeryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateQueryException Rate query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundcancellationexception.html b/docs/files/src-bitpaysdk-exceptions-refundcancellationexception.html
new file mode 100644
index 00000000..518cdbe1
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundcancellationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCancellationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundCancellationException Refund cancellation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundcreationexception.html b/docs/files/src-bitpaysdk-exceptions-refundcreationexception.html
new file mode 100644
index 00000000..c22e3b65
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundcreationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCreationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundCreationException Refund creation exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundexception.html b/docs/files/src-bitpaysdk-exceptions-refundexception.html
new file mode 100644
index 00000000..ad3a77f9
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundException Generic refund exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundnotificationexception.html b/docs/files/src-bitpaysdk-exceptions-refundnotificationexception.html
new file mode 100644
index 00000000..e3430419
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundnotificationexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundNotificationException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundNotificationException Refund notification exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundqueryexception.html b/docs/files/src-bitpaysdk-exceptions-refundqueryexception.html
new file mode 100644
index 00000000..e396a2de
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundQueryException Refund query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-refundupdateexception.html b/docs/files/src-bitpaysdk-exceptions-refundupdateexception.html
new file mode 100644
index 00000000..c1218d94
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-refundupdateexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundUpdateException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundUpdateException Refund update exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-settlementexception.html b/docs/files/src-bitpaysdk-exceptions-settlementexception.html
new file mode 100644
index 00000000..ec6ae346
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-settlementexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementException Generic settlement exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-settlementqueryexception.html b/docs/files/src-bitpaysdk-exceptions-settlementqueryexception.html
new file mode 100644
index 00000000..b8dd5889
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-settlementqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementQueryException Settlement query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-walletexception.html b/docs/files/src-bitpaysdk-exceptions-walletexception.html
new file mode 100644
index 00000000..c58e7f90
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-walletexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletException Generic wallet exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-exceptions-walletqueryexception.html b/docs/files/src-bitpaysdk-exceptions-walletqueryexception.html
new file mode 100644
index 00000000..25ad25e3
--- /dev/null
+++ b/docs/files/src-bitpaysdk-exceptions-walletqueryexception.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletQueryException.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletQueryException Wallet query exception.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-bill-bill.html b/docs/files/src-bitpaysdk-model-bill-bill.html
new file mode 100644
index 00000000..c665fb01
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-bill-bill.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Bill
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-bill-billstatus.html b/docs/files/src-bitpaysdk-model-bill-billstatus.html
new file mode 100644
index 00000000..d09bcd23
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-bill-billstatus.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillStatus.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ BillStatus Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-bill-item.html b/docs/files/src-bitpaysdk-model-bill-item.html
new file mode 100644
index 00000000..2a4aef3c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-bill-item.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Item.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Item
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-currency.html b/docs/files/src-bitpaysdk-model-currency.html
new file mode 100644
index 00000000..b875d388
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-currency.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currency.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Currency Object containing currency information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-facade.html b/docs/files/src-bitpaysdk-model-facade.html
new file mode 100644
index 00000000..2faba1f4
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-facade.html
@@ -0,0 +1,303 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Facade.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ Facade Facades are named collections of capabilities that can be granted,
+such as the ability to create invoices or grant refunds.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-buyer.html b/docs/files/src-bitpaysdk-model-invoice-buyer.html
new file mode 100644
index 00000000..4d0f888c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-buyer.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buyer.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Buyer Allows merchant to pass buyer related information in the invoice object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html b/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html
new file mode 100644
index 00000000..661d7d28
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerProvidedInfo.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BuyerProvidedInfo Information collected from the buyer during the process of paying an invoice. Initially this object is empty.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-invoice.html b/docs/files/src-bitpaysdk-model-invoice-invoice.html
new file mode 100644
index 00000000..f1c6ac39
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-invoice.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Invoice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html b/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html
new file mode 100644
index 00000000..9c25eb9f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceStatus.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ InvoiceStatus The type Invoice status.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html b/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html
new file mode 100644
index 00000000..9c9ba7fb
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemizedDetails.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ ItemizedDetails Class ItemizedDetails
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-minerfees.html b/docs/files/src-bitpaysdk-model-invoice-minerfees.html
new file mode 100644
index 00000000..aa65a628
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-minerfees.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFees.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ MinerFees The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html b/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html
new file mode 100644
index 00000000..bdde592f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesItem.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ MinerFeesItem Class MinerFeesItem
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-refund.html b/docs/files/src-bitpaysdk-model-invoice-refund.html
new file mode 100644
index 00000000..87de724b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-refund.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refund.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Refund Class Refund
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-refundinfo.html b/docs/files/src-bitpaysdk-model-invoice-refundinfo.html
new file mode 100644
index 00000000..d868d7d4
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-refundinfo.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfo.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundInfo For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-refundstatus.html b/docs/files/src-bitpaysdk-model-invoice-refundstatus.html
new file mode 100644
index 00000000..1174b798
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-refundstatus.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundStatus.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ RefundStatus Refund status list
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html b/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html
new file mode 100644
index 00000000..63870ab8
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundWebhook.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundWebhook Class RefundWebhook
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-shopper.html b/docs/files/src-bitpaysdk-model-invoice-shopper.html
new file mode 100644
index 00000000..be2ba2d2
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-shopper.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Shopper.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Shopper This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html
new file mode 100644
index 00000000..5a09714e
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrencies.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SupportedTransactionCurrencies Class SupportedTransactionCurrencies. The currencies that may be used to pay this invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html
new file mode 100644
index 00000000..e9591f2a
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html
@@ -0,0 +1,303 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrency.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SupportedTransactionCurrency Class SupportedTransactionCurrency
+The currency that may be used to pay this invoice. The values are objects with an "enabled" boolean and option.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-invoice-universalcodes.html b/docs/files/src-bitpaysdk-model-invoice-universalcodes.html
new file mode 100644
index 00000000..dcfbbe6f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-invoice-universalcodes.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UniversalCodes.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ UniversalCodes Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-ledger-buyer.html b/docs/files/src-bitpaysdk-model-ledger-buyer.html
new file mode 100644
index 00000000..96740b44
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-ledger-buyer.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buyer.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Buyer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-ledger-ledger.html b/docs/files/src-bitpaysdk-model-ledger-ledger.html
new file mode 100644
index 00000000..e6bd7470
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-ledger-ledger.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ledger.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Ledger
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html b/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html
new file mode 100644
index 00000000..7b1d2e5d
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerEntry.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payout.html b/docs/files/src-bitpaysdk-model-payout-payout.html
new file mode 100644
index 00000000..d4e3f90b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payout.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Payout.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Payout
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payoutgroup.html b/docs/files/src-bitpaysdk-model-payout-payoutgroup.html
new file mode 100644
index 00000000..2c22798a
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payoutgroup.html
@@ -0,0 +1,301 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutGroup.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutGroup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html b/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html
new file mode 100644
index 00000000..fedb4303
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutGroupFailed.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutGroupFailed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html b/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html
new file mode 100644
index 00000000..d8dbe2e2
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html b/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html
new file mode 100644
index 00000000..72045d7c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipients.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipients
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payoutstatus.html b/docs/files/src-bitpaysdk-model-payout-payoutstatus.html
new file mode 100644
index 00000000..441e4dde
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payoutstatus.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutStatus.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ PayoutStatus Interface PayoutStatus
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-payouttransaction.html b/docs/files/src-bitpaysdk-model-payout-payouttransaction.html
new file mode 100644
index 00000000..c7c43a14
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-payouttransaction.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutTransaction.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutTransaction Contains the cryptocurrency transaction details for the executed payout.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html b/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html
new file mode 100644
index 00000000..8019f3cc
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RecipientReferenceMethod.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ RecipientReferenceMethod List of recipient reference methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-payout-recipientstatus.html b/docs/files/src-bitpaysdk-model-payout-recipientstatus.html
new file mode 100644
index 00000000..91ab132b
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-payout-recipientstatus.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RecipientStatus.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ RecipientStatus Interface RecipientStatus
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-rate-rate.html b/docs/files/src-bitpaysdk-model-rate-rate.html
new file mode 100644
index 00000000..6a11518e
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-rate-rate.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Rate
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-rate-rates.html b/docs/files/src-bitpaysdk-model-rate-rates.html
new file mode 100644
index 00000000..cfadbc6a
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-rate-rates.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rates.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-invoicedata.html b/docs/files/src-bitpaysdk-model-settlement-invoicedata.html
new file mode 100644
index 00000000..ec523729
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-invoicedata.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceData.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceData Object containing relevant information from the paid invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html b/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html
new file mode 100644
index 00000000..151c8ad8
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutInfo.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutInfo Object containing the settlement info provided by the Merchant in his BitPay account settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-refundinfo.html b/docs/files/src-bitpaysdk-model-settlement-refundinfo.html
new file mode 100644
index 00000000..6714351c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-refundinfo.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfo.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundInfo Object containing information about the refund.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-settlement.html b/docs/files/src-bitpaysdk-model-settlement-settlement.html
new file mode 100644
index 00000000..c7e806ba
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-settlement.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Settlement Settlement data object.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html b/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html
new file mode 100644
index 00000000..acb7b602
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementLedgerEntry.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementLedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-settlement-withholdings.html b/docs/files/src-bitpaysdk-model-settlement-withholdings.html
new file mode 100644
index 00000000..a3b11b9c
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-settlement-withholdings.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WithHoldings.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-wallet-currencies.html b/docs/files/src-bitpaysdk-model-wallet-currencies.html
new file mode 100644
index 00000000..6a50c0ee
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-wallet-currencies.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currencies.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Currencies Details of what currencies support payments for this wallet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-wallet-currencyqr.html b/docs/files/src-bitpaysdk-model-wallet-currencyqr.html
new file mode 100644
index 00000000..edcda4df
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-wallet-currencyqr.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQr.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyQr Object containing QR code related information to show for this payment method
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-model-wallet-wallet.html b/docs/files/src-bitpaysdk-model-wallet-wallet.html
new file mode 100644
index 00000000..4781d86e
--- /dev/null
+++ b/docs/files/src-bitpaysdk-model-wallet-wallet.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Wallet.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Wallet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-posclient.html b/docs/files/src-bitpaysdk-posclient.html
new file mode 100644
index 00000000..195e198f
--- /dev/null
+++ b/docs/files/src-bitpaysdk-posclient.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PosClient.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PosClient Client for handling POS facade specific calls.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-tokens.html b/docs/files/src-bitpaysdk-tokens.html
new file mode 100644
index 00000000..2922d913
--- /dev/null
+++ b/docs/files/src-bitpaysdk-tokens.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Tokens.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Tokens Token object used to store the tokens for the different facades.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-util-jsonmapperfactory.html b/docs/files/src-bitpaysdk-util-jsonmapperfactory.html
new file mode 100644
index 00000000..20d35f59
--- /dev/null
+++ b/docs/files/src-bitpaysdk-util-jsonmapperfactory.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ JsonMapperFactory.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ JsonMapperFactory
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/src-bitpaysdk-util-restcli-restcli.html b/docs/files/src-bitpaysdk-util-restcli-restcli.html
new file mode 100644
index 00000000..6b2489a1
--- /dev/null
+++ b/docs/files/src-bitpaysdk-util-restcli-restcli.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RESTcli.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-abstractclienttestcase.html b/docs/files/test-functional-bitpaysdk-abstractclienttestcase.html
new file mode 100644
index 00000000..840f38b1
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-abstractclienttestcase.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AbstractClientTestCase.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ AbstractClientTestCase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-billclienttest.html b/docs/files/test-functional-bitpaysdk-billclienttest.html
new file mode 100644
index 00000000..45ca7459
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-billclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-config.html b/docs/files/test-functional-bitpaysdk-config.html
new file mode 100644
index 00000000..8a85bbea
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-config.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Config.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-invoiceclienttest.html b/docs/files/test-functional-bitpaysdk-invoiceclienttest.html
new file mode 100644
index 00000000..f593bd5f
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-invoiceclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-ledgerclienttest.html b/docs/files/test-functional-bitpaysdk-ledgerclienttest.html
new file mode 100644
index 00000000..2e463646
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-ledgerclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-payoutclienttest.html b/docs/files/test-functional-bitpaysdk-payoutclienttest.html
new file mode 100644
index 00000000..54b154e1
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-payoutclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-payoutrecipientsclienttest.html b/docs/files/test-functional-bitpaysdk-payoutrecipientsclienttest.html
new file mode 100644
index 00000000..78a4422f
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-payoutrecipientsclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientsClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-rateclienttest.html b/docs/files/test-functional-bitpaysdk-rateclienttest.html
new file mode 100644
index 00000000..176bb148
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-rateclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-refundclienttest.html b/docs/files/test-functional-bitpaysdk-refundclienttest.html
new file mode 100644
index 00000000..17aeb8e4
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-refundclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-settlementsclienttest.html b/docs/files/test-functional-bitpaysdk-settlementsclienttest.html
new file mode 100644
index 00000000..e7edf263
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-settlementsclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementsClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementsClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-tokenclienttest.html b/docs/files/test-functional-bitpaysdk-tokenclienttest.html
new file mode 100644
index 00000000..38557477
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-tokenclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TokenClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ TokenClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-functional-bitpaysdk-walletclienttest.html b/docs/files/test-functional-bitpaysdk-walletclienttest.html
new file mode 100644
index 00000000..368ed87f
--- /dev/null
+++ b/docs/files/test-functional-bitpaysdk-walletclienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-clienttest.html b/docs/files/test-unit-bitpaysdk-clienttest.html
new file mode 100644
index 00000000..0a2d316a
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-clienttest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ClientTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ ClientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-billcreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-billcreationexceptiontest.html
new file mode 100644
index 00000000..de1b5c29
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-billcreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-billdeliveryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-billdeliveryexceptiontest.html
new file mode 100644
index 00000000..ad25c3d5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-billdeliveryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillDeliveryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillDeliveryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-billexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-billexceptiontest.html
new file mode 100644
index 00000000..4b36195d
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-billexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-billqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-billqueryexceptiontest.html
new file mode 100644
index 00000000..ed1af786
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-billqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-billupdateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-billupdateexceptiontest.html
new file mode 100644
index 00000000..b01ba26c
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-billupdateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillUpdateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillUpdateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-bitpayexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-bitpayexceptiontest.html
new file mode 100644
index 00000000..3ac89ed6
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-bitpayexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPayExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BitPayExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-currencyexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-currencyexceptiontest.html
new file mode 100644
index 00000000..71f16587
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-currencyexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-currencyqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-currencyqueryexceptiontest.html
new file mode 100644
index 00000000..ad0ef7ee
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-currencyqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoicecancellationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoicecancellationexceptiontest.html
new file mode 100644
index 00000000..122ce657
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoicecancellationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCancellationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceCancellationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoicecreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoicecreationexceptiontest.html
new file mode 100644
index 00000000..a0e1b0e0
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoicecreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoiceexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoiceexceptiontest.html
new file mode 100644
index 00000000..b735e52c
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoiceexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoicepaymentexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoicepaymentexceptiontest.html
new file mode 100644
index 00000000..b9d01a1b
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoicepaymentexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoicePaymentExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoicePaymentExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoicequeryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoicequeryexceptiontest.html
new file mode 100644
index 00000000..7a335168
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoicequeryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-invoiceupdateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-invoiceupdateexceptiontest.html
new file mode 100644
index 00000000..4b37bafb
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-invoiceupdateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceUpdateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceUpdateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-ledgerexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-ledgerexceptiontest.html
new file mode 100644
index 00000000..50595b04
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-ledgerexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-ledgerqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-ledgerqueryexceptiontest.html
new file mode 100644
index 00000000..f1dc2ed4
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-ledgerqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcancellationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcancellationexceptiontest.html
new file mode 100644
index 00000000..384354d9
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcancellationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCancellationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchCancellationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcreationexceptiontest.html
new file mode 100644
index 00000000..0df31277
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchcreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchexceptiontest.html
new file mode 100644
index 00000000..c0c36253
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchnotificationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchnotificationexceptiontest.html
new file mode 100644
index 00000000..0b4bbce5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchnotificationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchNotificationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchNotificationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchqueryexceptiontest.html
new file mode 100644
index 00000000..8c5d5041
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutbatchqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutBatchQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutBatchQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutcancellationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutcancellationexceptiontest.html
new file mode 100644
index 00000000..74d41f72
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutcancellationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCancellationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutCancellationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutcreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutcreationexceptiontest.html
new file mode 100644
index 00000000..55ff28c2
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutcreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutexceptiontest.html
new file mode 100644
index 00000000..f313b742
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutnotificationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutnotificationexceptiontest.html
new file mode 100644
index 00000000..e510a89e
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutnotificationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutNotificationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutNotificationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutqueryexceptiontest.html
new file mode 100644
index 00000000..1491a8be
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcancellationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcancellationexceptiontest.html
new file mode 100644
index 00000000..4e965e06
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcancellationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCancellationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientCancellationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcreationexceptiontest.html
new file mode 100644
index 00000000..d019fdaa
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientcreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientexceptiontest.html
new file mode 100644
index 00000000..fbd230e5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientnotificationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientnotificationexceptiontest.html
new file mode 100644
index 00000000..9db3e45a
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientnotificationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientNotificationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientNotificationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientqueryexceptiontest.html
new file mode 100644
index 00000000..17d812e0
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientupdateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientupdateexceptiontest.html
new file mode 100644
index 00000000..a138f7e2
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutrecipientupdateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientUpdateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientUpdateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-payoutupdateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-payoutupdateexceptiontest.html
new file mode 100644
index 00000000..c86b8139
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-payoutupdateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutUpdateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutUpdateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-rateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-rateexceptiontest.html
new file mode 100644
index 00000000..e8487def
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-rateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-ratequeryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-ratequeryexceptiontest.html
new file mode 100644
index 00000000..94c394d4
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-ratequeryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundcancellationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundcancellationexceptiontest.html
new file mode 100644
index 00000000..2e01c4d6
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundcancellationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCancellationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundCancellationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundcreationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundcreationexceptiontest.html
new file mode 100644
index 00000000..8663a3f2
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundcreationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundCreationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundCreationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundexceptiontest.html
new file mode 100644
index 00000000..cfffc618
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundnotificationexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundnotificationexceptiontest.html
new file mode 100644
index 00000000..bf4a1bea
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundnotificationexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundNotificationExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundNotificationExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundqueryexceptiontest.html
new file mode 100644
index 00000000..6a55d5ed
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-refundupdateexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-refundupdateexceptiontest.html
new file mode 100644
index 00000000..d47f5e81
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-refundupdateexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundUpdateExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundUpdateExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-settlementexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-settlementexceptiontest.html
new file mode 100644
index 00000000..f4b85564
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-settlementexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-settlementqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-settlementqueryexceptiontest.html
new file mode 100644
index 00000000..03696138
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-settlementqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-walletexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-walletexceptiontest.html
new file mode 100644
index 00000000..24aed14d
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-walletexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-exceptions-walletqueryexceptiontest.html b/docs/files/test-unit-bitpaysdk-exceptions-walletqueryexceptiontest.html
new file mode 100644
index 00000000..9520bba8
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-exceptions-walletqueryexceptiontest.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletQueryExceptionTest.php
+
+ Copyright (c) 2019 BitPay
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletQueryExceptionTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-bill-billtest.html b/docs/files/test-unit-bitpaysdk-model-bill-billtest.html
new file mode 100644
index 00000000..ff099ef5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-bill-billtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BillTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-bill-itemtest.html b/docs/files/test-unit-bitpaysdk-model-bill-itemtest.html
new file mode 100644
index 00000000..88db27b5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-bill-itemtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ ItemTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-currencytest.html b/docs/files/test-unit-bitpaysdk-model-currencytest.html
new file mode 100644
index 00000000..6005bb08
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-currencytest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-buyerprovidedinfotest.html b/docs/files/test-unit-bitpaysdk-model-invoice-buyerprovidedinfotest.html
new file mode 100644
index 00000000..78dab235
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-buyerprovidedinfotest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerProvidedInfoTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BuyerProvidedInfoTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-buyertest.html b/docs/files/test-unit-bitpaysdk-model-invoice-buyertest.html
new file mode 100644
index 00000000..106e65b5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-buyertest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BuyerTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-invoicetest.html b/docs/files/test-unit-bitpaysdk-model-invoice-invoicetest.html
new file mode 100644
index 00000000..8443cb8d
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-invoicetest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-itemizeddetailstest.html b/docs/files/test-unit-bitpaysdk-model-invoice-itemizeddetailstest.html
new file mode 100644
index 00000000..dc5497e5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-itemizeddetailstest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ItemizedDetailsTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ ItemizedDetailsTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-minerfeesitemtest.html b/docs/files/test-unit-bitpaysdk-model-invoice-minerfeesitemtest.html
new file mode 100644
index 00000000..f89494d8
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-minerfeesitemtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesItemTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ MinerFeesItemTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-minerfeestest.html b/docs/files/test-unit-bitpaysdk-model-invoice-minerfeestest.html
new file mode 100644
index 00000000..a6be7b55
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-minerfeestest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MinerFeesTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ MinerFeesTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-refundinfotest.html b/docs/files/test-unit-bitpaysdk-model-invoice-refundinfotest.html
new file mode 100644
index 00000000..be0507ac
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-refundinfotest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfoTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundInfoTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-refundtest.html b/docs/files/test-unit-bitpaysdk-model-invoice-refundtest.html
new file mode 100644
index 00000000..dd5509d5
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-refundtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-refundwebhooktest.html b/docs/files/test-unit-bitpaysdk-model-invoice-refundwebhooktest.html
new file mode 100644
index 00000000..ce778fe0
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-refundwebhooktest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundWebhookTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundWebhookTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-shoppertest.html b/docs/files/test-unit-bitpaysdk-model-invoice-shoppertest.html
new file mode 100644
index 00000000..5d0db64d
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-shoppertest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ShopperTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ ShopperTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrenciestest.html b/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrenciestest.html
new file mode 100644
index 00000000..56b455ae
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrenciestest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrenciesTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SupportedTransactionCurrenciesTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrencytest.html b/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrencytest.html
new file mode 100644
index 00000000..42e8376f
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-supportedtransactioncurrencytest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SupportedTransactionCurrencyTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SupportedTransactionCurrencyTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-invoice-universalcodestest.html b/docs/files/test-unit-bitpaysdk-model-invoice-universalcodestest.html
new file mode 100644
index 00000000..1de1a715
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-invoice-universalcodestest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UniversalCodesTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ UniversalCodesTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-ledger-buyertest.html b/docs/files/test-unit-bitpaysdk-model-ledger-buyertest.html
new file mode 100644
index 00000000..70818b6a
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-ledger-buyertest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BuyerTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BuyerTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-ledger-ledgerentrytest.html b/docs/files/test-unit-bitpaysdk-model-ledger-ledgerentrytest.html
new file mode 100644
index 00000000..b7238515
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-ledger-ledgerentrytest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerEntryTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerEntryTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-ledger-ledgertest.html b/docs/files/test-unit-bitpaysdk-model-ledger-ledgertest.html
new file mode 100644
index 00000000..4e8d2f9d
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-ledger-ledgertest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LedgerTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ LedgerTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipientstest.html b/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipientstest.html
new file mode 100644
index 00000000..79b8ce79
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipientstest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientsTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientsTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipienttest.html b/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipienttest.html
new file mode 100644
index 00000000..534b8af7
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-payout-payoutrecipienttest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutRecipientTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutRecipientTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-payout-payouttest.html b/docs/files/test-unit-bitpaysdk-model-payout-payouttest.html
new file mode 100644
index 00000000..183021f8
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-payout-payouttest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-rate-ratestest.html b/docs/files/test-unit-bitpaysdk-model-rate-ratestest.html
new file mode 100644
index 00000000..76132d1f
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-rate-ratestest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RatesTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RatesTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-rate-ratetest.html b/docs/files/test-unit-bitpaysdk-model-rate-ratetest.html
new file mode 100644
index 00000000..d06273f7
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-rate-ratetest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RateTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RateTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-invoicedatatest.html b/docs/files/test-unit-bitpaysdk-model-settlement-invoicedatatest.html
new file mode 100644
index 00000000..b14428f3
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-invoicedatatest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ InvoiceDataTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceDataTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-payoutinfotest.html b/docs/files/test-unit-bitpaysdk-model-settlement-payoutinfotest.html
new file mode 100644
index 00000000..ed2de4e6
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-payoutinfotest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PayoutInfoTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PayoutInfoTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-refundinfotest.html b/docs/files/test-unit-bitpaysdk-model-settlement-refundinfotest.html
new file mode 100644
index 00000000..dca39f7a
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-refundinfotest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RefundInfoTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RefundInfoTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-settlementledgerentrytest.html b/docs/files/test-unit-bitpaysdk-model-settlement-settlementledgerentrytest.html
new file mode 100644
index 00000000..04294f00
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-settlementledgerentrytest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementLedgerEntryTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementLedgerEntryTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-settlementtest.html b/docs/files/test-unit-bitpaysdk-model-settlement-settlementtest.html
new file mode 100644
index 00000000..43c7e504
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-settlementtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SettlementTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ SettlementTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-settlement-withholdingstest.html b/docs/files/test-unit-bitpaysdk-model-settlement-withholdingstest.html
new file mode 100644
index 00000000..196767a6
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-settlement-withholdingstest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WithHoldingsTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WithHoldingsTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-wallet-currenciestest.html b/docs/files/test-unit-bitpaysdk-model-wallet-currenciestest.html
new file mode 100644
index 00000000..e72bf695
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-wallet-currenciestest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrenciesTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrenciesTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-wallet-currencyqrtest.html b/docs/files/test-unit-bitpaysdk-model-wallet-currencyqrtest.html
new file mode 100644
index 00000000..ce6f44c9
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-wallet-currencyqrtest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CurrencyQrTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ CurrencyQrTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-model-wallet-wallettest.html b/docs/files/test-unit-bitpaysdk-model-wallet-wallettest.html
new file mode 100644
index 00000000..f61f1d56
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-model-wallet-wallettest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WalletTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ WalletTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/files/test-unit-bitpaysdk-tokenstest.html b/docs/files/test-unit-bitpaysdk-tokenstest.html
new file mode 100644
index 00000000..c185534f
--- /dev/null
+++ b/docs/files/test-unit-bitpaysdk-tokenstest.html
@@ -0,0 +1,317 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TokensTest.php
+
+
+
+
+
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ TokensTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html
new file mode 100644
index 00000000..5d718e85
--- /dev/null
+++ b/docs/graphs/classes.html
@@ -0,0 +1,146 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..cf45598d
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,189 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documentation
+
+
+
+
+ Table of Contents
+
+
+
+
+
+ Packages
+
+
+
+
+ BitPaySDK
+
+
+
+ Namespaces
+
+
+
+
+ BitPaySDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/indices/files.html b/docs/indices/files.html
new file mode 100644
index 00000000..b10f00ff
--- /dev/null
+++ b/docs/indices/files.html
@@ -0,0 +1,297 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Files
+ B
+
+ C
+
+ E
+
+ F
+
+ I
+
+ J
+
+ L
+
+ M
+
+ P
+
+ R
+
+ S
+
+ T
+
+ U
+
+ W
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/js/search.js b/docs/js/search.js
new file mode 100644
index 00000000..093d6d03
--- /dev/null
+++ b/docs/js/search.js
@@ -0,0 +1,173 @@
+// Search module for phpDocumentor
+//
+// This module is a wrapper around fuse.js that will use a given index and attach itself to a
+// search form and to a search results pane identified by the following data attributes:
+//
+// 1. data-search-form
+// 2. data-search-results
+//
+// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for
+// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated
+// with rendered results.
+//
+// The search has various stages, upon loading this stage the data-search-form receives the CSS class
+// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended
+// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this
+// feature.
+//
+// After loading this module, it is expected to load a search index asynchronously, for example:
+//
+//
+//
+// In this script the generated index should attach itself to the search module using the `appendIndex` function. By
+// doing it like this the page will continue loading, unhindered by the loading of the search.
+//
+// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will
+// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this
+// point, the input field will also have it's 'disabled' attribute removed.
+var Search = (function () {
+ var fuse;
+ var index = [];
+ var options = {
+ shouldSort: true,
+ threshold: 0.6,
+ location: 0,
+ distance: 100,
+ maxPatternLength: 32,
+ minMatchCharLength: 1,
+ keys: [
+ "fqsen",
+ "name",
+ "summary",
+ "url"
+ ]
+ };
+
+ // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function)
+ // Returns a function, that, as long as it continues to be invoked, will not
+ // be triggered. The function will be called after it stops being called for
+ // N milliseconds. If `immediate` is passed, trigger the function on the
+ // leading edge, instead of the trailing.
+ function debounce(func, wait, immediate) {
+ var timeout;
+
+ return function executedFunction() {
+ var context = this;
+ var args = arguments;
+
+ var later = function () {
+ timeout = null;
+ if (!immediate) func.apply(context, args);
+ };
+
+ var callNow = immediate && !timeout;
+ clearTimeout(timeout);
+ timeout = setTimeout(later, wait);
+ if (callNow) func.apply(context, args);
+ };
+ }
+
+ function close() {
+ // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/
+ const scrollY = document.body.style.top;
+ document.body.style.position = '';
+ document.body.style.top = '';
+ window.scrollTo(0, parseInt(scrollY || '0') * -1);
+ // End scroll prevention
+
+ var form = document.querySelector('[data-search-form]');
+ var searchResults = document.querySelector('[data-search-results]');
+
+ form.classList.toggle('phpdocumentor-search--has-results', false);
+ searchResults.classList.add('phpdocumentor-search-results--hidden');
+ var searchField = document.querySelector('[data-search-form] input[type="search"]');
+ searchField.blur();
+ }
+
+ function search(event) {
+ // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/
+ document.body.style.position = 'fixed';
+ document.body.style.top = `-${window.scrollY}px`;
+ // End scroll prevention
+
+ // prevent enter's from autosubmitting
+ event.stopPropagation();
+
+ var form = document.querySelector('[data-search-form]');
+ var searchResults = document.querySelector('[data-search-results]');
+ var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries');
+
+ searchResultEntries.innerHTML = '';
+
+ if (!event.target.value) {
+ close();
+ return;
+ }
+
+ form.classList.toggle('phpdocumentor-search--has-results', true);
+ searchResults.classList.remove('phpdocumentor-search-results--hidden');
+ var results = fuse.search(event.target.value, {limit: 25});
+
+ results.forEach(function (result) {
+ var entry = document.createElement("li");
+ entry.classList.add("phpdocumentor-search-results__entry");
+ entry.innerHTML += '\n";
+ entry.innerHTML += '' + result.fqsen + " \n";
+ entry.innerHTML += '' + result.summary + '
';
+ searchResultEntries.appendChild(entry)
+ });
+ }
+
+ function appendIndex(added) {
+ index = index.concat(added);
+
+ // re-initialize search engine when appending an index after initialisation
+ if (typeof fuse !== 'undefined') {
+ fuse = new Fuse(index, options);
+ }
+ }
+
+ function init() {
+ fuse = new Fuse(index, options);
+
+ var form = document.querySelector('[data-search-form]');
+ var searchField = document.querySelector('[data-search-form] input[type="search"]');
+
+ var closeButton = document.querySelector('.phpdocumentor-search-results__close');
+ closeButton.addEventListener('click', function() { close() }.bind(this));
+
+ var searchResults = document.querySelector('[data-search-results]');
+ searchResults.addEventListener('click', function() { close() }.bind(this));
+
+ form.classList.add('phpdocumentor-search--active');
+
+ searchField.setAttribute('placeholder', 'Search (Press "/" to focus)');
+ searchField.removeAttribute('disabled');
+ searchField.addEventListener('keyup', debounce(search, 300));
+
+ window.addEventListener('keyup', function (event) {
+ if (event.key === '/') {
+ searchField.focus();
+ }
+ if (event.code === 'Escape') {
+ close();
+ }
+ }.bind(this));
+ }
+
+ return {
+ appendIndex,
+ init
+ }
+})();
+
+window.addEventListener('DOMContentLoaded', function () {
+ var form = document.querySelector('[data-search-form]');
+
+ // When JS is supported; show search box. Must be before including the search for it to take effect immediately
+ form.classList.add('phpdocumentor-search--enabled');
+});
+
+window.addEventListener('load', function () {
+ Search.init();
+});
diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js
new file mode 100644
index 00000000..953a8605
--- /dev/null
+++ b/docs/js/searchIndex.js
@@ -0,0 +1,8864 @@
+Search.appendIndex(
+ [
+ {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient",
+ "name": "BillClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020bill\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-BillClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Bill\u0020Client.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003Acreate\u0028\u0029",
+ "name": "create",
+ "summary": "Create\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_create"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020bill\u0020by\u0020bill\u0020id\u0020using\u0020the\u0020specified\u0020facade.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003AgetBills\u0028\u0029",
+ "name": "getBills",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020bills.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_getBills"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Update\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003Adeliver\u0028\u0029",
+ "name": "deliver",
+ "summary": "Deliver\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_deliver"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003AmapJsonToBillClass\u0028\u0029",
+ "name": "mapJsonToBillClass",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-BillClient.html#method_mapJsonToBillClass"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-BillClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-BillClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\BillClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-BillClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient",
+ "name": "InvoiceClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020invoice\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Invoice\u0020Client.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003Acreate\u0028\u0029",
+ "name": "create",
+ "summary": "Create\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_create"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Update\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020invoice\u0020by\u0020invoice\u0020id\u0020using\u0020the\u0020specified\u0020facade.\u0020\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\nauthorized\u0020for\u0020the\u0020specified\u0020facade\u0020\u0028the\u0020public\u0020facade\u0020requires\u0020no\u0020authorization\u0029.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AgetByGuid\u0028\u0029",
+ "name": "getByGuid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_getByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AgetInvoices\u0028\u0029",
+ "name": "getInvoices",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020invoices.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_getInvoices"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003ArequestNotification\u0028\u0029",
+ "name": "requestNotification",
+ "summary": "Request\u0020a\u0020BitPay\u0020Invoice\u0020Webhook.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_requestNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003Acancel\u0028\u0029",
+ "name": "cancel",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_cancel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AcancelByGuid\u0028\u0029",
+ "name": "cancelByGuid",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_cancelByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003Apay\u0028\u0029",
+ "name": "pay",
+ "summary": "Pay\u0020an\u0020invoice\u0020with\u0020a\u0020mock\u0020transaction",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_pay"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AbuyerEmailOrSms\u0028\u0029",
+ "name": "buyerEmailOrSms",
+ "summary": "Check\u0020if\u0020buyerEmail\u0020or\u0020buyerSms\u0020is\u0020present,\u0020and\u0020not\u0020both.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_buyerEmailOrSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003AisSmsCodeRequired\u0028\u0029",
+ "name": "isSmsCodeRequired",
+ "summary": "Check\u0020if\u0020smsCode\u0020is\u0020required.",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#method_isSmsCodeRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\InvoiceClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-InvoiceClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient",
+ "name": "LedgerClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020ledger\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Ledger\u0020Client.",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020list\u0020of\u0020ledgers\u0020by\u0020date\u0020range\u0020using\u0020the\u0020merchant\u0020facade.",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003AgetLedgers\u0028\u0029",
+ "name": "getLedgers",
+ "summary": "Retrieve\u0020a\u0020list\u0020of\u0020ledgers\u0020using\u0020the\u0020merchant\u0020facade.",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#method_getLedgers"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\LedgerClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-LedgerClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient",
+ "name": "PayoutClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020payout\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Payout\u0020Client.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003Asubmit\u0028\u0029",
+ "name": "submit",
+ "summary": "Submit\u0020a\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_submit"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020payout\u0020by\u0020payout\u0020id\u0020using.\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\u0020authorized\nfor\u0020the\u0020payout\u0020facade.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003AgetPayouts\u0028\u0029",
+ "name": "getPayouts",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020payouts.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_getPayouts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003Acancel\u0028\u0029",
+ "name": "cancel",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_cancel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003ArequestNotification\u0028\u0029",
+ "name": "requestNotification",
+ "summary": "Notify\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_requestNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003AcreateGroup\u0028\u0029",
+ "name": "createGroup",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_createGroup"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003AcancelGroup\u0028\u0029",
+ "name": "cancelGroup",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_cancelGroup"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003AgetPayoutGroupResponse\u0028\u0029",
+ "name": "getPayoutGroupResponse",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#method_getPayoutGroupResponse"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient",
+ "name": "PayoutRecipientsClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020recipients\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Payout\u0020Recipients\u0020Client.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003Asubmit\u0028\u0029",
+ "name": "submit",
+ "summary": "Submit\u0020BitPay\u0020Payout\u0020Recipients.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_submit"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020payout\u0020recipient\u0020by\u0020batch\u0020id\u0020using.\u0020\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\u0020authorized\u0020for\u0020the\npayout\u0020facade.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003AgetPayoutRecipients\u0028\u0029",
+ "name": "getPayoutRecipients",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020Payout\u0020Recipients.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_getPayoutRecipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Update\u0020a\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003Adelete\u0028\u0029",
+ "name": "delete",
+ "summary": "Delete\u0020a\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_delete"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003ArequestNotification\u0028\u0029",
+ "name": "requestNotification",
+ "summary": "Notify\u0020BitPay\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#method_requestNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\PayoutRecipientsClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-PayoutRecipientsClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient",
+ "name": "RateClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020rate\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-RateClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RateClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Rate\u0020Client.",
+ "url": "classes/BitPaySDK-Client-RateClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003AgetRates\u0028\u0029",
+ "name": "getRates",
+ "summary": "Retrieve\u0020the\u0020exchange\u0020rate\u0020table\u0020maintained\u0020by\u0020BitPay.\u0020\u0020See\u0020https\u003A\/\/bitpay.com\/bitcoin\u002Dexchange\u002Drates.",
+ "url": "classes/BitPaySDK-Client-RateClient.html#method_getRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003AgetCurrencyRates\u0028\u0029",
+ "name": "getCurrencyRates",
+ "summary": "Retrieve\u0020all\u0020the\u0020rates\u0020for\u0020a\u0020given\u0020cryptocurrency",
+ "url": "classes/BitPaySDK-Client-RateClient.html#method_getCurrencyRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003AgetCurrencyPairRate\u0028\u0029",
+ "name": "getCurrencyPairRate",
+ "summary": "Retrieve\u0020the\u0020rate\u0020for\u0020a\u0020cryptocurrency\u0020\/\u0020fiat\u0020pair",
+ "url": "classes/BitPaySDK-Client-RateClient.html#method_getCurrencyPairRate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RateClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RateClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RateClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient",
+ "name": "RefundClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020refund\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Bill\u0020Client.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003Acreate\u0028\u0029",
+ "name": "create",
+ "summary": "Create\u0020a\u0020refund\u0020for\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_create"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Update\u0020the\u0020status\u0020of\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AupdateByGuid\u0028\u0029",
+ "name": "updateByGuid",
+ "summary": "Update\u0020the\u0020status\u0020of\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_updateByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AgetRefunds\u0028\u0029",
+ "name": "getRefunds",
+ "summary": "Retrieve\u0020all\u0020refund\u0020requests\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_getRefunds"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieve\u0020a\u0020previously\u0020made\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AgetByGuid\u0028\u0029",
+ "name": "getByGuid",
+ "summary": "Retrieve\u0020a\u0020previously\u0020made\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice\u0020by\u0020guid.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_getByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AsendNotification\u0028\u0029",
+ "name": "sendNotification",
+ "summary": "Send\u0020a\u0020refund\u0020notification.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_sendNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003Acancel\u0028\u0029",
+ "name": "cancel",
+ "summary": "Cancel\u0020a\u0020previously\u0020submitted\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_cancel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003AcancelByGuid\u0028\u0029",
+ "name": "cancelByGuid",
+ "summary": "Cancel\u0020a\u0020previously\u0020submitted\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#method_cancelByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\RefundClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-RefundClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient",
+ "name": "SettlementClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020settlement\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Settlements\u0020Client.",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003AgetSettlements\u0028\u0029",
+ "name": "getSettlements",
+ "summary": "Retrieves\u0020settlement\u0020reports\u0020for\u0020the\u0020calling\u0020merchant\u0020filtered\u0020by\u0020query.",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#method_getSettlements"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Retrieves\u0020a\u0020summary\u0020of\u0020the\u0020specified\u0020settlement.",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003AgetReconciliationReport\u0028\u0029",
+ "name": "getReconciliationReport",
+ "summary": "Gets\u0020a\u0020detailed\u0020reconciliation\u0020report\u0020of\u0020the\u0020activity\u0020within\u0020the\u0020settlement\u0020period.",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#method_getReconciliationReport"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\SettlementClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-SettlementClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient",
+ "name": "TokenClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020token\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-TokenClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-TokenClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Token\u0020Client.",
+ "url": "classes/BitPaySDK-Client-TokenClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient\u003A\u003AgetTokens\u0028\u0029",
+ "name": "getTokens",
+ "summary": "Get\u0020Tokens.",
+ "url": "classes/BitPaySDK-Client-TokenClient.html#method_getTokens"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-TokenClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\TokenClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-TokenClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient",
+ "name": "WalletClient",
+ "summary": "Handles\u0020interactions\u0020with\u0020the\u0020wallet\u0020endpoints.",
+ "url": "classes/BitPaySDK-Client-WalletClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-WalletClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient\u003A\u003AgetInstance\u0028\u0029",
+ "name": "getInstance",
+ "summary": "Factory\u0020method\u0020for\u0020Wallet\u0020Client.",
+ "url": "classes/BitPaySDK-Client-WalletClient.html#method_getInstance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient\u003A\u003AgetSupportedWallets\u0028\u0029",
+ "name": "getSupportedWallets",
+ "summary": "Retrieve\u0020all\u0020supported\u0020wallets.",
+ "url": "classes/BitPaySDK-Client-WalletClient.html#method_getSupportedWallets"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient\u003A\u003A\u0024instance",
+ "name": "instance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-WalletClient.html#property_instance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\\WalletClient\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client-WalletClient.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client",
+ "name": "Client",
+ "summary": "Client\u0020class\u0020to\u0020interact\u0020with\u0020the\u0020BitPay\u0020API.",
+ "url": "classes/BitPaySDK-Client.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Client\u0020constructor.",
+ "url": "classes/BitPaySDK-Client.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreateWithData\u0028\u0029",
+ "name": "createWithData",
+ "summary": "Constructor\u0020for\u0020use\u0020if\u0020the\u0020keys\u0020and\u0020SIN\u0020are\u0020managed\u0020by\u0020this\u0020library.",
+ "url": "classes/BitPaySDK-Client.html#method_createWithData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreateWithFile\u0028\u0029",
+ "name": "createWithFile",
+ "summary": "Constructor\u0020for\u0020use\u0020if\u0020the\u0020keys\u0020and\u0020SIN\u0020are\u0020managed\u0020by\u0020this\u0020library.",
+ "url": "classes/BitPaySDK-Client.html#method_createWithFile"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetTokens\u0028\u0029",
+ "name": "getTokens",
+ "summary": "Get\u0020Tokens.",
+ "url": "classes/BitPaySDK-Client.html#method_getTokens"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreateInvoice\u0028\u0029",
+ "name": "createInvoice",
+ "summary": "Create\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_createInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AupdateInvoice\u0028\u0029",
+ "name": "updateInvoice",
+ "summary": "Update\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_updateInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetInvoice\u0028\u0029",
+ "name": "getInvoice",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020invoice\u0020by\u0020invoice\u0020id\u0020using\u0020the\u0020specified\u0020facade.\u0020\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\nauthorized\u0020for\u0020the\u0020specified\u0020facade\u0020\u0028the\u0020public\u0020facade\u0020requires\u0020no\u0020authorization\u0029.",
+ "url": "classes/BitPaySDK-Client.html#method_getInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetInvoiceByGuid\u0028\u0029",
+ "name": "getInvoiceByGuid",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020invoice\u0020by\u0020guid\u0020using\u0020the\u0020specified\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getInvoiceByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetInvoices\u0028\u0029",
+ "name": "getInvoices",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020invoices.",
+ "url": "classes/BitPaySDK-Client.html#method_getInvoices"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003ArequestInvoiceNotification\u0028\u0029",
+ "name": "requestInvoiceNotification",
+ "summary": "Request\u0020a\u0020BitPay\u0020Invoice\u0020Webhook.",
+ "url": "classes/BitPaySDK-Client.html#method_requestInvoiceNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelInvoice\u0028\u0029",
+ "name": "cancelInvoice",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_cancelInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelInvoiceByGuid\u0028\u0029",
+ "name": "cancelInvoiceByGuid",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_cancelInvoiceByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003ApayInvoice\u0028\u0029",
+ "name": "payInvoice",
+ "summary": "Pay\u0020an\u0020invoice\u0020with\u0020a\u0020mock\u0020transaction",
+ "url": "classes/BitPaySDK-Client.html#method_payInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreateRefund\u0028\u0029",
+ "name": "createRefund",
+ "summary": "Create\u0020a\u0020refund\u0020for\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_createRefund"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AupdateRefund\u0028\u0029",
+ "name": "updateRefund",
+ "summary": "Update\u0020the\u0020status\u0020of\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_updateRefund"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AupdateRefundByGuid\u0028\u0029",
+ "name": "updateRefundByGuid",
+ "summary": "Update\u0020the\u0020status\u0020of\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_updateRefundByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRefunds\u0028\u0029",
+ "name": "getRefunds",
+ "summary": "Retrieve\u0020all\u0020refund\u0020requests\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_getRefunds"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRefund\u0028\u0029",
+ "name": "getRefund",
+ "summary": "Retrieve\u0020a\u0020previously\u0020made\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_getRefund"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRefundByGuid\u0028\u0029",
+ "name": "getRefundByGuid",
+ "summary": "Retrieve\u0020a\u0020previously\u0020made\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_getRefundByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AsendRefundNotification\u0028\u0029",
+ "name": "sendRefundNotification",
+ "summary": "Send\u0020a\u0020refund\u0020notification.",
+ "url": "classes/BitPaySDK-Client.html#method_sendRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelRefund\u0028\u0029",
+ "name": "cancelRefund",
+ "summary": "Cancel\u0020a\u0020previously\u0020submitted\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_cancelRefund"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelRefundByGuid\u0028\u0029",
+ "name": "cancelRefundByGuid",
+ "summary": "Cancel\u0020a\u0020previously\u0020submitted\u0020refund\u0020request\u0020on\u0020a\u0020BitPay\u0020invoice.",
+ "url": "classes/BitPaySDK-Client.html#method_cancelRefundByGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetSupportedWallets\u0028\u0029",
+ "name": "getSupportedWallets",
+ "summary": "Retrieve\u0020all\u0020supported\u0020wallets.",
+ "url": "classes/BitPaySDK-Client.html#method_getSupportedWallets"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreateBill\u0028\u0029",
+ "name": "createBill",
+ "summary": "Create\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client.html#method_createBill"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetBill\u0028\u0029",
+ "name": "getBill",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020bill\u0020by\u0020bill\u0020id\u0020using\u0020the\u0020specified\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getBill"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetBills\u0028\u0029",
+ "name": "getBills",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020bills.",
+ "url": "classes/BitPaySDK-Client.html#method_getBills"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AupdateBill\u0028\u0029",
+ "name": "updateBill",
+ "summary": "Update\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client.html#method_updateBill"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AdeliverBill\u0028\u0029",
+ "name": "deliverBill",
+ "summary": "Deliver\u0020a\u0020BitPay\u0020Bill.",
+ "url": "classes/BitPaySDK-Client.html#method_deliverBill"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRates\u0028\u0029",
+ "name": "getRates",
+ "summary": "Retrieve\u0020the\u0020exchange\u0020rate\u0020table\u0020maintained\u0020by\u0020BitPay.",
+ "url": "classes/BitPaySDK-Client.html#method_getRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetCurrencyRates\u0028\u0029",
+ "name": "getCurrencyRates",
+ "summary": "Retrieve\u0020all\u0020the\u0020rates\u0020for\u0020a\u0020given\u0020cryptocurrency",
+ "url": "classes/BitPaySDK-Client.html#method_getCurrencyRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetCurrencyPairRate\u0028\u0029",
+ "name": "getCurrencyPairRate",
+ "summary": "Retrieve\u0020the\u0020rate\u0020for\u0020a\u0020cryptocurrency\u0020\/\u0020fiat\u0020pair",
+ "url": "classes/BitPaySDK-Client.html#method_getCurrencyPairRate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetLedgerEntries\u0028\u0029",
+ "name": "getLedgerEntries",
+ "summary": "Retrieve\u0020a\u0020list\u0020of\u0020ledgers\u0020by\u0020date\u0020range\u0020using\u0020the\u0020merchant\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getLedgerEntries"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetLedgers\u0028\u0029",
+ "name": "getLedgers",
+ "summary": "Retrieve\u0020a\u0020list\u0020of\u0020ledgers\u0020using\u0020the\u0020merchant\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getLedgers"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AsubmitPayoutRecipients\u0028\u0029",
+ "name": "submitPayoutRecipients",
+ "summary": "Submit\u0020BitPay\u0020Payout\u0020Recipients.",
+ "url": "classes/BitPaySDK-Client.html#method_submitPayoutRecipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayoutRecipient\u0028\u0029",
+ "name": "getPayoutRecipient",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020payout\u0020recipient\u0020by\u0020batch\u0020id\u0020using.\u0020\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\u0020authorized\u0020for\u0020the\npayout\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getPayoutRecipient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayoutRecipients\u0028\u0029",
+ "name": "getPayoutRecipients",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020Payout\u0020Recipients.",
+ "url": "classes/BitPaySDK-Client.html#method_getPayoutRecipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AupdatePayoutRecipient\u0028\u0029",
+ "name": "updatePayoutRecipient",
+ "summary": "Update\u0020a\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client.html#method_updatePayoutRecipient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AdeletePayoutRecipient\u0028\u0029",
+ "name": "deletePayoutRecipient",
+ "summary": "Delete\u0020a\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client.html#method_deletePayoutRecipient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003ArequestPayoutRecipientNotification\u0028\u0029",
+ "name": "requestPayoutRecipientNotification",
+ "summary": "Notify\u0020BitPay\u0020Payout\u0020Recipient.",
+ "url": "classes/BitPaySDK-Client.html#method_requestPayoutRecipientNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AsubmitPayout\u0028\u0029",
+ "name": "submitPayout",
+ "summary": "Submit\u0020a\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client.html#method_submitPayout"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayout\u0028\u0029",
+ "name": "getPayout",
+ "summary": "Retrieve\u0020a\u0020BitPay\u0020payout\u0020by\u0020payout\u0020id\u0020using.\u0020The\u0020client\u0020must\u0020have\u0020been\u0020previously\u0020authorized\nfor\u0020the\u0020payout\u0020facade.",
+ "url": "classes/BitPaySDK-Client.html#method_getPayout"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayouts\u0028\u0029",
+ "name": "getPayouts",
+ "summary": "Retrieve\u0020a\u0020collection\u0020of\u0020BitPay\u0020payouts.",
+ "url": "classes/BitPaySDK-Client.html#method_getPayouts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelPayout\u0028\u0029",
+ "name": "cancelPayout",
+ "summary": "Cancel\u0020a\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client.html#method_cancelPayout"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003ArequestPayoutNotification\u0028\u0029",
+ "name": "requestPayoutNotification",
+ "summary": "Notify\u0020BitPay\u0020Payout.",
+ "url": "classes/BitPaySDK-Client.html#method_requestPayoutNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcreatePayoutGroup\u0028\u0029",
+ "name": "createPayoutGroup",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#method_createPayoutGroup"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AcancelPayoutGroup\u0028\u0029",
+ "name": "cancelPayoutGroup",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#method_cancelPayoutGroup"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetSettlements\u0028\u0029",
+ "name": "getSettlements",
+ "summary": "Retrieves\u0020settlement\u0020reports\u0020for\u0020the\u0020calling\u0020merchant\u0020filtered\u0020by\u0020query.",
+ "url": "classes/BitPaySDK-Client.html#method_getSettlements"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetSettlement\u0028\u0029",
+ "name": "getSettlement",
+ "summary": "Retrieves\u0020a\u0020summary\u0020of\u0020the\u0020specified\u0020settlement.",
+ "url": "classes/BitPaySDK-Client.html#method_getSettlement"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetSettlementReconciliationReport\u0028\u0029",
+ "name": "getSettlementReconciliationReport",
+ "summary": "Gets\u0020a\u0020detailed\u0020reconciliation\u0020report\u0020of\u0020the\u0020activity\u0020within\u0020the\u0020settlement\u0020period.",
+ "url": "classes/BitPaySDK-Client.html#method_getSettlementReconciliationReport"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AinitKeys\u0028\u0029",
+ "name": "initKeys",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#method_initKeys"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetConfigData\u0028\u0029",
+ "name": "getConfigData",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#method_getConfigData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetTokenClient\u0028\u0029",
+ "name": "getTokenClient",
+ "summary": "Gets\u0020token\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getTokenClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetInvoiceClient\u0028\u0029",
+ "name": "getInvoiceClient",
+ "summary": "Gets\u0020invoice\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getInvoiceClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRefundClient\u0028\u0029",
+ "name": "getRefundClient",
+ "summary": "Gets\u0020refund\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getRefundClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetWalletClient\u0028\u0029",
+ "name": "getWalletClient",
+ "summary": "Gets\u0020wallet\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getWalletClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetBillClient\u0028\u0029",
+ "name": "getBillClient",
+ "summary": "Gets\u0020bill\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getBillClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetRateClient\u0028\u0029",
+ "name": "getRateClient",
+ "summary": "Gets\u0020rate\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getRateClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetLedgerClient\u0028\u0029",
+ "name": "getLedgerClient",
+ "summary": "Gets\u0020ledger\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getLedgerClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayoutRecipientsClient\u0028\u0029",
+ "name": "getPayoutRecipientsClient",
+ "summary": "Gets\u0020payout\u0020recipients\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getPayoutRecipientsClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetPayoutClient\u0028\u0029",
+ "name": "getPayoutClient",
+ "summary": "Gets\u0020payout\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getPayoutClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003AgetSettlementClient\u0028\u0029",
+ "name": "getSettlementClient",
+ "summary": "Gets\u0020settlement\u0020client",
+ "url": "classes/BitPaySDK-Client.html#method_getSettlementClient"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003A\u0024tokenCache",
+ "name": "tokenCache",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#property_tokenCache"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client\u003A\u003A\u0024restCli",
+ "name": "restCli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Client.html#property_restCli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env",
+ "name": "Env",
+ "summary": "Constants\u0020used\u0020throughout\u0020the\u0020SDK.",
+ "url": "classes/BitPaySDK-Env.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ATEST",
+ "name": "TEST",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_TEST"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003APROD",
+ "name": "PROD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_PROD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ATEST_URL",
+ "name": "TEST_URL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_TEST_URL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003APROD_URL",
+ "name": "PROD_URL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_PROD_URL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ABITPAY_API_VERSION",
+ "name": "BITPAY_API_VERSION",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_BITPAY_API_VERSION"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ABITPAY_PLUGIN_INFO",
+ "name": "BITPAY_PLUGIN_INFO",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_BITPAY_PLUGIN_INFO"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ABITPAY_API_FRAME",
+ "name": "BITPAY_API_FRAME",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_BITPAY_API_FRAME"
+ }, {
+ "fqsen": "\\BitPaySDK\\Env\u003A\u003ABITPAY_API_FRAME_VERSION",
+ "name": "BITPAY_API_FRAME_VERSION",
+ "summary": "",
+ "url": "classes/BitPaySDK-Env.html#constant_BITPAY_API_FRAME_VERSION"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillCreationException",
+ "name": "BillCreationException",
+ "summary": "Bill\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BillCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BillCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-BillCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillDeliveryException",
+ "name": "BillDeliveryException",
+ "summary": "Bill\u0020delivery\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BillDeliveryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillDeliveryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BillDeliveryException.",
+ "url": "classes/BitPaySDK-Exceptions-BillDeliveryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillDeliveryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillDeliveryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillDeliveryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillDeliveryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillException",
+ "name": "BillException",
+ "summary": "Bill\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BillException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BillException.",
+ "url": "classes/BitPaySDK-Exceptions-BillException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillQueryException",
+ "name": "BillQueryException",
+ "summary": "Bill\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BillQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BillQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-BillQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillUpdateException",
+ "name": "BillUpdateException",
+ "summary": "Bill\u0020update\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BillUpdateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillUpdateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BillUpdateException.",
+ "url": "classes/BitPaySDK-Exceptions-BillUpdateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillUpdateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillUpdateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BillUpdateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BillUpdateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException",
+ "name": "BitPayException",
+ "summary": "Generic\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020BitPayException.",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException\u003A\u003AgetApiCode\u0028\u0029",
+ "name": "getApiCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html#method_getApiCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\BitPayException\u003A\u003A\u0024apiCode",
+ "name": "apiCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-BitPayException.html#property_apiCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyException",
+ "name": "CurrencyException",
+ "summary": "Generic\u0020currency\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020CurrencyException.",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyQueryException",
+ "name": "CurrencyQueryException",
+ "summary": "Currency\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020CurrencyQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\CurrencyQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-CurrencyQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCancellationException",
+ "name": "InvoiceCancellationException",
+ "summary": "Invoice\u0020cancellation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCancellationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCancellationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoiceCancellationException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCancellationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCancellationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCancellationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCancellationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCancellationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCreationException",
+ "name": "InvoiceCreationException",
+ "summary": "Invoice\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoiceCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceException",
+ "name": "InvoiceException",
+ "summary": "Generic\u0020invoice\u0020\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoiceException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoicePaymentException",
+ "name": "InvoicePaymentException",
+ "summary": "Invoice\u0020payment\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoicePaymentException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoicePaymentException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoicePaymentException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoicePaymentException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoicePaymentException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoicePaymentException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoicePaymentException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoicePaymentException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceQueryException",
+ "name": "InvoiceQueryException",
+ "summary": "Invoice\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoiceQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceQueryException\u003A\u003A\u0024apiCode",
+ "name": "apiCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceQueryException.html#property_apiCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceUpdateException",
+ "name": "InvoiceUpdateException",
+ "summary": "Invoice\u0020update\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceUpdateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceUpdateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020InvoiceUpdateException.",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceUpdateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceUpdateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceUpdateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\InvoiceUpdateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-InvoiceUpdateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerException",
+ "name": "LedgerException",
+ "summary": "Generic\u0020ledger\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-LedgerException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020LedgerException.",
+ "url": "classes/BitPaySDK-Exceptions-LedgerException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-LedgerException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-LedgerException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerQueryException",
+ "name": "LedgerQueryException",
+ "summary": "Ledger\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-LedgerQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020LedgerQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-LedgerQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-LedgerQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\LedgerQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-LedgerQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCancellationException",
+ "name": "PayoutBatchCancellationException",
+ "summary": "Payout\u0020batch\u0020cancellation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCancellationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutBatchCancellationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCancellationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCancellationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCancellationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCreationException",
+ "name": "PayoutBatchCreationException",
+ "summary": "Payout\u0020batch\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutBatchCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchException",
+ "name": "PayoutBatchException",
+ "summary": "Generic\u0020payout\u0020batch\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutBatchException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchNotificationException",
+ "name": "PayoutBatchNotificationException",
+ "summary": "Payout\u0020batch\u0020notification\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchNotificationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutBatchNotificationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchNotificationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchNotificationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchNotificationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchQueryException",
+ "name": "PayoutBatchQueryException",
+ "summary": "Payout\u0020batch\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutBatchQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutBatchQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutBatchQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCancellationException",
+ "name": "PayoutCancellationException",
+ "summary": "Payout\u0020cancellation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCancellationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCancellationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutCancellationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCancellationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCancellationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCancellationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCancellationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCancellationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCreationException",
+ "name": "PayoutCreationException",
+ "summary": "Generic\u0020payout\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutException",
+ "name": "PayoutException",
+ "summary": "Generic\u0020payout\u0020batch\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutNotificationException",
+ "name": "PayoutNotificationException",
+ "summary": "Payout\u0020notification\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutNotificationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutNotificationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutNotificationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutNotificationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutNotificationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutNotificationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutNotificationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutNotificationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutQueryException",
+ "name": "PayoutQueryException",
+ "summary": "Payout\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCancellationException",
+ "name": "PayoutRecipientCancellationException",
+ "summary": "Payout\u0020recipient\u0020cancellation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCancellationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientCancellationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCancellationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCancellationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCancellationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCreationException",
+ "name": "PayoutRecipientCreationException",
+ "summary": "Payout\u0020recipient\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientException",
+ "name": "PayoutRecipientException",
+ "summary": "Generic\u0020recipient\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientNotificationException",
+ "name": "PayoutRecipientNotificationException",
+ "summary": "Payout\u0020recipient\u0020notification\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientNotificationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientNotificationException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientNotificationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientNotificationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientNotificationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientQueryException",
+ "name": "PayoutRecipientQueryException",
+ "summary": "Payout\u0020recipient\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientUpdateException",
+ "name": "PayoutRecipientUpdateException",
+ "summary": "Payout\u0020recipient\u0020update\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientUpdateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutRecipientUpdateException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientUpdateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutRecipientUpdateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutRecipientUpdateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutUpdateException",
+ "name": "PayoutUpdateException",
+ "summary": "Payout\u0020update\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutUpdateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutUpdateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020PayoutUpdateException.",
+ "url": "classes/BitPaySDK-Exceptions-PayoutUpdateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutUpdateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutUpdateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\PayoutUpdateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-PayoutUpdateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateException",
+ "name": "RateException",
+ "summary": "Generic\u0020rate\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RateException.",
+ "url": "classes/BitPaySDK-Exceptions-RateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateQueryException",
+ "name": "RateQueryException",
+ "summary": "Rate\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RateQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RateQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-RateQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RateQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RateQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RateQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCancellationException",
+ "name": "RefundCancellationException",
+ "summary": "Refund\u0020cancellation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundCancellationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCancellationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundCancellationException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundCancellationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCancellationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundCancellationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCancellationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundCancellationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCreationException",
+ "name": "RefundCreationException",
+ "summary": "Refund\u0020creation\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundCreationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCreationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundCreationException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundCreationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCreationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundCreationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundCreationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundCreationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundException",
+ "name": "RefundException",
+ "summary": "Generic\u0020refund\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundNotificationException",
+ "name": "RefundNotificationException",
+ "summary": "Refund\u0020notification\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundNotificationException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundNotificationException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundNotificationException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundNotificationException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundNotificationException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundNotificationException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundNotificationException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundNotificationException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundQueryException",
+ "name": "RefundQueryException",
+ "summary": "Refund\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundUpdateException",
+ "name": "RefundUpdateException",
+ "summary": "Refund\u0020update\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-RefundUpdateException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundUpdateException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020RefundUpdateException.",
+ "url": "classes/BitPaySDK-Exceptions-RefundUpdateException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundUpdateException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundUpdateException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\RefundUpdateException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-RefundUpdateException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementException",
+ "name": "SettlementException",
+ "summary": "Generic\u0020settlement\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-SettlementException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020SettlementException.",
+ "url": "classes/BitPaySDK-Exceptions-SettlementException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-SettlementException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-SettlementException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementQueryException",
+ "name": "SettlementQueryException",
+ "summary": "Settlement\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-SettlementQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020SettlementQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-SettlementQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-SettlementQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\SettlementQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-SettlementQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletException",
+ "name": "WalletException",
+ "summary": "Generic\u0020wallet\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-WalletException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020WalletException.",
+ "url": "classes/BitPaySDK-Exceptions-WalletException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-WalletException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-WalletException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletQueryException",
+ "name": "WalletQueryException",
+ "summary": "Wallet\u0020query\u0020exception.",
+ "url": "classes/BitPaySDK-Exceptions-WalletQueryException.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletQueryException\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Construct\u0020the\u0020WalletQueryException.",
+ "url": "classes/BitPaySDK-Exceptions-WalletQueryException.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletQueryException\u003A\u003A\u0024bitPayMessage",
+ "name": "bitPayMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-WalletQueryException.html#property_bitPayMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions\\WalletQueryException\u003A\u003A\u0024bitPayCode",
+ "name": "bitPayCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Exceptions-WalletQueryException.html#property_bitPayCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill",
+ "name": "Bill",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020a\u0020minimal\u0020request\u0020Bill\u0020object.",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020token",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020Bill\u0027s\u0020token",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020bill\u0020currency",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020Bill\u0027s\u0020currency",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetEmail\u0028\u0029",
+ "name": "getEmail",
+ "summary": "Gets\u0020bill\u0020email",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetEmail\u0028\u0029",
+ "name": "setEmail",
+ "summary": "Sets\u0020Bill\u0027s\u0020email",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetItems\u0028\u0029",
+ "name": "getItems",
+ "summary": "Gets\u0020items\u0020from\u0020bill",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getItems"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetItemsAsArray\u0028\u0029",
+ "name": "getItemsAsArray",
+ "summary": "Gets\u0020items\u0020as\u0020array\u0020from\u0020bill",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getItemsAsArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetItems\u0028\u0029",
+ "name": "setItems",
+ "summary": "Sets\u0020Bill\u0027s\u0020items",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setItems"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetNumber\u0028\u0029",
+ "name": "getNumber",
+ "summary": "Gets\u0020bill\u0020number",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getNumber"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetNumber\u0028\u0029",
+ "name": "setNumber",
+ "summary": "Sets\u0020Bill\u0027s\u0020number",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setNumber"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020name",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020name",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetAddress1\u0028\u0029",
+ "name": "getAddress1",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetAddress1\u0028\u0029",
+ "name": "setAddress1",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetAddress2\u0028\u0029",
+ "name": "getAddress2",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetAddress2\u0028\u0029",
+ "name": "setAddress2",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetCity\u0028\u0029",
+ "name": "getCity",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020city",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetCity\u0028\u0029",
+ "name": "setCity",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020city",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetState\u0028\u0029",
+ "name": "getState",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020state\u0020or\u0020province",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getState"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetState\u0028\u0029",
+ "name": "setState",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020state\u0020or\u0020province",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setState"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetZip\u0028\u0029",
+ "name": "getZip",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020ZIP\u0020code",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getZip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetZip\u0028\u0029",
+ "name": "setZip",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020ZIP\u0020code",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setZip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetCountry\u0028\u0029",
+ "name": "getCountry",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020country",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetCountry\u0028\u0029",
+ "name": "setCountry",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020country",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetCc\u0028\u0029",
+ "name": "getCc",
+ "summary": "Gets\u0020Bill\u0020cc",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getCc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetCc\u0028\u0029",
+ "name": "setCc",
+ "summary": "Sets\u0020Bill\u0027s\u0020cc",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setCc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetPhone\u0028\u0029",
+ "name": "getPhone",
+ "summary": "Gets\u0020Bill\u0020recipient\u0027s\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetPhone\u0028\u0029",
+ "name": "setPhone",
+ "summary": "Sets\u0020Bill\u0020recipient\u0027s\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetDueDate\u0028\u0029",
+ "name": "getDueDate",
+ "summary": "Gets\u0020Bill\u0020due\u0020date",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getDueDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetDueDate\u0028\u0029",
+ "name": "setDueDate",
+ "summary": "Sets\u0020Bill\u0027s\u0020due\u0020date",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setDueDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetPassProcessingFee\u0028\u0029",
+ "name": "getPassProcessingFee",
+ "summary": "Gets\u0020bill\u0020pass\u0020processing\u0020fee",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getPassProcessingFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetPassProcessingFee\u0028\u0029",
+ "name": "setPassProcessingFee",
+ "summary": "Sets\u0020Bill\u0027s\u0020pass\u0020processing\u0020fee",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setPassProcessingFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020bill\u0020status",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020Bill\u0027s\u0020status",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetUrl\u0028\u0029",
+ "name": "getUrl",
+ "summary": "Gets\u0020bill\u0020url",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getUrl"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetUrl\u0028\u0029",
+ "name": "setUrl",
+ "summary": "Sets\u0020Bill\u0027s\u0020url",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setUrl"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetCreateDate\u0028\u0029",
+ "name": "getCreateDate",
+ "summary": "Gets\u0020bill\u0020create\u0020date",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getCreateDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetCreateDate\u0028\u0029",
+ "name": "setCreateDate",
+ "summary": "Sets\u0020Bill\u0027s\u0020create\u0020date",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setCreateDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020bill\u0020id",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020Bill\u0027s\u0020id",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AgetMerchant\u0028\u0029",
+ "name": "getMerchant",
+ "summary": "Gets\u0020bill\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_getMerchant"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AsetMerchant\u0028\u0029",
+ "name": "setMerchant",
+ "summary": "Sets\u0020Bill\u0027s\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_setMerchant"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Get\u0020bill\u0020data\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024email",
+ "name": "email",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_email"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024items",
+ "name": "items",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_items"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024number",
+ "name": "number",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_number"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024address1",
+ "name": "address1",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_address1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024address2",
+ "name": "address2",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_address2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024city",
+ "name": "city",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_city"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024state",
+ "name": "state",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_state"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024zip",
+ "name": "zip",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_zip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024country",
+ "name": "country",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_country"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024cc",
+ "name": "cc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_cc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024phone",
+ "name": "phone",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_phone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024dueDate",
+ "name": "dueDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_dueDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024passProcessingFee",
+ "name": "passProcessingFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_passProcessingFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024url",
+ "name": "url",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_url"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024createDate",
+ "name": "createDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_createDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Bill\u003A\u003A\u0024merchant",
+ "name": "merchant",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Bill.html#property_merchant"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus",
+ "name": "BillStatus",
+ "summary": "Contains\u0020bill\u0020statuses\u003A\u0020Can\u0020be\u0020\u0022draft\u0022,\u0020\u0022sent\u0022,\u0020\u0022new\u0022,\u0020\u0022paid\u0022,\u0020or\u0020\u0022complete\u0022",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus\u003A\u003ADRAFT",
+ "name": "DRAFT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html#constant_DRAFT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus\u003A\u003ASENT",
+ "name": "SENT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html#constant_SENT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus\u003A\u003ANEW",
+ "name": "NEW",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html#constant_NEW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus\u003A\u003APAID",
+ "name": "PAID",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html#constant_PAID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\BillStatus\u003A\u003ACOMPLETE",
+ "name": "COMPLETE",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-BillStatus.html#constant_COMPLETE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item",
+ "name": "Item",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020id.",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020id.",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AgetDescription\u0028\u0029",
+ "name": "getDescription",
+ "summary": "Gets\u0020Line\u0020item\u0020description",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_getDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AsetDescription\u0028\u0029",
+ "name": "setDescription",
+ "summary": "Sets\u0020Line\u0020item\u0020description",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_setDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AgetPrice\u0028\u0029",
+ "name": "getPrice",
+ "summary": "Gets\u0020Line\u0020item\u0020unit\u0020price\u0020for\u0020the\u0020corresponding\u0020currency",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_getPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AsetPrice\u0028\u0029",
+ "name": "setPrice",
+ "summary": "Sets\u0020Line\u0020item\u0020unit\u0020price\u0020for\u0020the\u0020corresponding\u0020currency",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_setPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AgetQuantity\u0028\u0029",
+ "name": "getQuantity",
+ "summary": "Gets\u0020Line\u0020item\u0020number\u0020of\u0020units",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_getQuantity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AsetQuantity\u0028\u0029",
+ "name": "setQuantity",
+ "summary": "Sets\u0020Line\u0020item\u0020number\u0020of\u0020units",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_setQuantity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AcreateFromArray\u0028\u0029",
+ "name": "createFromArray",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_createFromArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Item\u0020data\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003A\u0024description",
+ "name": "description",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#property_description"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003A\u0024price",
+ "name": "price",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#property_price"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill\\Item\u003A\u003A\u0024quantity",
+ "name": "quantity",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Bill-Item.html#property_quantity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency",
+ "name": "Currency",
+ "summary": "Object\u0020containing\u0020currency\u0020information.",
+ "url": "classes/BitPaySDK-Model-Currency.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AisValid\u0028\u0029",
+ "name": "isValid",
+ "summary": "Currency\u0020validation",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_isValid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Get\u0020ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetSymbol\u0028\u0029",
+ "name": "getSymbol",
+ "summary": "Display\u0020symbol",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getSymbol"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetSymbol\u0028\u0029",
+ "name": "setSymbol",
+ "summary": "Sets\u0020symbol",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setSymbol"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetPrecision\u0028\u0029",
+ "name": "getPrecision",
+ "summary": "Number\u0020of\u0020decimal\u0020places",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getPrecision"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetPrecision\u0028\u0029",
+ "name": "setPrecision",
+ "summary": "Sets\u0020number\u0020of\u0020decimal\u0020places",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setPrecision"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetCurrentlySettled\u0028\u0029",
+ "name": "getCurrentlySettled",
+ "summary": "Gets\u0020currently\u0020settled\u0020value",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getCurrentlySettled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetCurrentlySettled\u0028\u0029",
+ "name": "setCurrentlySettled",
+ "summary": "Sets\u0020currently\u0020settled\u0020value",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setCurrentlySettled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020currency\u0020name",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020currency\u0020name",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetPlural\u0028\u0029",
+ "name": "getPlural",
+ "summary": "Gets\u0020English\u0020plural\u0020form",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getPlural"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetPlural\u0028\u0029",
+ "name": "setPlural",
+ "summary": "Sets\u0020English\u0020plural\u0020form",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setPlural"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetAlts\u0028\u0029",
+ "name": "getAlts",
+ "summary": "Gets\u0020alternative\u0020currency\u0020name\u0028s\u0029",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getAlts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetAlts\u0028\u0029",
+ "name": "setAlts",
+ "summary": "Sets\u0020alternative\u0020currency\u0020name\u0028s\u0029",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setAlts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetMinimum\u0028\u0029",
+ "name": "getMinimum",
+ "summary": "Gets\u0020minimum\u0020supported\u0020value\u0020when\u0020creating\u0020an\u0020invoice,\u0020bill\u0020or\u0020payout\u0020for\u0020instance",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getMinimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetMinimum\u0028\u0029",
+ "name": "setMinimum",
+ "summary": "Sets\u0020minimum\u0020supported\u0020value\u0020when\u0020creating\u0020an\u0020invoice,\u0020bill\u0020or\u0020payout\u0020for\u0020instance",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setMinimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetSanctioned\u0028\u0029",
+ "name": "getSanctioned",
+ "summary": "Gets\u0020if\u0020the\u0020currency\u0020is\u0020linked\u0020to\u0020a\u0020sanctionned\u0020country",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getSanctioned"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetSanctioned\u0028\u0029",
+ "name": "setSanctioned",
+ "summary": "Sets\u0020if\u0020the\u0020currency\u0020is\u0020linked\u0020to\u0020a\u0020sanctionned\u0020country",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setSanctioned"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetDecimals\u0028\u0029",
+ "name": "getDecimals",
+ "summary": "Gets\u0020decimal\u0020precision",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getDecimals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetDecimals\u0028\u0029",
+ "name": "setDecimals",
+ "summary": "Sets\u0020decimal\u0020precision",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setDecimals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetPayoutFields\u0028\u0029",
+ "name": "getPayoutFields",
+ "summary": "Gets\u0020payout\u0020fields",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getPayoutFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetPayoutFields\u0028\u0029",
+ "name": "setPayoutFields",
+ "summary": "Sets\u0020payout\u0020fields",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setPayoutFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AgetSettlementMinimum\u0028\u0029",
+ "name": "getSettlementMinimum",
+ "summary": "Gets\u0020settlement\u0020minimum",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_getSettlementMinimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AsetSettlementMinimum\u0028\u0029",
+ "name": "setSettlementMinimum",
+ "summary": "Sets\u0020settlement\u0020minimum",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_setSettlementMinimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020currency\u0020data\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Currency.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABCH",
+ "name": "BCH",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BCH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABTC",
+ "name": "BTC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AETH",
+ "name": "ETH",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ETH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUSDC",
+ "name": "USDC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_USDC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGUSD",
+ "name": "GUSD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APAX",
+ "name": "PAX",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PAX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXRP",
+ "name": "XRP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XRP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABUSD",
+ "name": "BUSD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ADOGE",
+ "name": "DOGE",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_DOGE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALTC",
+ "name": "LTC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASHIB",
+ "name": "SHIB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SHIB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAED",
+ "name": "AED",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAFN",
+ "name": "AFN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AFN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AALL",
+ "name": "ALL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ALL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAMD",
+ "name": "AMD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AMD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AANG",
+ "name": "ANG",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ANG"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAOA",
+ "name": "AOA",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AOA"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AARS",
+ "name": "ARS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ARS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAUD",
+ "name": "AUD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AUD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAWG",
+ "name": "AWG",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AWG"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AAZN",
+ "name": "AZN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_AZN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABAM",
+ "name": "BAM",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BAM"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABBD",
+ "name": "BBD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BBD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABDT",
+ "name": "BDT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BDT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABGN",
+ "name": "BGN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BGN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABHD",
+ "name": "BHD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BHD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABIF",
+ "name": "BIF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BIF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABMD",
+ "name": "BMD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BMD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABND",
+ "name": "BND",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BND"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABOB",
+ "name": "BOB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BOB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABOV",
+ "name": "BOV",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BOV"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABRL",
+ "name": "BRL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BRL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABSD",
+ "name": "BSD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABTN",
+ "name": "BTN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BTN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABWP",
+ "name": "BWP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BWP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABYR",
+ "name": "BYR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BYR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ABZD",
+ "name": "BZD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_BZD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACAD",
+ "name": "CAD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CAD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACDF",
+ "name": "CDF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CDF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACHE",
+ "name": "CHE",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CHE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACHF",
+ "name": "CHF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CHF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACHW",
+ "name": "CHW",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CHW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACLF",
+ "name": "CLF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CLF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACLP",
+ "name": "CLP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CLP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACNY",
+ "name": "CNY",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CNY"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACOP",
+ "name": "COP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_COP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACOU",
+ "name": "COU",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_COU"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACRC",
+ "name": "CRC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CRC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACUC",
+ "name": "CUC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CUC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACUP",
+ "name": "CUP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CUP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACVE",
+ "name": "CVE",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CVE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ACZK",
+ "name": "CZK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_CZK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ADJF",
+ "name": "DJF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_DJF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ADKK",
+ "name": "DKK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_DKK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ADOP",
+ "name": "DOP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_DOP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ADZD",
+ "name": "DZD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_DZD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AEGP",
+ "name": "EGP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_EGP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AERN",
+ "name": "ERN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ERN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AETB",
+ "name": "ETB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ETB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AEUR",
+ "name": "EUR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_EUR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AFJD",
+ "name": "FJD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_FJD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AFKP",
+ "name": "FKP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_FKP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGBP",
+ "name": "GBP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GBP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGEL",
+ "name": "GEL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GEL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGHS",
+ "name": "GHS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GHS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGIP",
+ "name": "GIP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GIP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGMD",
+ "name": "GMD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GMD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGNF",
+ "name": "GNF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GNF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGTQ",
+ "name": "GTQ",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GTQ"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AGYD",
+ "name": "GYD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_GYD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AHKD",
+ "name": "HKD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_HKD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AHNL",
+ "name": "HNL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_HNL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AHRK",
+ "name": "HRK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_HRK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AHTG",
+ "name": "HTG",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_HTG"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AHUF",
+ "name": "HUF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_HUF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AIDR",
+ "name": "IDR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_IDR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AILS",
+ "name": "ILS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ILS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AINR",
+ "name": "INR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_INR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AIQD",
+ "name": "IQD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_IQD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AIRR",
+ "name": "IRR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_IRR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AISK",
+ "name": "ISK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ISK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AJMD",
+ "name": "JMD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_JMD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AJOD",
+ "name": "JOD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_JOD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AJPY",
+ "name": "JPY",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_JPY"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKES",
+ "name": "KES",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KES"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKGS",
+ "name": "KGS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KGS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKHR",
+ "name": "KHR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KHR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKMF",
+ "name": "KMF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KMF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKPW",
+ "name": "KPW",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KPW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKRW",
+ "name": "KRW",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KRW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKWD",
+ "name": "KWD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KWD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKYD",
+ "name": "KYD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KYD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AKZT",
+ "name": "KZT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_KZT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALAK",
+ "name": "LAK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LAK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALBP",
+ "name": "LBP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LBP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALKR",
+ "name": "LKR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LKR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALRD",
+ "name": "LRD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LRD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALSL",
+ "name": "LSL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LSL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ALYD",
+ "name": "LYD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_LYD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMAD",
+ "name": "MAD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MAD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMDL",
+ "name": "MDL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MDL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMGA",
+ "name": "MGA",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MGA"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMKD",
+ "name": "MKD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MKD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMMK",
+ "name": "MMK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MMK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMNT",
+ "name": "MNT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MNT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMOP",
+ "name": "MOP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MOP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMRU",
+ "name": "MRU",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MRU"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMUR",
+ "name": "MUR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MUR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMVR",
+ "name": "MVR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MVR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMWK",
+ "name": "MWK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MWK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMXN",
+ "name": "MXN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MXN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMXV",
+ "name": "MXV",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MXV"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMYR",
+ "name": "MYR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MYR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AMZN",
+ "name": "MZN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_MZN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANAD",
+ "name": "NAD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NAD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANGN",
+ "name": "NGN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NGN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANIO",
+ "name": "NIO",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NIO"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANOK",
+ "name": "NOK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NOK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANPR",
+ "name": "NPR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NPR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ANZD",
+ "name": "NZD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_NZD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AOMR",
+ "name": "OMR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_OMR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APAB",
+ "name": "PAB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PAB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APEN",
+ "name": "PEN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PEN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APGK",
+ "name": "PGK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PGK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APHP",
+ "name": "PHP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PHP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APKR",
+ "name": "PKR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PKR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APLN",
+ "name": "PLN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PLN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003APYG",
+ "name": "PYG",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_PYG"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AQAR",
+ "name": "QAR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_QAR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ARON",
+ "name": "RON",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_RON"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ARSD",
+ "name": "RSD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_RSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ARUB",
+ "name": "RUB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_RUB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ARWF",
+ "name": "RWF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_RWF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASAR",
+ "name": "SAR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SAR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASBD",
+ "name": "SBD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SBD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASCR",
+ "name": "SCR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SCR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASDG",
+ "name": "SDG",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SDG"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASEK",
+ "name": "SEK",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SEK"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASGD",
+ "name": "SGD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SGD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASHP",
+ "name": "SHP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SHP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASLL",
+ "name": "SLL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SLL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASOS",
+ "name": "SOS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SOS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASRD",
+ "name": "SRD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SRD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASSP",
+ "name": "SSP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SSP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASTN",
+ "name": "STN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_STN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASVC",
+ "name": "SVC",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SVC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASYP",
+ "name": "SYP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SYP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ASZL",
+ "name": "SZL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_SZL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATHB",
+ "name": "THB",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_THB"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATJS",
+ "name": "TJS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TJS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATMT",
+ "name": "TMT",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TMT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATND",
+ "name": "TND",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TND"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATOP",
+ "name": "TOP",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TOP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATRY",
+ "name": "TRY",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TRY"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATTD",
+ "name": "TTD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TTD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATWD",
+ "name": "TWD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TWD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003ATZS",
+ "name": "TZS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_TZS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUAH",
+ "name": "UAH",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_UAH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUGX",
+ "name": "UGX",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_UGX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUSD",
+ "name": "USD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_USD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUSN",
+ "name": "USN",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_USN"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUYI",
+ "name": "UYI",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_UYI"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUYU",
+ "name": "UYU",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_UYU"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AUZS",
+ "name": "UZS",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_UZS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AVEF",
+ "name": "VEF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_VEF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AVND",
+ "name": "VND",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_VND"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AVUV",
+ "name": "VUV",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_VUV"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AWST",
+ "name": "WST",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_WST"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXAF",
+ "name": "XAF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XAF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXCD",
+ "name": "XCD",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XCD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXDR",
+ "name": "XDR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XDR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXOF",
+ "name": "XOF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XOF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXPF",
+ "name": "XPF",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XPF"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXSU",
+ "name": "XSU",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XSU"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AXUA",
+ "name": "XUA",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_XUA"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AYER",
+ "name": "YER",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_YER"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AZAR",
+ "name": "ZAR",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ZAR"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AZMW",
+ "name": "ZMW",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ZMW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003AZWL",
+ "name": "ZWL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#constant_ZWL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024symbol",
+ "name": "symbol",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_symbol"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024precision",
+ "name": "precision",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_precision"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024currentlySettled",
+ "name": "currentlySettled",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_currentlySettled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024plural",
+ "name": "plural",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_plural"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024alts",
+ "name": "alts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_alts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024minimum",
+ "name": "minimum",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_minimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024sanctioned",
+ "name": "sanctioned",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_sanctioned"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024decimals",
+ "name": "decimals",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_decimals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024payoutFields",
+ "name": "payoutFields",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_payoutFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Currency\u003A\u003A\u0024settlementMinimum",
+ "name": "settlementMinimum",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Currency.html#property_settlementMinimum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Facade",
+ "name": "Facade",
+ "summary": "Facades\u0020are\u0020named\u0020collections\u0020of\u0020capabilities\u0020that\u0020can\u0020be\u0020granted,\nsuch\u0020as\u0020the\u0020ability\u0020to\u0020create\u0020invoices\u0020or\u0020grant\u0020refunds.",
+ "url": "classes/BitPaySDK-Model-Facade.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Facade\u003A\u003AMERCHANT",
+ "name": "MERCHANT",
+ "summary": "The\u0020broadest\u0020set\u0020of\u0020capabilities\u0020against\u0020a\u0020merchant\u0020organization.\u0020Allows\u0020for\u0020create,\u0020search,\nand\u0020view\u0020actions\u0020for\u0020Invoices\u0020and\u0020Bills\u003B\u0020ledger\u0020download,\nas\u0020well\u0020as\u0020the\u0020creation\u0020of\u0020new\u0020merchant\u0020or\u0020pos\u0020tokens\u0020associated\u0020with\u0020the\u0020account.",
+ "url": "classes/BitPaySDK-Model-Facade.html#constant_MERCHANT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Facade\u003A\u003APAYOUT",
+ "name": "PAYOUT",
+ "summary": "This\u0020is\u0020the\u0020facade\u0020which\u0020allows\u0020merchant\u0020to\u0020access\u0020the\u0020Payouts\u0020related\u0020resources\u0020and\u0020corresponding\u0020endpoints.",
+ "url": "classes/BitPaySDK-Model-Facade.html#constant_PAYOUT"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Facade\u003A\u003APOS",
+ "name": "POS",
+ "summary": "Limited\u0020to\u0020creating\u0020new\u0020invoice\u0020or\u0020bills\u0020and\u0020search\u0020specific\u0020invoices\nor\u0020bills\u0020based\u0020on\u0020their\u0020id\u0020for\u0020the\u0020merchant\u0027s\u0020organization",
+ "url": "classes/BitPaySDK-Model-Facade.html#constant_POS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer",
+ "name": "Buyer",
+ "summary": "Allows\u0020merchant\u0020to\u0020pass\u0020buyer\u0020related\u0020information\u0020in\u0020the\u0020invoice\u0020object",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020Buyer\u0027s\u0020name",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020Buyer\u0027s\u0020name",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetAddress1\u0028\u0029",
+ "name": "getAddress1",
+ "summary": "Gets\u0020Buyer\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetAddress1\u0028\u0029",
+ "name": "setAddress1",
+ "summary": "Sets\u0020Buyer\u0027s\u0020address",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetAddress2\u0028\u0029",
+ "name": "getAddress2",
+ "summary": "Gets\u0020Buyer\u0027s\u0020appartment\u0020or\u0020suite\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetAddress2\u0028\u0029",
+ "name": "setAddress2",
+ "summary": "Sets\u0020Buyer\u0027s\u0020appartment\u0020or\u0020suite\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetLocality\u0028\u0029",
+ "name": "getLocality",
+ "summary": "Gets\u0020Buyer\u0027s\u0020city\u0020or\u0020locality",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getLocality"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetLocality\u0028\u0029",
+ "name": "setLocality",
+ "summary": "Sets\u0020Buyer\u0027s\u0020city\u0020or\u0020locality",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setLocality"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetRegion\u0028\u0029",
+ "name": "getRegion",
+ "summary": "Buyer\u0027s\u0020state\u0020or\u0020province",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getRegion"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetRegion\u0028\u0029",
+ "name": "setRegion",
+ "summary": "Sets\u0020Buyer\u0027s\u0020state\u0020or\u0020province",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setRegion"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetPostalCode\u0028\u0029",
+ "name": "getPostalCode",
+ "summary": "Gets\u0020Buyer\u0027s\u0020Zip\u0020or\u0020Postal\u0020Code",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getPostalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetPostalCode\u0028\u0029",
+ "name": "setPostalCode",
+ "summary": "Sets\u0020Buyer\u0027s\u0020Zip\u0020or\u0020Postal\u0020Code",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setPostalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetCountry\u0028\u0029",
+ "name": "getCountry",
+ "summary": "Gets\u0020Buyer\u0027s\u0020Country\u0020code",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetCountry\u0028\u0029",
+ "name": "setCountry",
+ "summary": "Sets\u0020Buyer\u0027s\u0020Country\u0020code",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetEmail\u0028\u0029",
+ "name": "getEmail",
+ "summary": "Gets\u0020Buyer\u0027s\u0020email\u0020address.",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetEmail\u0028\u0029",
+ "name": "setEmail",
+ "summary": "Sets\u0020Buyer\u0027s\u0020email\u0020address",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetPhone\u0028\u0029",
+ "name": "getPhone",
+ "summary": "Gets\u0020Buyer\u0027s\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetPhone\u0028\u0029",
+ "name": "setPhone",
+ "summary": "Sets\u0020Buyer\u0027s\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AgetNotify\u0028\u0029",
+ "name": "getNotify",
+ "summary": "Gets\u0020Buyer\u0027s\u0020notify",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_getNotify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AsetNotify\u0028\u0029",
+ "name": "setNotify",
+ "summary": "Sets\u0020Buyer\u0027s\u0020notify",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_setNotify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Buyer\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024address1",
+ "name": "address1",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_address1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024address2",
+ "name": "address2",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_address2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024locality",
+ "name": "locality",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_locality"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024region",
+ "name": "region",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_region"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024postalCode",
+ "name": "postalCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_postalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024country",
+ "name": "country",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_country"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024email",
+ "name": "email",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_email"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024phone",
+ "name": "phone",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_phone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Buyer\u003A\u003A\u0024notify",
+ "name": "notify",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Buyer.html#property_notify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo",
+ "name": "BuyerProvidedInfo",
+ "summary": "Information\u0020collected\u0020from\u0020the\u0020buyer\u0020during\u0020the\u0020process\u0020of\u0020paying\u0020an\u0020invoice.\u0020Initially\u0020this\u0020object\u0020is\u0020empty.",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020name",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020name",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetPhoneNumber\u0028\u0029",
+ "name": "getPhoneNumber",
+ "summary": "Gets\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getPhoneNumber"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetPhoneNumber\u0028\u0029",
+ "name": "setPhoneNumber",
+ "summary": "Sets\u0020phone\u0020number",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setPhoneNumber"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetSelectedWallet\u0028\u0029",
+ "name": "getSelectedWallet",
+ "summary": "Gets\u0020selected\u0020wallet",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getSelectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetSelectedWallet\u0028\u0029",
+ "name": "setSelectedWallet",
+ "summary": "Sets\u0020selected\u0020wallet",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setSelectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetEmailAddress\u0028\u0029",
+ "name": "getEmailAddress",
+ "summary": "Gets\u0020email\u0020address",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getEmailAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetEmailAddress\u0028\u0029",
+ "name": "setEmailAddress",
+ "summary": "Sets\u0020email\u0020address",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setEmailAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetSelectedTransactionCurrency\u0028\u0029",
+ "name": "getSelectedTransactionCurrency",
+ "summary": "Gets\u0020selected\u0020transaction\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetSelectedTransactionCurrency\u0028\u0029",
+ "name": "setSelectedTransactionCurrency",
+ "summary": "Sets\u0020selected\u0020transaction\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetSms\u0028\u0029",
+ "name": "getSms",
+ "summary": "Gets\u0020sms",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetSms\u0028\u0029",
+ "name": "setSms",
+ "summary": "Sets\u0020sms",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AgetSmsVerified\u0028\u0029",
+ "name": "getSmsVerified",
+ "summary": "Gets\u0020verification\u0020status\u0020of\u0020SMS\u0020\u0028ie.\u0020have\u0020they\u0020passed\u0020the\u0020challenge\u0029.",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_getSmsVerified"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AsetSmsVerified\u0028\u0029",
+ "name": "setSmsVerified",
+ "summary": "Sets\u0020verification\u0020status\u0020of\u0020SMS\u0020\u0028ie.\u0020have\u0020they\u0020passed\u0020the\u0020challenge\u0029.",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_setSmsVerified"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020BuyerProvidedInfo\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024phoneNumber",
+ "name": "phoneNumber",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_phoneNumber"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024selectedWallet",
+ "name": "selectedWallet",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_selectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024emailAddress",
+ "name": "emailAddress",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_emailAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024selectedTransactionCurrency",
+ "name": "selectedTransactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_selectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024sms",
+ "name": "sms",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_sms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\BuyerProvidedInfo\u003A\u003A\u0024smsVerified",
+ "name": "smsVerified",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html#property_smsVerified"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice",
+ "name": "Invoice",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020a\u0020minimal\u0020request\u0020Invoice\u0020object.",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetGuid\u0028\u0029",
+ "name": "getGuid",
+ "summary": "Gets\u0020guid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetGuid\u0028\u0029",
+ "name": "setGuid",
+ "summary": "Sets\u0020guid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020token",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020token",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPrice\u0028\u0029",
+ "name": "getPrice",
+ "summary": "Gets\u0020price",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPrice\u0028\u0029",
+ "name": "setPrice",
+ "summary": "Sets\u0020price",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPosData\u0028\u0029",
+ "name": "getPosData",
+ "summary": "Gets\u0020posData",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPosData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPosData\u0028\u0029",
+ "name": "setPosData",
+ "summary": "Sets\u0020posData",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPosData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetNotificationURL\u0028\u0029",
+ "name": "getNotificationURL",
+ "summary": "Gets\u0020notificationURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetNotificationURL\u0028\u0029",
+ "name": "setNotificationURL",
+ "summary": "Sets\u0020notificationURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetTransactionSpeed\u0028\u0029",
+ "name": "getTransactionSpeed",
+ "summary": "Gets\u0020transactionSpeed.",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getTransactionSpeed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetTransactionSpeed\u0028\u0029",
+ "name": "setTransactionSpeed",
+ "summary": "Sets\u0020transactionSpeed.",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setTransactionSpeed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetFullNotifications\u0028\u0029",
+ "name": "getFullNotifications",
+ "summary": "Gets\u0020fullNotifications",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getFullNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetFullNotifications\u0028\u0029",
+ "name": "setFullNotifications",
+ "summary": "Sets\u0020fullNotifications",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setFullNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetNotificationEmail\u0028\u0029",
+ "name": "getNotificationEmail",
+ "summary": "Gets\u0020NotificationEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getNotificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetNotificationEmail\u0028\u0029",
+ "name": "setNotificationEmail",
+ "summary": "Sets\u0020NotificationEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setNotificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetRedirectURL\u0028\u0029",
+ "name": "getRedirectURL",
+ "summary": "Gets\u0020RedirectURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getRedirectURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetRedirectURL\u0028\u0029",
+ "name": "setRedirectURL",
+ "summary": "Sets\u0020RedirectURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setRedirectURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetOrderId\u0028\u0029",
+ "name": "getOrderId",
+ "summary": "Gets\u0020orderId",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getOrderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetOrderId\u0028\u0029",
+ "name": "setOrderId",
+ "summary": "Sets\u0020orderId",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setOrderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetItemDesc\u0028\u0029",
+ "name": "getItemDesc",
+ "summary": "Gets\u0020itemDesc",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getItemDesc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetItemDesc\u0028\u0029",
+ "name": "setItemDesc",
+ "summary": "Sets\u0020itemDesc",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setItemDesc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetItemCode\u0028\u0029",
+ "name": "getItemCode",
+ "summary": "Gets\u0020itemCode",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getItemCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetItemCode\u0028\u0029",
+ "name": "setItemCode",
+ "summary": "Sets\u0020itemCode",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setItemCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPhysical\u0028\u0029",
+ "name": "getPhysical",
+ "summary": "Gets\u0020physical.",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPhysical"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPhysical\u0028\u0029",
+ "name": "setPhysical",
+ "summary": "Sets\u0020physical.",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPhysical"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentCurrencies\u0028\u0029",
+ "name": "getPaymentCurrencies",
+ "summary": "Gets\u0020paymentCurrencies",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentCurrencies\u0028\u0029",
+ "name": "setPaymentCurrencies",
+ "summary": "Sets\u0020paymentCurrencies",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetCloseURL\u0028\u0029",
+ "name": "getCloseURL",
+ "summary": "Gets\u0020closeURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getCloseURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetCloseURL\u0028\u0029",
+ "name": "setCloseURL",
+ "summary": "Gets\u0020closeURL",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setCloseURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetAutoRedirect\u0028\u0029",
+ "name": "getAutoRedirect",
+ "summary": "Gets\u0020autoRedirect",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getAutoRedirect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetAutoRedirect\u0028\u0029",
+ "name": "setAutoRedirect",
+ "summary": "Sets\u0020autoRedirect",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setAutoRedirect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetJsonPayProRequired\u0028\u0029",
+ "name": "getJsonPayProRequired",
+ "summary": "Gets\u0020jsonPayProRequired",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getJsonPayProRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetJsonPayProRequired\u0028\u0029",
+ "name": "setJsonPayProRequired",
+ "summary": "Sets\u0020jsonPayProRequired",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setJsonPayProRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBitpayIdRequired\u0028\u0029",
+ "name": "getBitpayIdRequired",
+ "summary": "Gets\u0020bitpayIdRequired",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBitpayIdRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBitpayIdRequired\u0028\u0029",
+ "name": "setBitpayIdRequired",
+ "summary": "Sets\u0020bitpayIdRequired",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBitpayIdRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetMerchantName\u0028\u0029",
+ "name": "getMerchantName",
+ "summary": "Gets\u0020merchantName",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getMerchantName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetMerchantName\u0028\u0029",
+ "name": "setMerchantName",
+ "summary": "Sets\u0020merchantName",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setMerchantName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetSelectedTransactionCurrency\u0028\u0029",
+ "name": "getSelectedTransactionCurrency",
+ "summary": "Gets\u0020selectedTransactionCurrency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetSelectedTransactionCurrency\u0028\u0029",
+ "name": "setSelectedTransactionCurrency",
+ "summary": "Sets\u0020selectedTransactionCurrency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetForcedBuyerSelectedWallet\u0028\u0029",
+ "name": "getForcedBuyerSelectedWallet",
+ "summary": "Gets\u0020forcedBuyerSelectedWallet",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getForcedBuyerSelectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetForcedBuyerSelectedWallet\u0028\u0029",
+ "name": "setForcedBuyerSelectedWallet",
+ "summary": "Sets\u0020forcedBuyerSelectedWallet",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setForcedBuyerSelectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetForcedBuyerSelectedTransactionCurrency\u0028\u0029",
+ "name": "getForcedBuyerSelectedTransactionCurrency",
+ "summary": "Gets\u0020forcedBuyerSelectedWallet",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getForcedBuyerSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetForcedBuyerSelectedTransactionCurrency\u0028\u0029",
+ "name": "setForcedBuyerSelectedTransactionCurrency",
+ "summary": "Sets\u0020forcedBuyerSelectedWallet",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setForcedBuyerSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetItemizedDetails\u0028\u0029",
+ "name": "getItemizedDetails",
+ "summary": "Gets\u0020itemizedDetails",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getItemizedDetails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetItemizedDetails\u0028\u0029",
+ "name": "setItemizedDetails",
+ "summary": "Sets\u0020itemizedDetails",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setItemizedDetails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetAcceptanceWindow\u0028\u0029",
+ "name": "getAcceptanceWindow",
+ "summary": "Gets\u0020acceptanceWindow",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getAcceptanceWindow"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetAcceptanceWindow\u0028\u0029",
+ "name": "setAcceptanceWindow",
+ "summary": "Sets\u0020acceptanceWindow",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setAcceptanceWindow"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBuyer\u0028\u0029",
+ "name": "getBuyer",
+ "summary": "Gets\u0020buyer",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBuyer"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBuyer\u0028\u0029",
+ "name": "setBuyer",
+ "summary": "Sets\u0020buyer",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBuyer"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBuyerEmail\u0028\u0029",
+ "name": "getBuyerEmail",
+ "summary": "Gets\u0020buyerEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBuyerEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBuyerEmail\u0028\u0029",
+ "name": "setBuyerEmail",
+ "summary": "Sets\u0020buyerEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBuyerEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBuyerSms\u0028\u0029",
+ "name": "getBuyerSms",
+ "summary": "Gets\u0020buyerSms",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBuyerSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBuyerSms\u0028\u0029",
+ "name": "setBuyerSms",
+ "summary": "Sets\u0020buyerSms",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBuyerSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetRefundAddresses\u0028\u0029",
+ "name": "getRefundAddresses",
+ "summary": "Gets\u0020refundAddresses",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getRefundAddresses"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetRefundAddresses\u0028\u0029",
+ "name": "setRefundAddresses",
+ "summary": "Sets\u0020refundAddresses",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setRefundAddresses"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020invoice\u0020resource\u0020id",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020invoice\u0020resource\u0020id",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetUrl\u0028\u0029",
+ "name": "getUrl",
+ "summary": "Gets\u0020url",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getUrl"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetUrl\u0028\u0029",
+ "name": "setUrl",
+ "summary": "Sets\u0020url",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setUrl"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020status",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020status",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetLowFeeDetected\u0028\u0029",
+ "name": "getLowFeeDetected",
+ "summary": "Gets\u0020lowFeeDetected",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getLowFeeDetected"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetLowFeeDetected\u0028\u0029",
+ "name": "setLowFeeDetected",
+ "summary": "Sets\u0020lowFeeDetected",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setLowFeeDetected"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetInvoiceTime\u0028\u0029",
+ "name": "getInvoiceTime",
+ "summary": "Gets\u0020invoiceTime\u0020\u002D\u0020UNIX\u0020time\u0020of\u0020invoice\u0020creation,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getInvoiceTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetInvoiceTime\u0028\u0029",
+ "name": "setInvoiceTime",
+ "summary": "Sets\u0020invoiceTime\u0020\u002D\u0020UNIX\u0020time\u0020of\u0020invoice\u0020creation,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setInvoiceTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetExpirationTime\u0028\u0029",
+ "name": "getExpirationTime",
+ "summary": "Gets\u0020expirationTime\u0020\u002D\u0020UNIX\u0020time\u0020when\u0020invoice\u0020is\u0020last\u0020available\u0020to\u0020be\u0020paid,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getExpirationTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetExpirationTime\u0028\u0029",
+ "name": "setExpirationTime",
+ "summary": "Sets\u0020expirationTime\u0020\u002D\u0020UNIX\u0020time\u0020when\u0020invoice\u0020is\u0020last\u0020available\u0020to\u0020be\u0020paid,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setExpirationTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetCurrentTime\u0028\u0029",
+ "name": "getCurrentTime",
+ "summary": "Gets\u0020currentTime\u0020\u002D\u0020UNIX\u0020time\u0020of\u0020API\u0020call,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getCurrentTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetCurrentTime\u0028\u0029",
+ "name": "setCurrentTime",
+ "summary": "Sets\u0020currentTime\u0020\u002D\u0020UNIX\u0020time\u0020of\u0020API\u0020call,\u0020in\u0020milliseconds",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setCurrentTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetTransactions\u0028\u0029",
+ "name": "getTransactions",
+ "summary": "Gets\u0020transactions",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getTransactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetTransactions\u0028\u0029",
+ "name": "setTransactions",
+ "summary": "Sets\u0020transactions",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setTransactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetExceptionStatus\u0028\u0029",
+ "name": "getExceptionStatus",
+ "summary": "Gets\u0020exceptionStatus",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getExceptionStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetExceptionStatus\u0028\u0029",
+ "name": "setExceptionStatus",
+ "summary": "Sets\u0020exceptionStatus",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setExceptionStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetTargetConfirmations\u0028\u0029",
+ "name": "getTargetConfirmations",
+ "summary": "Gets\u0020targetConfirmations",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getTargetConfirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetTargetConfirmations\u0028\u0029",
+ "name": "setTargetConfirmations",
+ "summary": "Sets\u0020targetConfirmations",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setTargetConfirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetRefundAddressRequestPending\u0028\u0029",
+ "name": "getRefundAddressRequestPending",
+ "summary": "Gets\u0020refundAddressRequestPending",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getRefundAddressRequestPending"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetRefundAddressRequestPending\u0028\u0029",
+ "name": "setRefundAddressRequestPending",
+ "summary": "Sets\u0020refundAddressRequestPending",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setRefundAddressRequestPending"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBuyerProvidedEmail\u0028\u0029",
+ "name": "getBuyerProvidedEmail",
+ "summary": "Gets\u0020buyerProvidedEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBuyerProvidedEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBuyerProvidedEmail\u0028\u0029",
+ "name": "setBuyerProvidedEmail",
+ "summary": "Sets\u0020buyerProvidedEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBuyerProvidedEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBuyerProvidedInfo\u0028\u0029",
+ "name": "getBuyerProvidedInfo",
+ "summary": "Gets\u0020buyerProvidedEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBuyerProvidedInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBuyerProvidedInfo\u0028\u0029",
+ "name": "setBuyerProvidedInfo",
+ "summary": "Sets\u0020buyerProvidedEmail",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBuyerProvidedInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetUniversalCodes\u0028\u0029",
+ "name": "getUniversalCodes",
+ "summary": "Gets\u0020universalCodes",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getUniversalCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetUniversalCodes\u0028\u0029",
+ "name": "setUniversalCodes",
+ "summary": "Sets\u0020universalCodes",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setUniversalCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetSupportedTransactionCurrencies\u0028\u0029",
+ "name": "getSupportedTransactionCurrencies",
+ "summary": "Gets\u0020supportedTransactionCurrencies",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getSupportedTransactionCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetSupportedTransactionCurrencies\u0028\u0029",
+ "name": "setSupportedTransactionCurrencies",
+ "summary": "Sets\u0020supportedTransactionCurrencies",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setSupportedTransactionCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentTotals\u0028\u0029",
+ "name": "getPaymentTotals",
+ "summary": "Gets\u0020paymentTotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentTotals\u0028\u0029",
+ "name": "setPaymentTotals",
+ "summary": "Sets\u0020paymentTotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentSubtotals\u0028\u0029",
+ "name": "getPaymentSubtotals",
+ "summary": "Gets\u0020paymentSubtotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentSubtotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentSubtotals\u0028\u0029",
+ "name": "setPaymentSubtotals",
+ "summary": "Sets\u0020paymentSubtotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentSubtotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentDisplaySubTotals\u0028\u0029",
+ "name": "getPaymentDisplaySubTotals",
+ "summary": "Gets\u0020paymentDisplaySubtotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentDisplaySubTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentDisplaySubTotals\u0028\u0029",
+ "name": "setPaymentDisplaySubTotals",
+ "summary": "Sets\u0020paymentDisplaySubtotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentDisplaySubTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentDisplayTotals\u0028\u0029",
+ "name": "getPaymentDisplayTotals",
+ "summary": "Gets\u0020paymentDisplayTotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentDisplayTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentDisplayTotals\u0028\u0029",
+ "name": "setPaymentDisplayTotals",
+ "summary": "Sets\u0020paymentDisplayTotals",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentDisplayTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetPaymentCodes\u0028\u0029",
+ "name": "getPaymentCodes",
+ "summary": "Gets\u0020paymentCodes",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getPaymentCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetPaymentCodes\u0028\u0029",
+ "name": "setPaymentCodes",
+ "summary": "Sets\u0020paymentCodes",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setPaymentCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetUnderpaidAmount\u0028\u0029",
+ "name": "getUnderpaidAmount",
+ "summary": "Gets\u0020underpaidAmount",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getUnderpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetUnderpaidAmount\u0028\u0029",
+ "name": "setUnderpaidAmount",
+ "summary": "Sets\u0020underpaidAmount",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setUnderpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetOverpaidAmount\u0028\u0029",
+ "name": "getOverpaidAmount",
+ "summary": "Gets\u0020overpaidAmount",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getOverpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetOverpaidAmount\u0028\u0029",
+ "name": "setOverpaidAmount",
+ "summary": "Sets\u0020overpaidAmount",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setOverpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetMinerFees\u0028\u0029",
+ "name": "getMinerFees",
+ "summary": "Gets\u0020minerFees",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getMinerFees"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetMinerFees\u0028\u0029",
+ "name": "setMinerFees",
+ "summary": "Sets\u0020minerFees",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setMinerFees"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetNonPayProPaymentReceived\u0028\u0029",
+ "name": "getNonPayProPaymentReceived",
+ "summary": "Gets\u0020nonPayProPaymentReceived",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getNonPayProPaymentReceived"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetNonPayProPaymentReceived\u0028\u0029",
+ "name": "setNonPayProPaymentReceived",
+ "summary": "Sets\u0020nonPayProPaymentReceived",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setNonPayProPaymentReceived"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetShopper\u0028\u0029",
+ "name": "getShopper",
+ "summary": "Gets\u0020shopper",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getShopper"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetShopper\u0028\u0029",
+ "name": "setShopper",
+ "summary": "Sets\u0020shopper",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setShopper"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetBillId\u0028\u0029",
+ "name": "getBillId",
+ "summary": "Gets\u0020billId",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getBillId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetBillId\u0028\u0029",
+ "name": "setBillId",
+ "summary": "Sets\u0020billId",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setBillId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetRefundInfo\u0028\u0029",
+ "name": "getRefundInfo",
+ "summary": "Gets\u0020refundInfo",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getRefundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetRefundInfo\u0028\u0029",
+ "name": "setRefundInfo",
+ "summary": "Sets\u0020refundInfo",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setRefundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetExtendedNotifications\u0028\u0029",
+ "name": "getExtendedNotifications",
+ "summary": "Gets\u0020extendedNotifications",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getExtendedNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetExtendedNotifications\u0028\u0029",
+ "name": "setExtendedNotifications",
+ "summary": "Sets\u0020extendedNotifications",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setExtendedNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetTransactionCurrency\u0028\u0029",
+ "name": "getTransactionCurrency",
+ "summary": "Gets\u0020transactionCurrency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetTransactionCurrency\u0028\u0029",
+ "name": "setTransactionCurrency",
+ "summary": "Sets\u0020transactionCurrency",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetAmountPaid\u0028\u0029",
+ "name": "getAmountPaid",
+ "summary": "Gets\u0020amountPaid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getAmountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetAmountPaid\u0028\u0029",
+ "name": "setAmountPaid",
+ "summary": "Sets\u0020amountPaid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setAmountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetDisplayAmountPaid\u0028\u0029",
+ "name": "getDisplayAmountPaid",
+ "summary": "Gets\u0020displayAmountPaid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getDisplayAmountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetDisplayAmountPaid\u0028\u0029",
+ "name": "setDisplayAmountPaid",
+ "summary": "Sets\u0020displayAmountPaid",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setDisplayAmountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetExchangeRates\u0028\u0029",
+ "name": "getExchangeRates",
+ "summary": "Gets\u0020exchangeRates",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getExchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetExchangeRates\u0028\u0029",
+ "name": "setExchangeRates",
+ "summary": "Sets\u0020exchangeRates",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setExchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AgetIsCancelled\u0028\u0029",
+ "name": "getIsCancelled",
+ "summary": "Gets\u0020isCancelled",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_getIsCancelled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AsetIsCancelled\u0028\u0029",
+ "name": "setIsCancelled",
+ "summary": "Sets\u0020isCancelled",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_setIsCancelled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Returns\u0020the\u0020Invoice\u0020object\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024guid",
+ "name": "guid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_guid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024price",
+ "name": "price",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_price"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024posData",
+ "name": "posData",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_posData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024notificationURL",
+ "name": "notificationURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_notificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024transactionSpeed",
+ "name": "transactionSpeed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_transactionSpeed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024fullNotifications",
+ "name": "fullNotifications",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_fullNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024notificationEmail",
+ "name": "notificationEmail",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_notificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024redirectURL",
+ "name": "redirectURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_redirectURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024orderId",
+ "name": "orderId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_orderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024itemDesc",
+ "name": "itemDesc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_itemDesc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024itemCode",
+ "name": "itemCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_itemCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024physical",
+ "name": "physical",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_physical"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentCurrencies",
+ "name": "paymentCurrencies",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentSubtotals",
+ "name": "paymentSubtotals",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentSubtotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentTotals",
+ "name": "paymentTotals",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentCodes",
+ "name": "paymentCodes",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024acceptanceWindow",
+ "name": "acceptanceWindow",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_acceptanceWindow"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024buyer",
+ "name": "buyer",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_buyer"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024refundAddresses",
+ "name": "refundAddresses",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_refundAddresses"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024closeURL",
+ "name": "closeURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_closeURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024autoRedirect",
+ "name": "autoRedirect",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_autoRedirect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024jsonPayProRequired",
+ "name": "jsonPayProRequired",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_jsonPayProRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024buyerEmail",
+ "name": "buyerEmail",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_buyerEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024buyerSms",
+ "name": "buyerSms",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_buyerSms"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024merchantName",
+ "name": "merchantName",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_merchantName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024selectedTransactionCurrency",
+ "name": "selectedTransactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_selectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024forcedBuyerSelectedWallet",
+ "name": "forcedBuyerSelectedWallet",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_forcedBuyerSelectedWallet"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024forcedBuyerSelectedTransactionCurrency",
+ "name": "forcedBuyerSelectedTransactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_forcedBuyerSelectedTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024itemizedDetails",
+ "name": "itemizedDetails",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_itemizedDetails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024url",
+ "name": "url",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_url"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024lowFeeDetected",
+ "name": "lowFeeDetected",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_lowFeeDetected"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024invoiceTime",
+ "name": "invoiceTime",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_invoiceTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024expirationTime",
+ "name": "expirationTime",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_expirationTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024currentTime",
+ "name": "currentTime",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_currentTime"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024transactions",
+ "name": "transactions",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_transactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024exceptionStatus",
+ "name": "exceptionStatus",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_exceptionStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024targetConfirmations",
+ "name": "targetConfirmations",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_targetConfirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024refundAddressRequestPending",
+ "name": "refundAddressRequestPending",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_refundAddressRequestPending"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024buyerProvidedEmail",
+ "name": "buyerProvidedEmail",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_buyerProvidedEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024buyerProvidedInfo",
+ "name": "buyerProvidedInfo",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_buyerProvidedInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024universalCodes",
+ "name": "universalCodes",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_universalCodes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024supportedTransactionCurrencies",
+ "name": "supportedTransactionCurrencies",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_supportedTransactionCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024minerFees",
+ "name": "minerFees",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_minerFees"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024nonPayProPaymentReceived",
+ "name": "nonPayProPaymentReceived",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_nonPayProPaymentReceived"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024shopper",
+ "name": "shopper",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_shopper"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024billId",
+ "name": "billId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_billId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024refundInfo",
+ "name": "refundInfo",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_refundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024extendedNotifications",
+ "name": "extendedNotifications",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_extendedNotifications"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024isCancelled",
+ "name": "isCancelled",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_isCancelled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024transactionCurrency",
+ "name": "transactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_transactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024underpaidAmount",
+ "name": "underpaidAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_underpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024overpaidAmount",
+ "name": "overpaidAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_overpaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024amountPaid",
+ "name": "amountPaid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_amountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024displayAmountPaid",
+ "name": "displayAmountPaid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_displayAmountPaid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024exchangeRates",
+ "name": "exchangeRates",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_exchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024bitpayIdRequired",
+ "name": "bitpayIdRequired",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_bitpayIdRequired"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentDisplayTotals",
+ "name": "paymentDisplayTotals",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentDisplayTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Invoice\u003A\u003A\u0024paymentDisplaySubTotals",
+ "name": "paymentDisplaySubTotals",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Invoice.html#property_paymentDisplaySubTotals"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus",
+ "name": "InvoiceStatus",
+ "summary": "The\u0020type\u0020Invoice\u0020status.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003ANEW",
+ "name": "NEW",
+ "summary": "An\u0020invoice\u0020starts\u0020in\u0020this\u0020state.\u0020When\u0020in\u0020this\u0020state\u0020and\u0020only\u0020in\u0020this\u0020state,\u0020payments\u0020broadcasted\u0020by\u0020purchasers\nbe\u0020applied\u0020to\u0020the\u0020invoice\u0020\u0028there\u0020is\u0020a\u002015\u0020minute\u0020window\u0020for\u0020the\u0020purchaser\u0020to\u0020send\u0020a\u0020payment\u0020from\ntheir\u0020crypto\u0020wallet\u0029.\u0020If\u0020an\u0020invoice\u0020has\u0020received\u0020a\u0020partial\u0020payment,\nit\u0020will\u0020still\u0020reflect\u0020a\u0020status\u0020of\u0020new\u0020to\u0020the\u0020merchant.\u0020From\u0020a\u0020merchant\u0020system\u0020perspective,\nan\u0020invoice\u0020is\u0020either\u0020paid\u0020or\u0020not\u0020paid,\u0020partial\u0020payments\u0020are\u0020automatically\u0020refunded\u0020by\u0020BitPay\u0020to\u0020the\u0020consumer.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_NEW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003APAID",
+ "name": "PAID",
+ "summary": "As\u0020soon\u0020as\u0020payment\u0020is\u0020received\u0020it\u0020is\u0020evaluated\u0020against\u0020the\u0020invoice\u0020requested\u0020amount.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_PAID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003ACONFIRMED",
+ "name": "CONFIRMED",
+ "summary": "This\u0020status\u0020can\u0020be\u0020used\u0020by\u0020merchants\u0020in\u0020order\u0020to\u0020fulfill\u0020orders\u0020placed\u0020by\u0020the\u0020consumer.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_CONFIRMED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003ACOMPLETE",
+ "name": "COMPLETE",
+ "summary": "When\u0020an\u0020invoice\u0020has\u0020the\u0020status\u0020complete,\u0020it\u0020means\u0020that\u0020BitPay\u0020has\u0020credited\u0020the\u0020merchant\u0020account,\nin\u0020the\u0020currency\u0020indicated\u0020in\u0020the\u0020settlement\u0020settings.\u0020For\u0020instance,\u0020with\u0020invoices\u0020paid\u0020in\u0020Bitcoin\u0020\u0028BTC\u0029,\n6\u0020confirmation\u0020blocks\u0020on\u0020the\u0020bitcoin\u0020network\u0020are\u0020required\u0020for\u0020an\u0020invoice\u0020to\u0020be\u0020complete,\nthis\u0020takes\u0020on\u0020average\u00201\u0020hour.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_COMPLETE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003AEXPIRED",
+ "name": "EXPIRED",
+ "summary": "An\u0020invoice\u0020reaches\u0020the\u0020expired\u0020status\u0020if\u0020no\u0020payment\u0020was\u0020received\u0020and\u0020the\u002015\u0020minute\u0020payment\u0020window\u0020has\u0020elapsed.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_EXPIRED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\InvoiceStatus\u003A\u003AINVALID",
+ "name": "INVALID",
+ "summary": "An\u0020invoice\u0020is\u0020considered\u0020invalid\u0020when\u0020it\u0020was\u0020paid,\nbut\u0020the\u0020corresponding\u0020cryptocurrency\u0020transaction\u0020was\u0020not\u0020confirmed\u0020within\u00201\u0020hour\u0020on\u0020the\u0020corresponding\u0020blockchain.",
+ "url": "classes/BitPaySDK-Model-Invoice-InvoiceStatus.html#constant_INVALID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails",
+ "name": "ItemizedDetails",
+ "summary": "Class\u0020ItemizedDetails",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020The\u0020amount\u0020of\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020The\u0020amount\u0020of\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AgetDescription\u0028\u0029",
+ "name": "getDescription",
+ "summary": "Gets\u0020description",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_getDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AsetDescription\u0028\u0029",
+ "name": "setDescription",
+ "summary": "Sets\u0020string\u0020for\u0020the\u0020item.",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_setDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AgetIsFee\u0028\u0029",
+ "name": "getIsFee",
+ "summary": "Gets\u0020is\u0020fee",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_getIsFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AsetIsFee\u0028\u0029",
+ "name": "setIsFee",
+ "summary": "Sets\u0020is\u0020fee",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_setIsFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Item\u0020details\u0020data\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003A\u0024description",
+ "name": "description",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#property_description"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\ItemizedDetails\u003A\u003A\u0024isFee",
+ "name": "isFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-ItemizedDetails.html#property_isFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees",
+ "name": "MinerFees",
+ "summary": "The\u0020total\u0020amount\u0020of\u0020fees\u0020that\u0020the\u0020purchaser\u0020will\u0020pay\u0020to\u0020cover\u0020BitPay\u0027s\u0020UTXO\u0020sweep\u0020cost\u0020for\u0020an\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "MinerFees\u0020constructor.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetBTC\u0028\u0029",
+ "name": "getBTC",
+ "summary": "Gets\u0020BTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetBTC\u0028\u0029",
+ "name": "setBTC",
+ "summary": "Sets\u0020BTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetBCH\u0028\u0029",
+ "name": "getBCH",
+ "summary": "Gets\u0020BCH.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getBCH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetBCH\u0028\u0029",
+ "name": "setBCH",
+ "summary": "Sets\u0020BCH.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setBCH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetETH\u0028\u0029",
+ "name": "getETH",
+ "summary": "Gets\u0020ETH.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getETH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetETH\u0028\u0029",
+ "name": "setETH",
+ "summary": "Sets\u0020ETH.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setETH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetUSDC\u0028\u0029",
+ "name": "getUSDC",
+ "summary": "Gets\u0020USDC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getUSDC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetUSDC\u0028\u0029",
+ "name": "setUSDC",
+ "summary": "Sets\u0020USDC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setUSDC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetGUSD\u0028\u0029",
+ "name": "getGUSD",
+ "summary": "Gets\u0020GUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getGUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetGUSD\u0028\u0029",
+ "name": "setGUSD",
+ "summary": "Sets\u0020GUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setGUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetPAX\u0028\u0029",
+ "name": "getPAX",
+ "summary": "Gets\u0020PAX.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getPAX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetPAX\u0028\u0029",
+ "name": "setPAX",
+ "summary": "Sets\u0020PAX.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setPAX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetBUSD\u0028\u0029",
+ "name": "getBUSD",
+ "summary": "Gets\u0020BUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getBUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetBUSD\u0028\u0029",
+ "name": "setBUSD",
+ "summary": "Sets\u0020BUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setBUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetXRP\u0028\u0029",
+ "name": "getXRP",
+ "summary": "Gets\u0020XRP.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getXRP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetXRP\u0028\u0029",
+ "name": "setXRP",
+ "summary": "Sets\u0020XRP.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setXRP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetDOGE\u0028\u0029",
+ "name": "getDOGE",
+ "summary": "Gets\u0020DOGE.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getDOGE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetDOGE\u0028\u0029",
+ "name": "setDOGE",
+ "summary": "Sets\u0020DOGE.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setDOGE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetLTC\u0028\u0029",
+ "name": "getLTC",
+ "summary": "Gets\u0020LTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getLTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetLTC\u0028\u0029",
+ "name": "setLTC",
+ "summary": "Sets\u0020LTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setLTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetDAI\u0028\u0029",
+ "name": "getDAI",
+ "summary": "Gets\u0020DAI.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getDAI"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetDAI\u0028\u0029",
+ "name": "setDAI",
+ "summary": "Sets\u0020DAI.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setDAI"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AgetWBTC\u0028\u0029",
+ "name": "getWBTC",
+ "summary": "Gets\u0020WBTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_getWBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AsetWBTC\u0028\u0029",
+ "name": "setWBTC",
+ "summary": "Sets\u0020WBTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_setWBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020array\u0020with\u0020details\u0020for\u0020currencies.",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024btc",
+ "name": "btc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_btc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024bch",
+ "name": "bch",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_bch"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024eth",
+ "name": "eth",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_eth"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024usdc",
+ "name": "usdc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_usdc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024gusd",
+ "name": "gusd",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_gusd"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024pax",
+ "name": "pax",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_pax"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024busd",
+ "name": "busd",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_busd"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024xrp",
+ "name": "xrp",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_xrp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024doge",
+ "name": "doge",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_doge"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024ltc",
+ "name": "ltc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_ltc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024dai",
+ "name": "dai",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_dai"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFees\u003A\u003A\u0024wbtc",
+ "name": "wbtc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFees.html#property_wbtc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem",
+ "name": "MinerFeesItem",
+ "summary": "Class\u0020MinerFeesItem",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AgetSatoshisPerByte\u0028\u0029",
+ "name": "getSatoshisPerByte",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_getSatoshisPerByte"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AsetSatoshisPerByte\u0028\u0029",
+ "name": "setSatoshisPerByte",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_setSatoshisPerByte"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AgetTotalFee\u0028\u0029",
+ "name": "getTotalFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_getTotalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AsetTotalFee\u0028\u0029",
+ "name": "setTotalFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_setTotalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AgetFiatAmount\u0028\u0029",
+ "name": "getFiatAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_getFiatAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AsetFiatAmount\u0028\u0029",
+ "name": "setFiatAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_setFiatAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003A\u0024satoshisPerByte",
+ "name": "satoshisPerByte",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#property_satoshisPerByte"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003A\u0024totalFee",
+ "name": "totalFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#property_totalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\MinerFeesItem\u003A\u003A\u0024fiatAmount",
+ "name": "fiatAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-MinerFeesItem.html#property_fiatAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund",
+ "name": "Refund",
+ "summary": "Class\u0020Refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020Refund\u0020object",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetGuid\u0028\u0029",
+ "name": "getGuid",
+ "summary": "Gets\u0020a\u0020passthru\u0020variable\u0020provided\u0020by\u0020the\u0020merchant\u0020and\u0020designed\u0020to\u0020be\u0020used\u0020by\u0020the\u0020merchant\u0020to\u0020correlate\nthe\u0020invoice\u0020with\u0020an\u0020order\u0020ID\u0020in\u0020their\u0020system",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetGuid\u0028\u0029",
+ "name": "setGuid",
+ "summary": "Sets\u0020guid",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetReference\u0028\u0029",
+ "name": "getReference",
+ "summary": "Present\u0020only\u0020if\u0020specified\u0020in\u0020the\u0020request\u0020to\u0020create\u0020the\u0020refund.\u0020This\u0020is\u0020your\u0020reference\u0020label\u0020for\u0020this\u0020refund.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetReference\u0028\u0029",
+ "name": "setReference",
+ "summary": "Sets\u0020reference\u0020label\u0020for\u0020refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020amount\u0020to\u0020be\u0020refunded\u0020in\u0020the\u0020invoice\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020amount\u0020to\u0020be\u0020refunded",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020API\u0020token",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020API\u0020token",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020reference\u0020currency\u0020used\u0020for\u0020the\u0020refund,\u0020the\u0020same\u0020as\u0020the\u0020currency\u0020used\u0020to\u0020create\u0020the\u0020invoice",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency\u0020used\u0020for\u0020the\u0020refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetPreview\u0028\u0029",
+ "name": "getPreview",
+ "summary": "Whether\u0020to\u0020create\u0020the\u0020refund\u0020request\u0020as\u0020a\u0020preview",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getPreview"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetPreview\u0028\u0029",
+ "name": "setPreview",
+ "summary": "Sets\u0020preview",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setPreview"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetInvoiceId\u0028\u0029",
+ "name": "getInvoiceId",
+ "summary": "Gets\u0020the\u0020ID\u0020of\u0020the\u0020invoice\u0020to\u0020refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetInvoiceId\u0028\u0029",
+ "name": "setInvoiceId",
+ "summary": "Sets\u0020invoice\u0020id",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020the\u0020ID\u0020of\u0020the\u0020refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020id\u0020of\u0020the\u0020refund",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetRequestDate\u0028\u0029",
+ "name": "getRequestDate",
+ "summary": "Gets\u0020the\u0020date\u0020the\u0020refund\u0020was\u0020requested",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetRequestDate\u0028\u0029",
+ "name": "setRequestDate",
+ "summary": "Sets\u0020request\u0020date",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020the\u0020refund\u0020lifecycle\u0020status\u0020of\u0020the\u0020request",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020refund\u0020status",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetImmediate\u0028\u0029",
+ "name": "getImmediate",
+ "summary": "Gets\u0020whether\u0020the\u0020funds\u0020should\u0020be\u0020removed\u0020from\u0020merchant\u0020ledger\u0020immediately\non\u0020submission\u0020or\u0020at\u0020the\u0020time\u0020of\u0020processing",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getImmediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetImmediate\u0028\u0029",
+ "name": "setImmediate",
+ "summary": "Sets\u0020immediate\u0020value",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setImmediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetRefundFee\u0028\u0029",
+ "name": "getRefundFee",
+ "summary": "Gets\u0020the\u0020amount\u0020of\u0020refund\u0020fee\u0020expressed\u0020in\u0020terms\u0020of\u0020pricing\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetRefundFee\u0028\u0029",
+ "name": "setRefundFee",
+ "summary": "Sets\u0020amount\u0020of\u0020the\u0020refund\u0020fee",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetLastRefundNotification\u0028\u0029",
+ "name": "getLastRefundNotification",
+ "summary": "Gets\u0020the\u0020last\u0020time\u0020notification\u0020of\u0020buyer\u0020was\u0020attempted",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getLastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetLastRefundNotification\u0028\u0029",
+ "name": "setLastRefundNotification",
+ "summary": "Sets\u0020last\u0020refund\u0020notification",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setLastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetInvoice\u0028\u0029",
+ "name": "getInvoice",
+ "summary": "Gets\u0020the\u0020ID\u0020of\u0020the\u0020invoice\u0020being\u0020refunded",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetInvoice\u0028\u0029",
+ "name": "setInvoice",
+ "summary": "Sets\u0020the\u0020id\u0020of\u0020the\u0020invoice\u0020being\u0020refunded",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetBuyerPaysRefundFee\u0028\u0029",
+ "name": "getBuyerPaysRefundFee",
+ "summary": "Gets\u0020whether\u0020the\u0020buyer\u0020should\u0020pay\u0020the\u0020refund\u0020fee\u0020rather\nthan\u0020the\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getBuyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetBuyerPaysRefundFee\u0028\u0029",
+ "name": "setBuyerPaysRefundFee",
+ "summary": "Sets\u0020whether\u0020the\u0020buyer\u0020should\u0020pay\u0020the\u0020refund\u0020fee\u0020rather",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setBuyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetNotificationURL\u0028\u0029",
+ "name": "getNotificationURL",
+ "summary": "Gets\u0020URL\u0020to\u0020which\u0020BitPay\u0020sends\u0020webhook\u0020notifications.\u0020HTTPS\u0020is\u0020mandatory.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetNotificationURL\u0028\u0029",
+ "name": "setNotificationURL",
+ "summary": "Sets\u0020URL\u0020to\u0020which\u0020BitPay\u0020sends\u0020webhook\u0020notifications.\u0020HTTPS\u0020is\u0020mandatory.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetRefundAddress\u0028\u0029",
+ "name": "getRefundAddress",
+ "summary": "Gets\u0020the\u0020wallet\u0020address\u0020that\u0020the\u0020refund\u0020will\u0020return\u0020the\u0020funds\u0020to,\u0020added\u0020by\u0020the\u0020customer.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getRefundAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetRefundAddress\u0028\u0029",
+ "name": "setRefundAddress",
+ "summary": "Sets\u0020the\u0020wallet\u0020address\u0020that\u0020the\u0020refund\u0020will\u0020return\u0020the\u0020funds\u0020to,\u0020added\u0020by\u0020the\u0020customer.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setRefundAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetSupportRequest\u0028\u0029",
+ "name": "getSupportRequest",
+ "summary": "Gets\u0020the\u0020ID\u0020of\u0020the\u0020associated\u0020support\u0020request\u0020for\u0020the\u0020refund.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetSupportRequest\u0028\u0029",
+ "name": "setSupportRequest",
+ "summary": "Sets\u0020the\u0020ID\u0020of\u0020the\u0020associated\u0020support\u0020request\u0020for\u0020the\u0020refund.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetTransactionAmount\u0028\u0029",
+ "name": "getTransactionAmount",
+ "summary": "Gets\u0020amount\u0020to\u0020be\u0020refunded\u0020in\u0020terms\u0020of\u0020the\u0020transaction\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getTransactionAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetTransactionAmount\u0028\u0029",
+ "name": "setTransactionAmount",
+ "summary": "Sets\u0020amount\u0020to\u0020be\u0020refunded\u0020in\u0020terms\u0020of\u0020the\u0020transaction\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setTransactionAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetTransactionCurrency\u0028\u0029",
+ "name": "getTransactionCurrency",
+ "summary": "Gets\u0020the\u0020currency\u0020used\u0020for\u0020the\u0020invoice\u0020transaction.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetTransactionCurrency\u0028\u0029",
+ "name": "setTransactionCurrency",
+ "summary": "Sets\u0020the\u0020currency\u0020used\u0020for\u0020the\u0020invoice\u0020transaction.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetTransactionRefundFee\u0028\u0029",
+ "name": "getTransactionRefundFee",
+ "summary": "Gets\u0020the\u0020refund\u0020fee\u0020expressed\u0020in\u0020terms\u0020of\u0020transaction\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getTransactionRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetTransactionRefundFee\u0028\u0029",
+ "name": "setTransactionRefundFee",
+ "summary": "Sets\u0020the\u0020refund\u0020fee\u0020expressed\u0020in\u0020terms\u0020of\u0020transaction\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setTransactionRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetTxid\u0028\u0029",
+ "name": "getTxid",
+ "summary": "Gets\u0020the\u0020transaction\u0020ID\u0020of\u0020the\u0020refund\u0020once\u0020executed.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getTxid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetTxid\u0028\u0029",
+ "name": "setTxid",
+ "summary": "Sets\u0020the\u0020transaction\u0020ID\u0020of\u0020the\u0020refund\u0020once\u0020executed.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setTxid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AgetType\u0028\u0029",
+ "name": "getType",
+ "summary": "\u003Cp\u003EGets\u0020the\u0020type\u0020of\u0020refund.\u003C\/p\u003E\n\u003Cul\u003E\n\u0020\u0020\u0020\u003Cli\u003Efull\u0020\u0028current\u0020rate\u0029\u003A\u0020A\u0020full\u0020refund\u0020of\u0020the\u0020amount\u0020paid\u0020at\u0020the\u0020current\u0020rate.\u003C\/li\u003E\n\u0020\u0020\u0020\u003Cli\u003Efull\u0020\u0028fixed\u0020rate\u0029\u003A\u0020A\u0020full\u0020refund\u0020of\u0020the\u0020amount\u0020paid\u0020at\u0020the\u0020fixed\u0020rate.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_getType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AsetType\u0028\u0029",
+ "name": "setType",
+ "summary": "\u003Cp\u003ESets\u0020the\u0020type\u0020of\u0020refund.\u003C\/p\u003E\n\u003Cul\u003E\n\u0020\u0020\u0020\u003Cli\u003Efull\u0020\u0028current\u0020rate\u0029\u003A\u0020A\u0020full\u0020refund\u0020of\u0020the\u0020amount\u0020paid\u0020at\u0020the\u0020current\u0020rate.\u003C\/li\u003E\n\u0020\u0020\u0020\u003Cli\u003Efull\u0020\u0028fixed\u0020rate\u0029\u003A\u0020A\u0020full\u0020refund\u0020of\u0020the\u0020amount\u0020paid\u0020at\u0020the\u0020fixed\u0020rate.",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_setType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020Refund\u0020values\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024guid",
+ "name": "guid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_guid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024requestDate",
+ "name": "requestDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_requestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024invoiceId",
+ "name": "invoiceId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_invoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024preview",
+ "name": "preview",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_preview"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024immediate",
+ "name": "immediate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_immediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024buyerPaysRefundFee",
+ "name": "buyerPaysRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_buyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024refundFee",
+ "name": "refundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_refundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024reference",
+ "name": "reference",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_reference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024lastRefundNotification",
+ "name": "lastRefundNotification",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_lastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024invoice",
+ "name": "invoice",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_invoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024notificationURL",
+ "name": "notificationURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_notificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024refundAddress",
+ "name": "refundAddress",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_refundAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024supportRequest",
+ "name": "supportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_supportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024transactionAmount",
+ "name": "transactionAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_transactionAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024transactionCurrency",
+ "name": "transactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_transactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024transactionRefundFee",
+ "name": "transactionRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_transactionRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024txid",
+ "name": "txid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_txid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Refund\u003A\u003A\u0024type",
+ "name": "type",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Refund.html#property_type"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo",
+ "name": "RefundInfo",
+ "summary": "For\u0020a\u0020refunded\u0020invoice,\u0020this\u0020object\u0020will\u0020contain\u0020the\u0020details\u0020of\u0020executed\u0020refunds\u0020for\u0020the\u0020corresponding\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AgetSupportRequest\u0028\u0029",
+ "name": "getSupportRequest",
+ "summary": "Gets\u0020support\u0020request",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_getSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AsetSupportRequest\u0028\u0029",
+ "name": "setSupportRequest",
+ "summary": "Sets\u0020support\u0020request",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_setSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AgetAmounts\u0028\u0029",
+ "name": "getAmounts",
+ "summary": "Gets\u0020amounts",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_getAmounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AsetAmounts\u0028\u0029",
+ "name": "setAmounts",
+ "summary": "Set\u0020amounts",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_setAmounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Refund\u0020info\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003A\u0024supportRequest",
+ "name": "supportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#property_supportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundInfo\u003A\u003A\u0024amounts",
+ "name": "amounts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundInfo.html#property_amounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus",
+ "name": "RefundStatus",
+ "summary": "Refund\u0020status\u0020list",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003APREVIEW",
+ "name": "PREVIEW",
+ "summary": "No\u0020funds\u0020deducted,\u0020refund\u0020will\u0020not\u0020proceed\u0020automatically",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_PREVIEW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003ACREATED",
+ "name": "CREATED",
+ "summary": "Funds\u0020deducted\/allocated\u0020if\u0020immediate,\u0020will\u0020proceed\u0020when\u0020transactions\u0020are\u0020confirmed\nand\u0020the\u0020required\u0020data\u0020is\u0020collected",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_CREATED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003ACANCELLED",
+ "name": "CANCELLED",
+ "summary": "Refund\u0020was\u0020canceled\u0020by\u0020merchant\u0020action.\u0020Immediate\u0020refunds\u0020cannot\u0020be\u0020canceled\u0020outside\u0020of\u0020preview\u0020state",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_CANCELLED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003APENDING",
+ "name": "PENDING",
+ "summary": "Refund\u0020is\u0020in\u0020process\u0020of\u0020being\u0020fulfilled",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_PENDING"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003ASUCCESS",
+ "name": "SUCCESS",
+ "summary": "Refund\u0020was\u0020successfully\u0020processed",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_SUCCESS"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundStatus\u003A\u003AFAILURE",
+ "name": "FAILURE",
+ "summary": "Refund\u0020failed\u0020during\u0020processing\u0020\u0028this\u0020is\u0020really\u0020more\u0020of\u0020an\u0020internal\u0020state\u0029",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundStatus.html#constant_FAILURE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook",
+ "name": "RefundWebhook",
+ "summary": "Class\u0020RefundWebhook",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetInvoice\u0028\u0029",
+ "name": "getInvoice",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetInvoice\u0028\u0029",
+ "name": "setInvoice",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setInvoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetSupportRequest\u0028\u0029",
+ "name": "getSupportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetSupportRequest\u0028\u0029",
+ "name": "setSupportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetLastRefundNotification\u0028\u0029",
+ "name": "getLastRefundNotification",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getLastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetLastRefundNotification\u0028\u0029",
+ "name": "setLastRefundNotification",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setLastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetRefundFee\u0028\u0029",
+ "name": "getRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetRefundFee\u0028\u0029",
+ "name": "setRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetImmediate\u0028\u0029",
+ "name": "getImmediate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getImmediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetImmediate\u0028\u0029",
+ "name": "setImmediate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setImmediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetBuyerPaysRefundFee\u0028\u0029",
+ "name": "getBuyerPaysRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getBuyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetBuyerPaysRefundFee\u0028\u0029",
+ "name": "setBuyerPaysRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setBuyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AgetRequestDate\u0028\u0029",
+ "name": "getRequestDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_getRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AsetRequestDate\u0028\u0029",
+ "name": "setRequestDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_setRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024invoice",
+ "name": "invoice",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_invoice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024supportRequest",
+ "name": "supportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_supportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024lastRefundNotification",
+ "name": "lastRefundNotification",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_lastRefundNotification"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024refundFee",
+ "name": "refundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_refundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024immediate",
+ "name": "immediate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_immediate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024buyerPaysRefundFee",
+ "name": "buyerPaysRefundFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_buyerPaysRefundFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\RefundWebhook\u003A\u003A\u0024requestDate",
+ "name": "requestDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-RefundWebhook.html#property_requestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper",
+ "name": "Shopper",
+ "summary": "This\u0020object\u0020will\u0020be\u0020available\u0020on\u0020the\u0020invoice\u0020if\u0020a\u0020shopper\u0020signs\u0020in\u0020on\u0020an\u0020invoice\u0020using\u0020his\u0020BitPay\u0020ID.",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper\u003A\u003AgetUser\u0028\u0029",
+ "name": "getUser",
+ "summary": "Gets\u0020user",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html#method_getUser"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper\u003A\u003AsetUser\u0028\u0029",
+ "name": "setUser",
+ "summary": "Sets\u0020user",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html#method_setUser"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Shopper\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\Shopper\u003A\u003A\u0024user",
+ "name": "user",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-Shopper.html#property_user"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies",
+ "name": "SupportedTransactionCurrencies",
+ "summary": "Class\u0020SupportedTransactionCurrencies.\u0020The\u0020currencies\u0020that\u0020may\u0020be\u0020used\u0020to\u0020pay\u0020this\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "SupportedTransactionCurrencies\u0020constructor.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetBTC\u0028\u0029",
+ "name": "getBTC",
+ "summary": "Gets\u0020BTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetBTC\u0028\u0029",
+ "name": "setBTC",
+ "summary": "Sets\u0020BTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetBCH\u0028\u0029",
+ "name": "getBCH",
+ "summary": "Gets\u0020BCH.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getBCH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetBCH\u0028\u0029",
+ "name": "setBCH",
+ "summary": "Sets\u0020BCH.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setBCH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetETH\u0028\u0029",
+ "name": "getETH",
+ "summary": "Gets\u0020ETH.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getETH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetETH\u0028\u0029",
+ "name": "setETH",
+ "summary": "Sets\u0020ETH.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setETH"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetUSDC\u0028\u0029",
+ "name": "getUSDC",
+ "summary": "Gets\u0020USDC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getUSDC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetUSDC\u0028\u0029",
+ "name": "setUSDC",
+ "summary": "Sets\u0020USDC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setUSDC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetGUSD\u0028\u0029",
+ "name": "getGUSD",
+ "summary": "Gets\u0020GUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getGUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetGUSD\u0028\u0029",
+ "name": "setGUSD",
+ "summary": "Sets\u0020GUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setGUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetPAX\u0028\u0029",
+ "name": "getPAX",
+ "summary": "Gets\u0020PAX.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getPAX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetPAX\u0028\u0029",
+ "name": "setPAX",
+ "summary": "Sets\u0020PAX.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setPAX"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetXRP\u0028\u0029",
+ "name": "getXRP",
+ "summary": "Gets\u0020XRP.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getXRP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetXRP\u0028\u0029",
+ "name": "setXRP",
+ "summary": "Sets\u0020XRP.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setXRP"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetBUSD\u0028\u0029",
+ "name": "getBUSD",
+ "summary": "Gets\u0020BUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getBUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetBUSD\u0028\u0029",
+ "name": "setBUSD",
+ "summary": "Sets\u0020BUSD.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setBUSD"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetDOGE\u0028\u0029",
+ "name": "getDOGE",
+ "summary": "Gets\u0020DOGE.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getDOGE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetDOGE\u0028\u0029",
+ "name": "setDOGE",
+ "summary": "Sets\u0020DOGE.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setDOGE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetLTC\u0028\u0029",
+ "name": "getLTC",
+ "summary": "Gets\u0020LTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getLTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetLTC\u0028\u0029",
+ "name": "setLTC",
+ "summary": "Sets\u0020LTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setLTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AgetWBTC\u0028\u0029",
+ "name": "getWBTC",
+ "summary": "Gets\u0020WBTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_getWBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AsetWBTC\u0028\u0029",
+ "name": "setWBTC",
+ "summary": "Sets\u0020WBTC.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_setWBTC"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020array\u0020with\u0020details\u0020for\u0020currencies.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024btc",
+ "name": "btc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_btc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024bch",
+ "name": "bch",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_bch"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024eth",
+ "name": "eth",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_eth"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024usdc",
+ "name": "usdc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_usdc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024gusd",
+ "name": "gusd",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_gusd"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024pax",
+ "name": "pax",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_pax"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024xrp",
+ "name": "xrp",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_xrp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024busd",
+ "name": "busd",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_busd"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024doge",
+ "name": "doge",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_doge"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024ltc",
+ "name": "ltc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_ltc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrencies\u003A\u003A\u0024wbtc",
+ "name": "wbtc",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html#property_wbtc"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency",
+ "name": "SupportedTransactionCurrency",
+ "summary": "Class\u0020SupportedTransactionCurrency\nThe\u0020currency\u0020that\u0020may\u0020be\u0020used\u0020to\u0020pay\u0020this\u0020invoice.\u0020The\u0020values\u0020are\u0020objects\u0020with\u0020an\u0020\u0022enabled\u0022\u0020boolean\u0020and\u0020option.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "SupportedTransactionCurrency\u0020constructor.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003AsetEnabled\u0028\u0029",
+ "name": "setEnabled",
+ "summary": "Gets\u0020enabled.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method_setEnabled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003AgetEnabled\u0028\u0029",
+ "name": "getEnabled",
+ "summary": "Sets\u0020enabled.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method_getEnabled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003AsetReason\u0028\u0029",
+ "name": "setReason",
+ "summary": "Gets\u0020reason.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method_setReason"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003AgetReason\u0028\u0029",
+ "name": "getReason",
+ "summary": "Sets\u0020reason.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method_getReason"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020array\u0020with\u0020enabled\u0020and\u0020reason\u0020value.",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003A\u0024enabled",
+ "name": "enabled",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#property_enabled"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\SupportedTransactionCurrency\u003A\u003A\u0024reason",
+ "name": "reason",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html#property_reason"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes",
+ "name": "UniversalCodes",
+ "summary": "Object\u0020containing\u0020wallet\u002Dspecific\u0020URLs\u0020for\u0020payment\u0020protocol.",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003AgetPaymentString\u0028\u0029",
+ "name": "getPaymentString",
+ "summary": "Gets\u0020payment\u0020string",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method_getPaymentString"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003AsetPaymentString\u0028\u0029",
+ "name": "setPaymentString",
+ "summary": "Sets\u0020payment\u0020string",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method_setPaymentString"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003AgetVerificationLink\u0028\u0029",
+ "name": "getVerificationLink",
+ "summary": "Gets\u0020verification\u0020link",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method_getVerificationLink"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003AsetVerificationLink\u0028\u0029",
+ "name": "setVerificationLink",
+ "summary": "Sets\u0020verification\u0020link",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method_setVerificationLink"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Universal\u0020codes\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003A\u0024paymentString",
+ "name": "paymentString",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#property_paymentString"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice\\UniversalCodes\u003A\u003A\u0024verificationLink",
+ "name": "verificationLink",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Invoice-UniversalCodes.html#property_verificationLink"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer",
+ "name": "Buyer",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020name",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020name",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetAddress1\u0028\u0029",
+ "name": "getAddress1",
+ "summary": "Gets\u0020address\u00201",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetAddress1\u0028\u0029",
+ "name": "setAddress1",
+ "summary": "Sets\u0020address1",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setAddress1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetAddress2\u0028\u0029",
+ "name": "getAddress2",
+ "summary": "Gets\u0020address2",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetAddress2\u0028\u0029",
+ "name": "setAddress2",
+ "summary": "Sets\u0020address2",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetCity\u0028\u0029",
+ "name": "getCity",
+ "summary": "Gets\u0020city",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetCity\u0028\u0029",
+ "name": "setCity",
+ "summary": "Sets\u0020city",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetState\u0028\u0029",
+ "name": "getState",
+ "summary": "Gets\u0020state",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getState"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetState\u0028\u0029",
+ "name": "setState",
+ "summary": "Sets\u0020state",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setState"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetZip\u0028\u0029",
+ "name": "getZip",
+ "summary": "Gets\u0020zip",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getZip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetZip\u0028\u0029",
+ "name": "setZip",
+ "summary": "Sets\u0020zip",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setZip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetCountry\u0028\u0029",
+ "name": "getCountry",
+ "summary": "Gets\u0020country",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetCountry\u0028\u0029",
+ "name": "setCountry",
+ "summary": "Sets\u0020country",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetEmail\u0028\u0029",
+ "name": "getEmail",
+ "summary": "Gets\u0020email",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetEmail\u0028\u0029",
+ "name": "setEmail",
+ "summary": "Sets\u0020email",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetPhone\u0028\u0029",
+ "name": "getPhone",
+ "summary": "Gets\u0020phone",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetPhone\u0028\u0029",
+ "name": "setPhone",
+ "summary": "Sets\u0020phone",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setPhone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AgetNotify\u0028\u0029",
+ "name": "getNotify",
+ "summary": "Gets\u0020notify",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_getNotify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AsetNotify\u0028\u0029",
+ "name": "setNotify",
+ "summary": "Sets\u0020notify",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_setNotify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Buyer\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024address1",
+ "name": "address1",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_address1"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024address2",
+ "name": "address2",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_address2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024city",
+ "name": "city",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_city"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024state",
+ "name": "state",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_state"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024zip",
+ "name": "zip",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_zip"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024country",
+ "name": "country",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_country"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024phone",
+ "name": "phone",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_phone"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024notify",
+ "name": "notify",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_notify"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Buyer\u003A\u003A\u0024email",
+ "name": "email",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Buyer.html#property_email"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger",
+ "name": "Ledger",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020Ledger\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020Ledger\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003AgetBalance\u0028\u0029",
+ "name": "getBalance",
+ "summary": "Gets\u0020Ledger\u0020balance\u0020in\u0020the\u0020corresponding\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method_getBalance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003AsetBalance\u0028\u0029",
+ "name": "setBalance",
+ "summary": "Sets\u0020Ledger\u0020balance\u0020in\u0020the\u0020corresponding\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method_setBalance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Ledger\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\Ledger\u003A\u003A\u0024balance",
+ "name": "balance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-Ledger.html#property_balance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry",
+ "name": "LedgerEntry",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetType\u0028\u0029",
+ "name": "getType",
+ "summary": "Gets\u0020type",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetType\u0028\u0029",
+ "name": "setType",
+ "summary": "Sets\u0020type",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020Ledger\u0020entry\u0020amount,\u0020relative\u0020to\u0020the\u0020scale.",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020Ledger\u0020entry\u0020amount,\u0020relative\u0020to\u0020the\u0020scale.",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Gets\u0020code",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020code",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetTimestamp\u0028\u0029",
+ "name": "getTimestamp",
+ "summary": "Gets\u0020Date\u0020and\u0020time\u0020of\u0020the\u0020ledger\u0020entry\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getTimestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetTimestamp\u0028\u0029",
+ "name": "setTimestamp",
+ "summary": "Sets\u0020Date\u0020and\u0020time\u0020of\u0020the\u0020ledger\u0020entry\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setTimestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020Ledger\u0020entry\u0020currency\u0020for\u0020the\u0020corresponding\u0020amount",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020Ledger\u0020entry\u0020currency\u0020for\u0020the\u0020corresponding\u0020amount",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetTxType\u0028\u0029",
+ "name": "getTxType",
+ "summary": "Gets\u0020tx\u0020type",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getTxType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetTxType\u0028\u0029",
+ "name": "setTxType",
+ "summary": "Sets\u0020tx\u0020type",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setTxType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetScale\u0028\u0029",
+ "name": "getScale",
+ "summary": "Gets\u0020scale",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getScale"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetScale\u0028\u0029",
+ "name": "setScale",
+ "summary": "Sets\u0020scale",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setScale"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020Ledger\u0020resource\u0020Id",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020Ledger\u0020resource\u0020Id",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetSupportRequest\u0028\u0029",
+ "name": "getSupportRequest",
+ "summary": "Gets\u0020The\u0020refund\u0020requestId",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetSupportRequest\u0028\u0029",
+ "name": "setSupportRequest",
+ "summary": "Sets\u0020The\u0020refund\u0020requestId",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetDescription\u0028\u0029",
+ "name": "getDescription",
+ "summary": "Gets\u0020description",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetDescription\u0028\u0029",
+ "name": "setDescription",
+ "summary": "Sets\u0020description",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetInvoiceId\u0028\u0029",
+ "name": "getInvoiceId",
+ "summary": "Gets\u0020BitPay\u0020invoice\u0020Id",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetInvoiceId\u0028\u0029",
+ "name": "setInvoiceId",
+ "summary": "Sets\u0020BitPay\u0020invoice\u0020Id",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetBuyerFields\u0028\u0029",
+ "name": "getBuyerFields",
+ "summary": "Gets\u0020buyer\u0020fields",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getBuyerFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetBuyerFields\u0028\u0029",
+ "name": "setBuyerFields",
+ "summary": "Sets\u0020buyer\u0020fields",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setBuyerFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetInvoiceAmount\u0028\u0029",
+ "name": "getInvoiceAmount",
+ "summary": "Gets\u0020Invoice\u0020price\u0020in\u0020the\u0020invoice\u0020original\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getInvoiceAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetInvoiceAmount\u0028\u0029",
+ "name": "setInvoiceAmount",
+ "summary": "Sets\u0020Invoice\u0020price\u0020in\u0020the\u0020invoice\u0020original\u0020currency",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setInvoiceAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetInvoiceCurrency\u0028\u0029",
+ "name": "getInvoiceCurrency",
+ "summary": "Gets\u0020Currency\u0020used\u0020for\u0020invoice\u0020creation",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getInvoiceCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetInvoiceCurrency\u0028\u0029",
+ "name": "setInvoiceCurrency",
+ "summary": "Sets\u0020Currency\u0020used\u0020for\u0020invoice\u0020creation",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setInvoiceCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AgetTransactionCurrency\u0028\u0029",
+ "name": "getTransactionCurrency",
+ "summary": "Gets\u0020Cryptocurrency\u0020selected\u0020by\u0020the\u0020consumer\u0020when\u0020paying\u0020an\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_getTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AsetTransactionCurrency\u0028\u0029",
+ "name": "setTransactionCurrency",
+ "summary": "Sets\u0020Cryptocurrency\u0020selected\u0020by\u0020the\u0020consumer\u0020when\u0020paying\u0020an\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_setTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020LedgerEntry\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024type",
+ "name": "type",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_type"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024timestamp",
+ "name": "timestamp",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_timestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024txType",
+ "name": "txType",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_txType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024scale",
+ "name": "scale",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_scale"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024supportRequest",
+ "name": "supportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_supportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024description",
+ "name": "description",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_description"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024invoiceId",
+ "name": "invoiceId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_invoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024buyerFields",
+ "name": "buyerFields",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_buyerFields"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024invoiceAmount",
+ "name": "invoiceAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_invoiceAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024invoiceCurrency",
+ "name": "invoiceCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_invoiceCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger\\LedgerEntry\u003A\u003A\u0024transactionCurrency",
+ "name": "transactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Ledger-LedgerEntry.html#property_transactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout",
+ "name": "Payout",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020a\u0020request\u0020Payout\u0020object.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020resource\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020resource\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020amount\u0020of\u0020cryptocurrency\u0020sent\u0020to\u0020the\u0020requested\u0020address.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020amount\u0020of\u0020cryptocurrency\u0020sent\u0020to\u0020the\u0020requested\u0020address.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AformatAmount\u0028\u0029",
+ "name": "formatAmount",
+ "summary": "Change\u0020amount\u0020value\u0020based\u0020on\u0020precision\u0020rounding.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_formatAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020currency\u0020code\u0020set\u0020for\u0020the\u0020batch\u0020amount\u0020\u0028ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code\u0029.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency\u0020code\u0020set\u0020for\u0020the\u0020batch\u0020amount\u0020\u0028ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code\u0029.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetEffectiveDate\u0028\u0029",
+ "name": "getEffectiveDate",
+ "summary": "Gets\u0020Ledger\u0020currency\u0020code\u0020\u0028ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code\u0029",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getEffectiveDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetEffectiveDate\u0028\u0029",
+ "name": "setEffectiveDate",
+ "summary": "Sets\u0020effective\u0020date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020for\u0020the\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setEffectiveDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetLedgerCurrency\u0028\u0029",
+ "name": "getLedgerCurrency",
+ "summary": "Gets\u0020Ledger\u0020currency\u0020code\u0020\u0028ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getLedgerCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetLedgerCurrency\u0028\u0029",
+ "name": "setLedgerCurrency",
+ "summary": "Sets\u0020Ledger\u0020currency\u0020code\u0020\u0028ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code\u0029",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setLedgerCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetReference\u0028\u0029",
+ "name": "getReference",
+ "summary": "Gets\u0020reference.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetReference\u0028\u0029",
+ "name": "setReference",
+ "summary": "Sets\u0020reference.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetNotificationURL\u0028\u0029",
+ "name": "getNotificationURL",
+ "summary": "Gets\u0020notification\u0020url.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetNotificationURL\u0028\u0029",
+ "name": "setNotificationURL",
+ "summary": "Sets\u0020notification\u0020url.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetNotificationEmail\u0028\u0029",
+ "name": "getNotificationEmail",
+ "summary": "Gets\u0020notification\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getNotificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetNotificationEmail\u0028\u0029",
+ "name": "setNotificationEmail",
+ "summary": "Sets\u0020notification\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setNotificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetAccountId\u0028\u0029",
+ "name": "getAccountId",
+ "summary": "Gets\u0020BitPay\u0020account\u0020id\u0020that\u0020is\u0020associated\u0020to\u0020the\u0020payout,\nassigned\u0020by\u0020BitPay\u0020for\u0020a\u0020given\u0020account\u0020during\u0020the\u0020onboarding\u0020process.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getAccountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetAccountId\u0028\u0029",
+ "name": "setAccountId",
+ "summary": "Sets\u0020BitPay\u0020account\u0020id\u0020that\u0020is\u0020associated\u0020to\u0020the\u0020payout,\nassigned\u0020by\u0020BitPay\u0020for\u0020a\u0020given\u0020account\u0020during\u0020the\u0020onboarding\u0020process.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setAccountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetEmail\u0028\u0029",
+ "name": "getEmail",
+ "summary": "Gets\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetEmail\u0028\u0029",
+ "name": "setEmail",
+ "summary": "Sets\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetRecipientId\u0028\u0029",
+ "name": "getRecipientId",
+ "summary": "Gets\u0020BitPay\u0020recipient\u0020id.\u0020Assigned\u0020by\u0020BitPay\u0020for\u0020a\u0020given\u0020recipient\u0020email\u0020during\u0020the\u0020onboarding\u0020process.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getRecipientId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetRecipientId\u0028\u0029",
+ "name": "setRecipientId",
+ "summary": "Sets\u0020BitPay\u0020recipient\u0020id.\u0020Assigned\u0020by\u0020BitPay\u0020for\u0020a\u0020given\u0020recipient\u0020email\u0020during\u0020the\u0020onboarding\u0020process.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setRecipientId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetShopperId\u0028\u0029",
+ "name": "getShopperId",
+ "summary": "Gets\u0020shopper\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getShopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetShopperId\u0028\u0029",
+ "name": "setShopperId",
+ "summary": "Sets\u0020shopper\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setShopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetLabel\u0028\u0029",
+ "name": "getLabel",
+ "summary": "Gets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetLabel\u0028\u0029",
+ "name": "setLabel",
+ "summary": "Sets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetMessage\u0028\u0029",
+ "name": "getMessage",
+ "summary": "Gets\u0020message.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetMessage\u0028\u0029",
+ "name": "setMessage",
+ "summary": "Sets\u0020message.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetGroupId\u0028\u0029",
+ "name": "getGroupId",
+ "summary": "Gets\u0020group\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getGroupId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetGroupId\u0028\u0029",
+ "name": "setGroupId",
+ "summary": "Sets\u0020group\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setGroupId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "This\u0020field\u0020will\u0020be\u0020returned\u0020in\u0020case\u0020of\u0020error\u0020and\u0020contain\u0020an\u0020error\u0020code.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020error\u0020code.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetDateExecuted\u0028\u0029",
+ "name": "getDateExecuted",
+ "summary": "Gets\u0020date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020BitPay\u0020executed\u0020the\u0020payout.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getDateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetDateExecuted\u0028\u0029",
+ "name": "setDateExecuted",
+ "summary": "Sets\u0020date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020BitPay\u0020executed\u0020the\u0020payout.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setDateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020Payout\u0020request\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020Payout\u0020request\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020payout\u0020request\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020payout\u0020request\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetRequestDate\u0028\u0029",
+ "name": "getRequestDate",
+ "summary": "Gets\u0020date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020BitPay\u0020received\u0020the\u0020batch.\u0020ISO\u002D8601\u0020format\u0020\u0060yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ\u0060.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetRequestDate\u0028\u0029",
+ "name": "setRequestDate",
+ "summary": "Sets\u0020date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020BitPay\u0020received\u0020the\u0020batch.\u0020ISO\u002D8601\u0020format\u0020\u0060yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ\u0060.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setRequestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetExchangeRates\u0028\u0029",
+ "name": "getExchangeRates",
+ "summary": "Gets\u0020exchange\u0020rates\u0020keyed\u0020by\u0020source\u0020and\u0020target\u0020currencies.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getExchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetExchangeRates\u0028\u0029",
+ "name": "setExchangeRates",
+ "summary": "Sets\u0020exchange\u0020rates\u0020keyed\u0020by\u0020source\u0020and\u0020target\u0020currencies.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setExchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AgetTransactions\u0028\u0029",
+ "name": "getTransactions",
+ "summary": "Gets\u0020transactions.\u0020Contains\u0020the\u0020cryptocurrency\u0020transaction\u0020details\u0020for\u0020the\u0020executed\u0020payout\u0020request.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_getTransactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetTransactions\u0028\u0029",
+ "name": "setTransactions",
+ "summary": "Sets\u0020transactions.\u0020Contains\u0020the\u0020cryptocurrency\u0020transaction\u0020details\u0020for\u0020the\u0020executed\u0020payout\u0020request.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setTransactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AisIgnoreEmails\u0028\u0029",
+ "name": "isIgnoreEmails",
+ "summary": "Gets\u0020boolean\u0020to\u0020prevent\u0020email\u0020updates\u0020on\u0020a\u0020specific\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_isIgnoreEmails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AsetIgnoreEmails\u0028\u0029",
+ "name": "setIgnoreEmails",
+ "summary": "Sets\u0020boolean\u0020to\u0020prevent\u0020email\u0020updates\u0020on\u0020a\u0020specific\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_setIgnoreEmails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020Payout\u0020values\u0020as\u0020array.",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024effectiveDate",
+ "name": "effectiveDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_effectiveDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024ledgerCurrency",
+ "name": "ledgerCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_ledgerCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024reference",
+ "name": "reference",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_reference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024notificationURL",
+ "name": "notificationURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_notificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024notificationEmail",
+ "name": "notificationEmail",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_notificationEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024accountId",
+ "name": "accountId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_accountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024email",
+ "name": "email",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_email"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024recipientId",
+ "name": "recipientId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_recipientId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024shopperId",
+ "name": "shopperId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_shopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024label",
+ "name": "label",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_label"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024message",
+ "name": "message",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_message"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024ignoreEmails",
+ "name": "ignoreEmails",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_ignoreEmails"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024groupId",
+ "name": "groupId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_groupId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024dateExecuted",
+ "name": "dateExecuted",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_dateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024requestDate",
+ "name": "requestDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_requestDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024exchangeRates",
+ "name": "exchangeRates",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_exchangeRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\Payout\u003A\u003A\u0024transactions",
+ "name": "transactions",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-Payout.html#property_transactions"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup",
+ "name": "PayoutGroup",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003AgetPayouts\u0028\u0029",
+ "name": "getPayouts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#method_getPayouts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003AsetPayouts\u0028\u0029",
+ "name": "setPayouts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#method_setPayouts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003AgetFailed\u0028\u0029",
+ "name": "getFailed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#method_getFailed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003AsetFailed\u0028\u0029",
+ "name": "setFailed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#method_setFailed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003A\u0024payouts",
+ "name": "payouts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#property_payouts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroup\u003A\u003A\u0024failed",
+ "name": "failed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroup.html#property_failed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed",
+ "name": "PayoutGroupFailed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AgetErrorMessage\u0028\u0029",
+ "name": "getErrorMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_getErrorMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AsetErrorMessage\u0028\u0029",
+ "name": "setErrorMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_setErrorMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AgetPayoutId\u0028\u0029",
+ "name": "getPayoutId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_getPayoutId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AsetPayoutId\u0028\u0029",
+ "name": "setPayoutId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_setPayoutId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AgetPayee\u0028\u0029",
+ "name": "getPayee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_getPayee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003AsetPayee\u0028\u0029",
+ "name": "setPayee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#method_setPayee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003A\u0024errMessage",
+ "name": "errMessage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#property_errMessage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003A\u0024payoutId",
+ "name": "payoutId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#property_payoutId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutGroupFailed\u003A\u003A\u0024payee",
+ "name": "payee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html#property_payee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient",
+ "name": "PayoutRecipient",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020a\u0020minimal\u0020Recipient\u0020object.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetEmail\u0028\u0029",
+ "name": "getEmail",
+ "summary": "Gets\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetEmail\u0028\u0029",
+ "name": "setEmail",
+ "summary": "Sets\u0020email.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setEmail"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetGuid\u0028\u0029",
+ "name": "getGuid",
+ "summary": "Gets\u0020guid.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetGuid\u0028\u0029",
+ "name": "setGuid",
+ "summary": "Sets\u0020guid.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetLabel\u0028\u0029",
+ "name": "getLabel",
+ "summary": "Gets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetLabel\u0028\u0029",
+ "name": "setLabel",
+ "summary": "Sets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetNotificationURL\u0028\u0029",
+ "name": "getNotificationURL",
+ "summary": "Gets\u0020notification\u0020url.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetNotificationURL\u0028\u0029",
+ "name": "setNotificationURL",
+ "summary": "Sets\u0020notification\u0020url.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setNotificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020id.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetShopperId\u0028\u0029",
+ "name": "getShopperId",
+ "summary": "Gets\u0020Shopper\u0020ID.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getShopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetShopperId\u0028\u0029",
+ "name": "setShopperId",
+ "summary": "Sets\u0020Shopper\u0020ID.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setShopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020an\u0020array\u0020with\u0020values\u0020of\u0020all\u0020fields.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024email",
+ "name": "email",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_email"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024guid",
+ "name": "guid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_guid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024label",
+ "name": "label",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_label"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024notificationURL",
+ "name": "notificationURL",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_notificationURL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024shopperId",
+ "name": "shopperId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_shopperId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipient\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipient.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients",
+ "name": "PayoutRecipients",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020an\u0020recipient\u002Dfull\u0020request\u0020PayoutBatch\u0020object.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AgetGuid\u0028\u0029",
+ "name": "getGuid",
+ "summary": "Gets\u0020guid.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_getGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AsetGuid\u0028\u0029",
+ "name": "setGuid",
+ "summary": "Sets\u0020guid.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_setGuid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020token.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AgetRecipients\u0028\u0029",
+ "name": "getRecipients",
+ "summary": "Gets\u0020an\u0020array\u0020with\u0020all\u0020recipients.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_getRecipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AsetRecipients\u0028\u0029",
+ "name": "setRecipients",
+ "summary": "Sets\u0020array\u0020with\u0020all\u0020recipients.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_setRecipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020an\u0020array\u0020with\u0020paid\u0020and\u0020unpaid\u0020value.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003A\u0024recipients",
+ "name": "recipients",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#property_recipients"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003A\u0024guid",
+ "name": "guid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#property_guid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutRecipients\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutRecipients.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus",
+ "name": "PayoutStatus",
+ "summary": "Interface\u0020PayoutStatus",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003ANEW",
+ "name": "NEW",
+ "summary": "New\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_NEW"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003AFUNDED",
+ "name": "FUNDED",
+ "summary": "Funded\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_FUNDED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003APROCESSING",
+ "name": "PROCESSING",
+ "summary": "Processing\u0020status",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_PROCESSING"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003ACOMPLETE",
+ "name": "COMPLETE",
+ "summary": "Complete\u0020status",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_COMPLETE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003AFAILED",
+ "name": "FAILED",
+ "summary": "Failed\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_FAILED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003ACANCELLED",
+ "name": "CANCELLED",
+ "summary": "Cancelled\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_CANCELLED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003APAID",
+ "name": "PAID",
+ "summary": "Paid\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_PAID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutStatus\u003A\u003AUNPAID",
+ "name": "UNPAID",
+ "summary": "Unpaid\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutStatus.html#constant_UNPAID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction",
+ "name": "PayoutTransaction",
+ "summary": "Contains\u0020the\u0020cryptocurrency\u0020transaction\u0020details\u0020for\u0020the\u0020executed\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AgetTxid\u0028\u0029",
+ "name": "getTxid",
+ "summary": "Gets\u0020Cryptocurrency\u0020transaction\u0020hash\u0020for\u0020the\u0020executed\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_getTxid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AsetTxid\u0028\u0029",
+ "name": "setTxid",
+ "summary": "Sets\u0020Cryptocurrency\u0020transaction\u0020hash\u0020for\u0020the\u0020executed\u0020payout.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_setTxid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020Amount\u0020of\u0020cryptocurrency\u0020sent\u0020to\u0020the\u0020requested\u0020address.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020Amount\u0020of\u0020cryptocurrency\u0020sent\u0020to\u0020the\u0020requested\u0020address.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AgetDate\u0028\u0029",
+ "name": "getDate",
+ "summary": "Gets\u0020Date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020the\u0020cryptocurrency\u0020transaction\u0020is\u0020broadcasted.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_getDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AsetDate\u0028\u0029",
+ "name": "setDate",
+ "summary": "Sets\u0020Date\u0020and\u0020time\u0020\u0028UTC\u0029\u0020when\u0020the\u0020cryptocurrency\u0020transaction\u0020is\u0020broadcasted.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_setDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AgetConfirmations\u0028\u0029",
+ "name": "getConfirmations",
+ "summary": "Gets\u0020the\u0020number\u0020of\u0020confirmations\u0020the\u0020transaction\u0020has\u0020received.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_getConfirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AsetConfirmations\u0028\u0029",
+ "name": "setConfirmations",
+ "summary": "Sets\u0020the\u0020number\u0020of\u0020confirmations\u0020the\u0020transaction\u0020has\u0020received.",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_setConfirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020PayoutTransaction\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003A\u0024txid",
+ "name": "txid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#property_txid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003A\u0024date",
+ "name": "date",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#property_date"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\PayoutTransaction\u003A\u003A\u0024confirmations",
+ "name": "confirmations",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Payout-PayoutTransaction.html#property_confirmations"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientReferenceMethod",
+ "name": "RecipientReferenceMethod",
+ "summary": "List\u0020of\u0020recipient\u0020reference\u0020methods",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientReferenceMethod\u003A\u003AEMAIL",
+ "name": "EMAIL",
+ "summary": "Email\u0020method\u0020will\u0020be\u0020used\u0020to\u0020target\u0020the\u0020recipient",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html#constant_EMAIL"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientReferenceMethod\u003A\u003ARECIPIENT_ID",
+ "name": "RECIPIENT_ID",
+ "summary": "Recipient\u0020id\u0020will\u0020be\u0020used\u0020to\u0020target\u0020the\u0020recipient",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html#constant_RECIPIENT_ID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientReferenceMethod\u003A\u003ASHOPPER_ID",
+ "name": "SHOPPER_ID",
+ "summary": "Shopper\u0020id\u0020will\u0020be\u0020used\u0020to\u0020target\u0020the\u0020recipient",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html#constant_SHOPPER_ID"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus",
+ "name": "RecipientStatus",
+ "summary": "Interface\u0020RecipientStatus",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003AINVITED",
+ "name": "INVITED",
+ "summary": "Invited\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_INVITED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003AUNVERIFIED",
+ "name": "UNVERIFIED",
+ "summary": "Unverified\u0020\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_UNVERIFIED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003AVERIFIED",
+ "name": "VERIFIED",
+ "summary": "Verified\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_VERIFIED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003AACTIVE",
+ "name": "ACTIVE",
+ "summary": "Active\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_ACTIVE"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003APAUSED",
+ "name": "PAUSED",
+ "summary": "Paused\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_PAUSED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout\\RecipientStatus\u003A\u003AREMOVED",
+ "name": "REMOVED",
+ "summary": "Removed\u0020recipient\u0020status.",
+ "url": "classes/BitPaySDK-Model-Payout-RecipientStatus.html#constant_REMOVED"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate",
+ "name": "Rate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020detailed\u0020currency\u0020name",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020detailed\u0020currency\u0020name",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Gets\u0020ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020ISO\u00204217\u00203\u002Dcharacter\u0020currency\u0020code",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AgetRate\u0028\u0029",
+ "name": "getRate",
+ "summary": "Gets\u0020rate\u0020for\u0020the\u0020requested\u0020baseCurrency\u0020\/currency\u0020pair",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_getRate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AsetRate\u0028\u0029",
+ "name": "setRate",
+ "summary": "Sets\u0020rate\u0020for\u0020the\u0020requested\u0020baseCurrency\u0020\/currency\u0020pair",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_setRate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Rate\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rate\u003A\u003A\u0024rate",
+ "name": "rate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rate.html#property_rate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates",
+ "name": "Rates",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Rates\u0020constructor.",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003AgetRates\u0028\u0029",
+ "name": "getRates",
+ "summary": "Gets\u0020rates.",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method_getRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Update\u0020rates.",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003AgetRate\u0028\u0029",
+ "name": "getRate",
+ "summary": "Gets\u0020rate\u0020for\u0020the\u0020requested\u0020currency\u0020code.",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method_getRate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020an\u0020array\u0020with\u0020rates\u0020value.",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003AvalidateRates\u0028\u0029",
+ "name": "validateRates",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#method_validateRates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate\\Rates\u003A\u003A\u0024rates",
+ "name": "rates",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Rate-Rates.html#property_rates"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData",
+ "name": "InvoiceData",
+ "summary": "Object\u0020containing\u0020relevant\u0020information\u0020from\u0020the\u0020paid\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetOrderId\u0028\u0029",
+ "name": "getOrderId",
+ "summary": "Gets\u0020Invoice\u0020orderId\u0020provided\u0020during\u0020invoice\u0020creation.",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getOrderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetOrderId\u0028\u0029",
+ "name": "setOrderId",
+ "summary": "Sets\u0020Invoice\u0020orderId\u0020provided\u0020during\u0020invoice\u0020creation.",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setOrderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetDate\u0028\u0029",
+ "name": "getDate",
+ "summary": "Gets\u0020Date\u0020at\u0020which\u0020the\u0020invoice\u0020was\u0020created\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetDate\u0028\u0029",
+ "name": "setDate",
+ "summary": "Sets\u0020Date\u0020at\u0020which\u0020the\u0020invoice\u0020was\u0020created\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetPrice\u0028\u0029",
+ "name": "getPrice",
+ "summary": "Gets\u0020Invoice\u0020price\u0020in\u0020the\u0020invoice\u0020original\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetPrice\u0028\u0029",
+ "name": "setPrice",
+ "summary": "Sets\u0020Invoice\u0020price\u0020in\u0020the\u0020invoice\u0020original\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setPrice"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020Invoice\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020Invoice\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetTransactionCurrency\u0028\u0029",
+ "name": "getTransactionCurrency",
+ "summary": "Gets\u0020Cryptocurrency\u0020selected\u0020by\u0020the\u0020consumer\u0020when\u0020paying\u0020the\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetTransactionCurrency\u0028\u0029",
+ "name": "setTransactionCurrency",
+ "summary": "Sets\u0020Cryptocurrency\u0020selected\u0020by\u0020the\u0020consumer\u0020when\u0020paying\u0020the\u0020invoice.",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setTransactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetOverPaidAmount\u0028\u0029",
+ "name": "getOverPaidAmount",
+ "summary": "Gets\u0020over\u0020paid\u0020amount",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getOverPaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetOverPaidAmount\u0028\u0029",
+ "name": "setOverPaidAmount",
+ "summary": "Sets\u0020over\u0020paid\u0020amount",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setOverPaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetPayoutPercentage\u0028\u0029",
+ "name": "getPayoutPercentage",
+ "summary": "Gets\u0020The\u0020payout\u0020percentage\u0020defined\u0020by\u0020the\u0020merchant\u0020on\u0020his\u0020BitPay\u0020account\u0020settings",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getPayoutPercentage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetPayoutPercentage\u0028\u0029",
+ "name": "setPayoutPercentage",
+ "summary": "Sets\u0020The\u0020payout\u0020percentage\u0020defined\u0020by\u0020the\u0020merchant\u0020on\u0020his\u0020BitPay\u0020account\u0020settings",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setPayoutPercentage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AgetRefundInfo\u0028\u0029",
+ "name": "getRefundInfo",
+ "summary": "Gets\u0020Object\u0020containing\u0020information\u0020about\u0020the\u0020refund\u0020executed\u0020for\u0020the\u0020invoice",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_getRefundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AsetRefundInfo\u0028\u0029",
+ "name": "setRefundInfo",
+ "summary": "Sets\u0020Object\u0020containing\u0020information\u0020about\u0020the\u0020refund\u0020executed\u0020for\u0020the\u0020invoice",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_setRefundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020InvoiceData\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024orderId",
+ "name": "orderId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_orderId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024date",
+ "name": "date",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_date"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024price",
+ "name": "price",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_price"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024transactionCurrency",
+ "name": "transactionCurrency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_transactionCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024overPaidAmount",
+ "name": "overPaidAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_overPaidAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024payoutPercentage",
+ "name": "payoutPercentage",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_payoutPercentage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\InvoiceData\u003A\u003A\u0024refundInfo",
+ "name": "refundInfo",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-InvoiceData.html#property_refundInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo",
+ "name": "PayoutInfo",
+ "summary": "Object\u0020containing\u0020the\u0020settlement\u0020info\u0020provided\u0020by\u0020the\u0020Merchant\u0020in\u0020his\u0020BitPay\u0020account\u0020settings.",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccount\u0028\u0029",
+ "name": "getAccount",
+ "summary": "Gets\u0020Bank\u0020account\u0020number\u0020of\u0020the\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccount\u0028\u0029",
+ "name": "setAccount",
+ "summary": "Sets\u0020Bank\u0020account\u0020number\u0020of\u0020the\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetRouting\u0028\u0029",
+ "name": "getRouting",
+ "summary": "Gets\u0020routing",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getRouting"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetRouting\u0028\u0029",
+ "name": "setRouting",
+ "summary": "Sets\u0020routing",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setRouting"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetMerchantEin\u0028\u0029",
+ "name": "getMerchantEin",
+ "summary": "Gets\u0020merchant\u0020ein",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getMerchantEin"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetMerchantEin\u0028\u0029",
+ "name": "setMerchantEin",
+ "summary": "Sets\u0020merchant\u0020ein",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setMerchantEin"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetLabel\u0028\u0029",
+ "name": "getLabel",
+ "summary": "Gets\u0020label",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetLabel\u0028\u0029",
+ "name": "setLabel",
+ "summary": "Sets\u0020label",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetBankCountry\u0028\u0029",
+ "name": "getBankCountry",
+ "summary": "Gets\u0020Country\u0020where\u0020the\u0020merchant\u0027s\u0020bank\u0020account\u0020is\u0020located",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getBankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetBankCountry\u0028\u0029",
+ "name": "setBankCountry",
+ "summary": "Sets\u0020Country\u0020where\u0020the\u0020merchant\u0027s\u0020bank\u0020account\u0020is\u0020located",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setBankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetName\u0028\u0029",
+ "name": "getName",
+ "summary": "Gets\u0020account\u0020holder\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetName\u0028\u0029",
+ "name": "setName",
+ "summary": "Sets\u0020account\u0020holder\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetBank\u0028\u0029",
+ "name": "getBank",
+ "summary": "Gets\u0020Name\u0020of\u0020the\u0020bank\u0020used\u0020by\u0020the\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getBank"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetBank\u0028\u0029",
+ "name": "setBank",
+ "summary": "Sets\u0020Name\u0020of\u0020the\u0020bank\u0020used\u0020by\u0020the\u0020merchant",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setBank"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetSwift\u0028\u0029",
+ "name": "getSwift",
+ "summary": "Gets\u0020SWIFT\/BIC\u0020code\u0020of\u0020the\u0020merchant\u0027s\u0020bank.",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getSwift"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetSwift\u0028\u0029",
+ "name": "setSwift",
+ "summary": "Sets\u0020SWIFT\/BIC\u0020code\u0020of\u0020the\u0020merchant\u0027s\u0020bank.",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setSwift"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAddress\u0028\u0029",
+ "name": "getAddress",
+ "summary": "Gets\u0020address",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAddress\u0028\u0029",
+ "name": "setAddress",
+ "summary": "Sets\u0020address",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetCity\u0028\u0029",
+ "name": "getCity",
+ "summary": "Gets\u0020City\u0020of\u0020the\u0020merchant\u0020bank,\u0020field\u0020return\u0020if\u0020the\u0020settlement\u0020currency\u0020is",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetCity\u0028\u0029",
+ "name": "setCity",
+ "summary": "Sets\u0020city\u0020of\u0020the\u0020merchant\u0020bank",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetPostal\u0028\u0029",
+ "name": "getPostal",
+ "summary": "Gets\u0020Postal\u0020code\u0020of\u0020the\u0020merchant\u0020bank,\u0020field\u0020return\u0020if\u0020the\u0020settlement\u0020currency\u0020is",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getPostal"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetPostal\u0028\u0029",
+ "name": "setPostal",
+ "summary": "Sets\u0020Postal\u0020code\u0020of\u0020the\u0020merchant\u0020bank",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setPostal"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetSort\u0028\u0029",
+ "name": "getSort",
+ "summary": "Gets\u0020sort",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getSort"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetSort\u0028\u0029",
+ "name": "setSort",
+ "summary": "Sets\u0020sort",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setSort"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetWire\u0028\u0029",
+ "name": "getWire",
+ "summary": "Gets\u0020wire",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getWire"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetWire\u0028\u0029",
+ "name": "setWire",
+ "summary": "Sets\u0020wire",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setWire"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetBankName\u0028\u0029",
+ "name": "getBankName",
+ "summary": "Gets\u0020bank\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getBankName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetBankName\u0028\u0029",
+ "name": "setBankName",
+ "summary": "Sets\u0020bank\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setBankName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetBankAddress\u0028\u0029",
+ "name": "getBankAddress",
+ "summary": "Gets\u0020bank\u0020address",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getBankAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetBankAddress\u0028\u0029",
+ "name": "setBankAddress",
+ "summary": "Sets\u0020bank\u0020address",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setBankAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetBankAddress2\u0028\u0029",
+ "name": "getBankAddress2",
+ "summary": "Gets\u0020bank\u0020address\u00202",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getBankAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetBankAddress2\u0028\u0029",
+ "name": "setBankAddress2",
+ "summary": "Sets\u0020bank\u0020address2",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setBankAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetIban\u0028\u0029",
+ "name": "getIban",
+ "summary": "Gets\u0020iban",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getIban"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetIban\u0028\u0029",
+ "name": "setIban",
+ "summary": "Sets\u0020iban",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setIban"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAdditionalInformation\u0028\u0029",
+ "name": "getAdditionalInformation",
+ "summary": "Gets\u0020additional\u0020information",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAdditionalInformation"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAdditionalInformation\u0028\u0029",
+ "name": "setAdditionalInformation",
+ "summary": "Sets\u0020additional\u0020information",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAdditionalInformation"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderName\u0028\u0029",
+ "name": "getAccountHolderName",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderName\u0028\u0029",
+ "name": "setAccountHolderName",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020name",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderAddress\u0028\u0029",
+ "name": "getAccountHolderAddress",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020address",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderAddress\u0028\u0029",
+ "name": "setAccountHolderAddress",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020address2",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderAddress2\u0028\u0029",
+ "name": "getAccountHolderAddress2",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020address2",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderAddress2\u0028\u0029",
+ "name": "setAccountHolderAddress2",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020address2",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderPostalCode\u0028\u0029",
+ "name": "getAccountHolderPostalCode",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020postal\u0020code",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderPostalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderPostalCode\u0028\u0029",
+ "name": "setAccountHolderPostalCode",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020postal\u0020code",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderPostalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderCity\u0028\u0029",
+ "name": "getAccountHolderCity",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020city",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderCity\u0028\u0029",
+ "name": "setAccountHolderCity",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020city",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AgetAccountHolderCountry\u0028\u0029",
+ "name": "getAccountHolderCountry",
+ "summary": "Gets\u0020Bank\u0020account\u0020holder\u0020country",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_getAccountHolderCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AsetAccountHolderCountry\u0028\u0029",
+ "name": "setAccountHolderCountry",
+ "summary": "Sets\u0020Bank\u0020account\u0020holder\u0020country",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_setAccountHolderCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020PayoutInfo\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024name",
+ "name": "name",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_name"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024account",
+ "name": "account",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_account"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024routing",
+ "name": "routing",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_routing"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024merchantEin",
+ "name": "merchantEin",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_merchantEin"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024label",
+ "name": "label",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_label"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024bankCountry",
+ "name": "bankCountry",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_bankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024bank",
+ "name": "bank",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_bank"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024swift",
+ "name": "swift",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_swift"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024address",
+ "name": "address",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_address"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024city",
+ "name": "city",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_city"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024postal",
+ "name": "postal",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_postal"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024sort",
+ "name": "sort",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_sort"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024wire",
+ "name": "wire",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_wire"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024bankName",
+ "name": "bankName",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_bankName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024bankAddress",
+ "name": "bankAddress",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_bankAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024bankAddress2",
+ "name": "bankAddress2",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_bankAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024iban",
+ "name": "iban",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_iban"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024additionalInformation",
+ "name": "additionalInformation",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_additionalInformation"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderName",
+ "name": "accountHolderName",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderAddress",
+ "name": "accountHolderAddress",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderAddress"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderAddress2",
+ "name": "accountHolderAddress2",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderAddress2"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderPostalCode",
+ "name": "accountHolderPostalCode",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderPostalCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderCity",
+ "name": "accountHolderCity",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderCity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\PayoutInfo\u003A\u003A\u0024accountHolderCountry",
+ "name": "accountHolderCountry",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-PayoutInfo.html#property_accountHolderCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo",
+ "name": "RefundInfo",
+ "summary": "Object\u0020containing\u0020information\u0020about\u0020the\u0020refund.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AgetSupportRequest\u0028\u0029",
+ "name": "getSupportRequest",
+ "summary": "Gets\u0020support\u0020request.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_getSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AsetSupportRequest\u0028\u0029",
+ "name": "setSupportRequest",
+ "summary": "Sets\u0020support\u0020request.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_setSupportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AgetAmounts\u0028\u0029",
+ "name": "getAmounts",
+ "summary": "Gets\u0020amounts.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_getAmounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AsetAmounts\u0028\u0029",
+ "name": "setAmounts",
+ "summary": "Sets\u0020amounts.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_setAmounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AgetRefundRequestEid\u0028\u0029",
+ "name": "getRefundRequestEid",
+ "summary": "Gets\u0020Refund\u0020Request\u0020Eid.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_getRefundRequestEid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AsetRefundRequestEid\u0028\u0029",
+ "name": "setRefundRequestEid",
+ "summary": "Sets\u0020Refund\u0020Request\u0020Eid.",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_setRefundRequestEid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Refund\u0020info\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003A\u0024supportRequest",
+ "name": "supportRequest",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#property_supportRequest"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003A\u0024amounts",
+ "name": "amounts",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#property_amounts"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\RefundInfo\u003A\u003A\u0024refundRequestEid",
+ "name": "refundRequestEid",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-RefundInfo.html#property_refundRequestEid"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement",
+ "name": "Settlement",
+ "summary": "Settlement\u0020data\u0020object.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetId\u0028\u0029",
+ "name": "getId",
+ "summary": "Gets\u0020id",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetId\u0028\u0029",
+ "name": "setId",
+ "summary": "Sets\u0020id",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetAccountId\u0028\u0029",
+ "name": "getAccountId",
+ "summary": "Gets\u0020account\u0020id",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getAccountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetAccountId\u0028\u0029",
+ "name": "setAccountId",
+ "summary": "Sets\u0020account\u0020id",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setAccountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetCurrency\u0028\u0029",
+ "name": "getCurrency",
+ "summary": "Gets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetCurrency\u0028\u0029",
+ "name": "setCurrency",
+ "summary": "Sets\u0020currency",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setCurrency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetPayoutInfo\u0028\u0029",
+ "name": "getPayoutInfo",
+ "summary": "Gets\u0020Object\u0020containing\u0020the\u0020settlement\u0020info\u0020provided\u0020by\u0020the\u0020Merchant\u0020in\u0020his\u0020BitPay\u0020account\u0020settings",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getPayoutInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetPayoutInfo\u0028\u0029",
+ "name": "setPayoutInfo",
+ "summary": "Sets\u0020Object\u0020containing\u0020the\u0020settlement\u0020info\u0020provided\u0020by\u0020the\u0020Merchant\u0020in\u0020his\u0020BitPay\u0020account\u0020settings",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setPayoutInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetStatus\u0028\u0029",
+ "name": "getStatus",
+ "summary": "Gets\u0020Status\u0020of\u0020the\u0020settlement.\u0020Possible\u0020statuses\u0020are\u0020\u0022new\u0022,\u0020\u0022processing\u0022,\u0020\u0022rejected\u0022\u0020and\u0020\u0022completed\u0022.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetStatus\u0028\u0029",
+ "name": "setStatus",
+ "summary": "Sets\u0020Status\u0020of\u0020the\u0020settlement.\u0020Possible\u0020statuses\u0020are\u0020\u0022new\u0022,\u0020\u0022processing\u0022,\u0020\u0022rejected\u0022\u0020and\u0020\u0022completed\u0022.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetDateCreated\u0028\u0029",
+ "name": "getDateCreated",
+ "summary": "Gets\u0020date\u0020created",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getDateCreated"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetDateCreated\u0028\u0029",
+ "name": "setDateCreated",
+ "summary": "Sets\u0020date\u0020created",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setDateCreated"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetDateExecuted\u0028\u0029",
+ "name": "getDateExecuted",
+ "summary": "Gets\u0020date\u0020executed",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getDateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetDateExecuted\u0028\u0029",
+ "name": "setDateExecuted",
+ "summary": "Sets\u0020date\u0020executed",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setDateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetDateCompleted\u0028\u0029",
+ "name": "getDateCompleted",
+ "summary": "Gets\u0020date\u0020completed",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getDateCompleted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetDateCompleted\u0028\u0029",
+ "name": "setDateCompleted",
+ "summary": "Sets\u0020date\u0020completed",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setDateCompleted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetOpeningDate\u0028\u0029",
+ "name": "getOpeningDate",
+ "summary": "Gets\u0020opening\u0020date",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getOpeningDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetOpeningDate\u0028\u0029",
+ "name": "setOpeningDate",
+ "summary": "Sets\u0020opening\u0020date",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setOpeningDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetClosingDate\u0028\u0029",
+ "name": "getClosingDate",
+ "summary": "Gets\u0020closing\u0020date.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getClosingDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetClosingDate\u0028\u0029",
+ "name": "setClosingDate",
+ "summary": "Sets\u0020closing\u0020date.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setClosingDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetOpeningBalance\u0028\u0029",
+ "name": "getOpeningBalance",
+ "summary": "Gets\u0020Balance\u0020of\u0020the\u0020ledger\u0020at\u0020the\u0020openingDate",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getOpeningBalance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetOpeningBalance\u0028\u0029",
+ "name": "setOpeningBalance",
+ "summary": "Sets\u0020Balance\u0020of\u0020the\u0020ledger\u0020at\u0020the\u0020openingDate",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setOpeningBalance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetLedgerEntriesSum\u0028\u0029",
+ "name": "getLedgerEntriesSum",
+ "summary": "Gets\u0020ledger\u0020entries\u0020sum.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getLedgerEntriesSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetLedgerEntriesSum\u0028\u0029",
+ "name": "setLedgerEntriesSum",
+ "summary": "Sets\u0020ledger\u0020entries\u0020sum.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setLedgerEntriesSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetWithHoldings\u0028\u0029",
+ "name": "getWithHoldings",
+ "summary": "Gets\u0020with\u0020holdings",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getWithHoldings"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetWithHoldings\u0028\u0029",
+ "name": "setWithHoldings",
+ "summary": "Sets\u0020with\u0020holdings",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setWithHoldings"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetWithHoldingsSum\u0028\u0029",
+ "name": "getWithHoldingsSum",
+ "summary": "Gets\u0020Sum\u0020of\u0020all\u0020amounts\u0020that\u0020are\u0020withheld\u0020from\u0020settlement",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getWithHoldingsSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetWithHoldingsSum\u0028\u0029",
+ "name": "setWithHoldingsSum",
+ "summary": "Sets\u0020Sum\u0020of\u0020all\u0020amounts\u0020that\u0020are\u0020withheld\u0020from\u0020settlement",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setWithHoldingsSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetTotalAmount\u0028\u0029",
+ "name": "getTotalAmount",
+ "summary": "Gets\u0020total\u0020amount\u0020sent\u0020to\u0020the\u0020merchant\u003B\u00202\u0020decimals.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getTotalAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetTotalAmount\u0028\u0029",
+ "name": "setTotalAmount",
+ "summary": "Sets\u0020total\u0020amount\u0020sent\u0020to\u0020the\u0020merchant\u003B\u00202\u0020decimals.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setTotalAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetLedgerEntries\u0028\u0029",
+ "name": "getLedgerEntries",
+ "summary": "Gets\u0020Array\u0020of\u0020ledger\u0020entries\u0020listing\u0020the\u0020various\u0020debits\u0020and\u0020credits\u0020which\u0020are\u0020settled\u0020in\u0020the\u0020report.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getLedgerEntries"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetLedgerEntries\u0028\u0029",
+ "name": "setLedgerEntries",
+ "summary": "Sets\u0020Array\u0020of\u0020ledger\u0020entries\u0020listing\u0020the\u0020various\u0020debits\u0020and\u0020credits\u0020which\u0020are\u0020settled\u0020in\u0020the\u0020report.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setLedgerEntries"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AgetToken\u0028\u0029",
+ "name": "getToken",
+ "summary": "Gets\u0020API\u0020token\u0020for\u0020the\u0020corresponding\u0020settlement\u0020resource.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_getToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AsetToken\u0028\u0029",
+ "name": "setToken",
+ "summary": "Sets\u0020API\u0020token\u0020for\u0020the\u0020corresponding\u0020settlement\u0020resource.",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_setToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Returns\u0020the\u0020Settlement\u0020object\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024id",
+ "name": "id",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_id"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024accountId",
+ "name": "accountId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_accountId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024currency",
+ "name": "currency",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_currency"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024payoutInfo",
+ "name": "payoutInfo",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_payoutInfo"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024status",
+ "name": "status",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_status"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024dateCreated",
+ "name": "dateCreated",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_dateCreated"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024dateExecuted",
+ "name": "dateExecuted",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_dateExecuted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024dateCompleted",
+ "name": "dateCompleted",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_dateCompleted"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024openingDate",
+ "name": "openingDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_openingDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024closingDate",
+ "name": "closingDate",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_closingDate"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024openingBalance",
+ "name": "openingBalance",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_openingBalance"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024ledgerEntriesSum",
+ "name": "ledgerEntriesSum",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_ledgerEntriesSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024withHoldings",
+ "name": "withHoldings",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_withHoldings"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024withHoldingsSum",
+ "name": "withHoldingsSum",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_withHoldingsSum"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024totalAmount",
+ "name": "totalAmount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_totalAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024ledgerEntries",
+ "name": "ledgerEntries",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_ledgerEntries"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\Settlement\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-Settlement.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry",
+ "name": "SettlementLedgerEntry",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Gets\u0020code",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020code",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetInvoiceId\u0028\u0029",
+ "name": "getInvoiceId",
+ "summary": "Gets\u0020BitPay\u0020invoice\u0020Id",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetInvoiceId\u0028\u0029",
+ "name": "setInvoiceId",
+ "summary": "Sets\u0020BitPay\u0020invoice\u0020Id",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setInvoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020amount",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020amount",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetTimestamp\u0028\u0029",
+ "name": "getTimestamp",
+ "summary": "Gets\u0020Date\u0020and\u0020time\u0020of\u0020the\u0020ledger\u0020entry\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getTimestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetTimestamp\u0028\u0029",
+ "name": "setTimestamp",
+ "summary": "Sets\u0020Date\u0020and\u0020time\u0020of\u0020the\u0020ledger\u0020entry\u0020\u0028UTC\u0029.\u0020ISO\u002D8601\u0020format\u0020yyyy\u002Dmm\u002DddThh\u003Amm\u003AssZ",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setTimestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetDescription\u0028\u0029",
+ "name": "getDescription",
+ "summary": "Gets\u0020Ledger\u0020entry\u0020description.",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetDescription\u0028\u0029",
+ "name": "setDescription",
+ "summary": "Sets\u0020Ledger\u0020entry\u0020description.",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetReference\u0028\u0029",
+ "name": "getReference",
+ "summary": "Gets\u0020reference",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetReference\u0028\u0029",
+ "name": "setReference",
+ "summary": "Sets\u0020reference",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setReference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AgetInvoiceData\u0028\u0029",
+ "name": "getInvoiceData",
+ "summary": "Gets\u0020Invoice\u0020Data",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_getInvoiceData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AsetInvoiceData\u0028\u0029",
+ "name": "setInvoiceData",
+ "summary": "Sets\u0020Invoice\u0020Data",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_setInvoiceData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020SettlementLedgerEntry\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024invoiceId",
+ "name": "invoiceId",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_invoiceId"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024timestamp",
+ "name": "timestamp",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_timestamp"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024description",
+ "name": "description",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_description"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024reference",
+ "name": "reference",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_reference"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\SettlementLedgerEntry\u003A\u003A\u0024invoiceData",
+ "name": "invoiceData",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html#property_invoiceData"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings",
+ "name": "WithHoldings",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "WithHoldings\u0020constructor.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetAmount\u0028\u0029",
+ "name": "getAmount",
+ "summary": "Gets\u0020amount.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetAmount\u0028\u0029",
+ "name": "setAmount",
+ "summary": "Sets\u0020amount.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setAmount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Gets\u0020code.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020code.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetDescription\u0028\u0029",
+ "name": "getDescription",
+ "summary": "Gets\u0020description.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetDescription\u0028\u0029",
+ "name": "setDescription",
+ "summary": "Sets\u0020description.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setDescription"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetNotes\u0028\u0029",
+ "name": "getNotes",
+ "summary": "Gets\u0020notes.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getNotes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetNotes\u0028\u0029",
+ "name": "setNotes",
+ "summary": "Sets\u0020notes.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setNotes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetLabel\u0028\u0029",
+ "name": "getLabel",
+ "summary": "Gets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetLabel\u0028\u0029",
+ "name": "setLabel",
+ "summary": "Sets\u0020label.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setLabel"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AgetBankCountry\u0028\u0029",
+ "name": "getBankCountry",
+ "summary": "Gets\u0020bank\u0020country.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_getBankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AsetBankCountry\u0028\u0029",
+ "name": "setBankCountry",
+ "summary": "Sets\u0020bank\u0020country.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_setBankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Return\u0020an\u0020array\u0020with\u0020class\u0020values.",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024amount",
+ "name": "amount",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_amount"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024description",
+ "name": "description",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_description"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024notes",
+ "name": "notes",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_notes"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024label",
+ "name": "label",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_label"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement\\WithHoldings\u003A\u003A\u0024bankCountry",
+ "name": "bankCountry",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Settlement-WithHoldings.html#property_bankCountry"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies",
+ "name": "Currencies",
+ "summary": "Details\u0020of\u0020what\u0020currencies\u0020support\u0020payments\u0020for\u0020this\u0020wallet",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetCode\u0028\u0029",
+ "name": "getCode",
+ "summary": "Gets\u0020code",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetCode\u0028\u0029",
+ "name": "setCode",
+ "summary": "Sets\u0020code",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setCode"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetP2p\u0028\u0029",
+ "name": "getP2p",
+ "summary": "Gets\u0020p2p",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getP2p"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetP2p\u0028\u0029",
+ "name": "setP2p",
+ "summary": "Sets\u0020p2p",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setP2p"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetDappBrowser\u0028\u0029",
+ "name": "getDappBrowser",
+ "summary": "Gets\u0020Dapp\u0020Browser",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getDappBrowser"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetDappBrowser\u0028\u0029",
+ "name": "setDappBrowser",
+ "summary": "Sets\u0020Dapp\u0020Browser",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setDappBrowser"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetImage\u0028\u0029",
+ "name": "getImage",
+ "summary": "Gets\u0020URL\u0020that\u0020displays\u0020currency\u0020image",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getImage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetImage\u0028\u0029",
+ "name": "setImage",
+ "summary": "Sets\u0020URL\u0020that\u0020displays\u0020currency\u0020image",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setImage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetPayPro\u0028\u0029",
+ "name": "getPayPro",
+ "summary": "Gets\u0020pay\u0020pro",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getPayPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetPayPro\u0028\u0029",
+ "name": "setPayPro",
+ "summary": "Sets\u0020pay\u0020pro",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setPayPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetQr\u0028\u0029",
+ "name": "getQr",
+ "summary": "Gets\u0020CurrencyQr",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getQr"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetQr\u0028\u0029",
+ "name": "setQr",
+ "summary": "Sets\u0020CurrencyQr",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setQr"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetWithdrawalFee\u0028\u0029",
+ "name": "getWithdrawalFee",
+ "summary": "Gets\u0020Custodial\u0020wallet\u0020withdrawal\u0020fee",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getWithdrawalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetWithdrawalFee\u0028\u0029",
+ "name": "setWithdrawalFee",
+ "summary": "Sets\u0020Custodial\u0020wallet\u0020withdrawal\u0020fee",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setWithdrawalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AgetWalletConnect\u0028\u0029",
+ "name": "getWalletConnect",
+ "summary": "Gets\u0020wallet\u0020connect",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_getWalletConnect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AsetWalletConnect\u0028\u0029",
+ "name": "setWalletConnect",
+ "summary": "Sets\u0020wallet\u0020connect",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_setWalletConnect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Currencies\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024code",
+ "name": "code",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_code"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024p2p",
+ "name": "p2p",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_p2p"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024dappBrowser",
+ "name": "dappBrowser",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_dappBrowser"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024image",
+ "name": "image",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_image"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024payPro",
+ "name": "payPro",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_payPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024qr",
+ "name": "qr",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_qr"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024withdrawalFee",
+ "name": "withdrawalFee",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_withdrawalFee"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Currencies\u003A\u003A\u0024walletConnect",
+ "name": "walletConnect",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Currencies.html#property_walletConnect"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr",
+ "name": "CurrencyQr",
+ "summary": "Object\u0020containing\u0020QR\u0020code\u0020related\u0020information\u0020to\u0020show\u0020for\u0020this\u0020payment\u0020method",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003AgetType\u0028\u0029",
+ "name": "getType",
+ "summary": "Gets\u0020Type",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method_getType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003AsetType\u0028\u0029",
+ "name": "setType",
+ "summary": "Sets\u0020Type",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method_setType"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003AgetCollapsed\u0028\u0029",
+ "name": "getCollapsed",
+ "summary": "Gets\u0020collapsed",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method_getCollapsed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003AsetCollapsed\u0028\u0029",
+ "name": "setCollapsed",
+ "summary": "Sets\u0020collapsed",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method_setCollapsed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020CurrencyQr\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003A\u0024type",
+ "name": "type",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#property_type"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\CurrencyQr\u003A\u003A\u0024collapsed",
+ "name": "collapsed",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-CurrencyQr.html#property_collapsed"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet",
+ "name": "Wallet",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor,\u0020create\u0020a\u0020minimal\u0020request\u0020Wallet\u0020object.",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetKey\u0028\u0029",
+ "name": "getKey",
+ "summary": "Gets\u0020A\u0020unique\u0020identifier\u0020for\u0020the\u0020wallet",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getKey"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetKey\u0028\u0029",
+ "name": "setKey",
+ "summary": "Sets\u0020A\u0020unique\u0020identifier\u0020for\u0020the\u0020wallet",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setKey"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetDisplayName\u0028\u0029",
+ "name": "getDisplayName",
+ "summary": "Gets\u0020display\u0020name",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getDisplayName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetDisplayName\u0028\u0029",
+ "name": "setDisplayName",
+ "summary": "Sets\u0020display\u0020name",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setDisplayName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetAvatar\u0028\u0029",
+ "name": "getAvatar",
+ "summary": "Gets\u0020avatar",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getAvatar"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetAvatar\u0028\u0029",
+ "name": "setAvatar",
+ "summary": "Sets\u0020avatar",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setAvatar"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetPayPro\u0028\u0029",
+ "name": "getPayPro",
+ "summary": "Gets\u0020pay\u0020pro",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getPayPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetPayPro\u0028\u0029",
+ "name": "setPayPro",
+ "summary": "Sets\u0020pay\u0020pro",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setPayPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetCurrencies\u0028\u0029",
+ "name": "getCurrencies",
+ "summary": "Gets\u0020currencies",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetCurrencies\u0028\u0029",
+ "name": "setCurrencies",
+ "summary": "Sets\u0020currencies",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AgetImage\u0028\u0029",
+ "name": "getImage",
+ "summary": "Gets\u0020image",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_getImage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AsetImage\u0028\u0029",
+ "name": "setImage",
+ "summary": "Sets\u0020image",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_setImage"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003AtoArray\u0028\u0029",
+ "name": "toArray",
+ "summary": "Gets\u0020Wallet\u0020as\u0020array",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#method_toArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024key",
+ "name": "key",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_key"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024displayName",
+ "name": "displayName",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_displayName"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024avatar",
+ "name": "avatar",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_avatar"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024currencies",
+ "name": "currencies",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_currencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024image",
+ "name": "image",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_image"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet\\Wallet\u003A\u003A\u0024payPro",
+ "name": "payPro",
+ "summary": "",
+ "url": "classes/BitPaySDK-Model-Wallet-Wallet.html#property_payPro"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient",
+ "name": "PosClient",
+ "summary": "Client\u0020for\u0020handling\u0020POS\u0020facade\u0020specific\u0020calls.",
+ "url": "classes/BitPaySDK-PosClient.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Constructor\u0020for\u0020the\u0020BitPay\u0020SDK\u0020to\u0020use\u0020with\u0020the\u0020POS\u0020facade.",
+ "url": "classes/BitPaySDK-PosClient.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003Ainit\u0028\u0029",
+ "name": "init",
+ "summary": "Initialize\u0020this\u0020object\u0020with\u0020the\u0020selected\u0020environment.",
+ "url": "classes/BitPaySDK-PosClient.html#method_init"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003AgetCurrencies\u0028\u0029",
+ "name": "getCurrencies",
+ "summary": "Fetch\u0020the\u0020supported\u0020currencies.",
+ "url": "classes/BitPaySDK-PosClient.html#method_getCurrencies"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003A\u0024env",
+ "name": "env",
+ "summary": "",
+ "url": "classes/BitPaySDK-PosClient.html#property_env"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003A\u0024token",
+ "name": "token",
+ "summary": "",
+ "url": "classes/BitPaySDK-PosClient.html#property_token"
+ }, {
+ "fqsen": "\\BitPaySDK\\PosClient\u003A\u003A\u0024RESTcli",
+ "name": "RESTcli",
+ "summary": "",
+ "url": "classes/BitPaySDK-PosClient.html#property_RESTcli"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens",
+ "name": "Tokens",
+ "summary": "Token\u0020object\u0020used\u0020to\u0020store\u0020the\u0020tokens\u0020for\u0020the\u0020different\u0020facades.",
+ "url": "classes/BitPaySDK-Tokens.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "Tokens\u0020constructor.",
+ "url": "classes/BitPaySDK-Tokens.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003AloadFromArray\u0028\u0029",
+ "name": "loadFromArray",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#method_loadFromArray"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003AgetTokenByFacade\u0028\u0029",
+ "name": "getTokenByFacade",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#method_getTokenByFacade"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003AsetMerchantToken\u0028\u0029",
+ "name": "setMerchantToken",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#method_setMerchantToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003AgetPayoutToken\u0028\u0029",
+ "name": "getPayoutToken",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#method_getPayoutToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003AsetPayoutToken\u0028\u0029",
+ "name": "setPayoutToken",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#method_setPayoutToken"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003A\u0024merchant",
+ "name": "merchant",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#property_merchant"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003A\u0024payout",
+ "name": "payout",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#property_payout"
+ }, {
+ "fqsen": "\\BitPaySDK\\Tokens\u003A\u003A\u0024pos",
+ "name": "pos",
+ "summary": "",
+ "url": "classes/BitPaySDK-Tokens.html#property_pos"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\JsonMapperFactory",
+ "name": "JsonMapperFactory",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-JsonMapperFactory.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\JsonMapperFactory\u003A\u003Acreate\u0028\u0029",
+ "name": "create",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-JsonMapperFactory.html#method_create"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli",
+ "name": "RESTcli",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A__construct\u0028\u0029",
+ "name": "__construct",
+ "summary": "RESTcli\u0020constructor.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method___construct"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003Ainit\u0028\u0029",
+ "name": "init",
+ "summary": "Initialize\u0020Client.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_init"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003Apost\u0028\u0029",
+ "name": "post",
+ "summary": "Send\u0020POST\u0020request.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_post"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003Aget\u0028\u0029",
+ "name": "get",
+ "summary": "Send\u0020GET\u0020request.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_get"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003Adelete\u0028\u0029",
+ "name": "delete",
+ "summary": "Send\u0020DELETE\u0020request.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_delete"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003Aupdate\u0028\u0029",
+ "name": "update",
+ "summary": "Send\u0020PUT\u0020request.",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_update"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003AresponseToJsonString\u0028\u0029",
+ "name": "responseToJsonString",
+ "summary": "Convert\u0020Response\u0020object\u0020into\u0020json",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_responseToJsonString"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003AisErrorStatus\u0028\u0029",
+ "name": "isErrorStatus",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#method_isErrorStatus"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A\u0024client",
+ "name": "client",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#property_client"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A\u0024baseUrl",
+ "name": "baseUrl",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#property_baseUrl"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A\u0024ecKey",
+ "name": "ecKey",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#property_ecKey"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A\u0024identity",
+ "name": "identity",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#property_identity"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli\\RESTcli\u003A\u003A\u0024proxy",
+ "name": "proxy",
+ "summary": "",
+ "url": "classes/BitPaySDK-Util-RESTcli-RESTcli.html#property_proxy"
+ }, {
+ "fqsen": "\\",
+ "name": "\\",
+ "summary": "",
+ "url": "namespaces/default.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Client",
+ "name": "Client",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-client.html"
+ }, {
+ "fqsen": "\\BitPaySDK",
+ "name": "BitPaySDK",
+ "summary": "",
+ "url": "namespaces/bitpaysdk.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Exceptions",
+ "name": "Exceptions",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-exceptions.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Bill",
+ "name": "Bill",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-bill.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model",
+ "name": "Model",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Invoice",
+ "name": "Invoice",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-invoice.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Ledger",
+ "name": "Ledger",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-ledger.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Payout",
+ "name": "Payout",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-payout.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Rate",
+ "name": "Rate",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-rate.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Settlement",
+ "name": "Settlement",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-settlement.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Model\\Wallet",
+ "name": "Wallet",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-model-wallet.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util",
+ "name": "Util",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-util.html"
+ }, {
+ "fqsen": "\\BitPaySDK\\Util\\RESTcli",
+ "name": "RESTcli",
+ "summary": "",
+ "url": "namespaces/bitpaysdk-util-restcli.html"
+ } ]
+);
diff --git a/docs/js/template.js b/docs/js/template.js
new file mode 100644
index 00000000..49383291
--- /dev/null
+++ b/docs/js/template.js
@@ -0,0 +1,17 @@
+(function(){
+ window.addEventListener('load', () => {
+ const el = document.querySelector('.phpdocumentor-on-this-page__content')
+ if (!el) {
+ return;
+ }
+
+ const observer = new IntersectionObserver(
+ ([e]) => {
+ e.target.classList.toggle("-stuck", e.intersectionRatio < 1);
+ },
+ {threshold: [1]}
+ );
+
+ observer.observe(el);
+ })
+})();
diff --git a/docs/namespaces/bitpaysdk-client.html b/docs/namespaces/bitpaysdk-client.html
new file mode 100644
index 00000000..3383c6c1
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-client.html
@@ -0,0 +1,295 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillClient Handles interactions with the bill endpoints. InvoiceClient Handles interactions with the invoice endpoints. LedgerClient Handles interactions with the ledger endpoints. PayoutClient Handles interactions with the payout endpoints. PayoutRecipientsClient Handles interactions with the recipients endpoints. RateClient Handles interactions with the rate endpoints. RefundClient Handles interactions with the refund endpoints. SettlementClient Handles interactions with the settlement endpoints. TokenClient Handles interactions with the token endpoints. WalletClient Handles interactions with the wallet endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-exceptions.html b/docs/namespaces/bitpaysdk-exceptions.html
new file mode 100644
index 00000000..493d60bd
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-exceptions.html
@@ -0,0 +1,295 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-functional.html b/docs/namespaces/bitpaysdk-functional.html
new file mode 100644
index 00000000..a0fe8d23
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-functional.html
@@ -0,0 +1,311 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-bill.html b/docs/namespaces/bitpaysdk-model-bill.html
new file mode 100644
index 00000000..89d8222b
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-bill.html
@@ -0,0 +1,304 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ BillStatus Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
+
+
+ Classes
+
+
+
+
+ Bill Item
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-invoice.html b/docs/namespaces/bitpaysdk-model-invoice.html
new file mode 100644
index 00000000..e1c2a0a2
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-invoice.html
@@ -0,0 +1,305 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ InvoiceStatus The type Invoice status. RefundStatus Refund status list
+
+
+ Classes
+
+
+
+
+ Buyer Allows merchant to pass buyer related information in the invoice object BuyerProvidedInfo Information collected from the buyer during the process of paying an invoice. Initially this object is empty. Invoice ItemizedDetails Class ItemizedDetails MinerFees The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice. MinerFeesItem Class MinerFeesItem Refund Class Refund RefundInfo For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice. RefundWebhook Class RefundWebhook Shopper This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID. SupportedTransactionCurrencies Class SupportedTransactionCurrencies. The currencies that may be used to pay this invoice. SupportedTransactionCurrency Class SupportedTransactionCurrency
+The currency that may be used to pay this invoice. The values are objects with an "enabled" boolean and option. UniversalCodes Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-ledger.html b/docs/namespaces/bitpaysdk-model-ledger.html
new file mode 100644
index 00000000..e552e420
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-ledger.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ledger
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Buyer Ledger LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-payout.html b/docs/namespaces/bitpaysdk-model-payout.html
new file mode 100644
index 00000000..b5bc7e48
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-payout.html
@@ -0,0 +1,304 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-rate.html b/docs/namespaces/bitpaysdk-model-rate.html
new file mode 100644
index 00000000..642d7a72
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-rate.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Rate Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-settlement.html b/docs/namespaces/bitpaysdk-model-settlement.html
new file mode 100644
index 00000000..051dbd0a
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-settlement.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceData Object containing relevant information from the paid invoice. PayoutInfo Object containing the settlement info provided by the Merchant in his BitPay account settings. RefundInfo Object containing information about the refund. Settlement Settlement data object. SettlementLedgerEntry WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model-wallet.html b/docs/namespaces/bitpaysdk-model-wallet.html
new file mode 100644
index 00000000..1d6d7fa9
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model-wallet.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Wallet
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Currencies Details of what currencies support payments for this wallet CurrencyQr Object containing QR code related information to show for this payment method Wallet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-model.html b/docs/namespaces/bitpaysdk-model.html
new file mode 100644
index 00000000..f046a0d2
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-model.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Model
+
+
+
+ Table of Contents
+
+
+
+
+
+
+ Namespaces
+
+
+
+
+ Bill
+ Invoice
+ Ledger
+ Payout
+ Rate
+ Settlement
+ Wallet
+
+
+
+ Interfaces
+
+
+
+
+ Facade Facades are named collections of capabilities that can be granted,
+such as the ability to create invoices or grant refunds.
+
+
+ Classes
+
+
+
+
+ Currency Object containing currency information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-exceptions.html b/docs/namespaces/bitpaysdk-test-exceptions.html
new file mode 100644
index 00000000..2cf351ee
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-exceptions.html
@@ -0,0 +1,312 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-bill.html b/docs/namespaces/bitpaysdk-test-model-bill.html
new file mode 100644
index 00000000..8361c55c
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-bill.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillTest ItemTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-invoice.html b/docs/namespaces/bitpaysdk-test-model-invoice.html
new file mode 100644
index 00000000..859887a5
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-invoice.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-ledger.html b/docs/namespaces/bitpaysdk-test-model-ledger.html
new file mode 100644
index 00000000..49705945
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-ledger.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-payout.html b/docs/namespaces/bitpaysdk-test-model-payout.html
new file mode 100644
index 00000000..947c8bf6
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-payout.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-rate.html b/docs/namespaces/bitpaysdk-test-model-rate.html
new file mode 100644
index 00000000..b85762d3
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-rate.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RatesTest RateTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-settlement.html b/docs/namespaces/bitpaysdk-test-model-settlement.html
new file mode 100644
index 00000000..7e274995
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-settlement.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model-wallet.html b/docs/namespaces/bitpaysdk-test-model-wallet.html
new file mode 100644
index 00000000..ec975809
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model-wallet.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test-model.html b/docs/namespaces/bitpaysdk-test-model.html
new file mode 100644
index 00000000..cb63422a
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test-model.html
@@ -0,0 +1,326 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-test.html b/docs/namespaces/bitpaysdk-test.html
new file mode 100644
index 00000000..71f1c044
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-test.html
@@ -0,0 +1,320 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Test
+
+
+
+ Table of Contents
+
+
+
+
+
+
+ Namespaces
+
+
+
+
+ Exceptions
+ Model
+
+
+
+
+ Classes
+
+
+
+
+ ClientTest TokensTest
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-util-restcli.html b/docs/namespaces/bitpaysdk-util-restcli.html
new file mode 100644
index 00000000..53bbb091
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-util-restcli.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RESTcli
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk-util.html b/docs/namespaces/bitpaysdk-util.html
new file mode 100644
index 00000000..c3a7abfd
--- /dev/null
+++ b/docs/namespaces/bitpaysdk-util.html
@@ -0,0 +1,303 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Util
+
+
+
+ Table of Contents
+
+
+
+
+
+
+ Namespaces
+
+
+
+
+ RESTcli
+
+
+
+
+ Classes
+
+
+
+
+ JsonMapperFactory
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/bitpaysdk.html b/docs/namespaces/bitpaysdk.html
new file mode 100644
index 00000000..ff288093
--- /dev/null
+++ b/docs/namespaces/bitpaysdk.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPaySDK
+
+
+
+ Table of Contents
+
+
+
+
+
+
+ Namespaces
+
+
+
+
+ Client
+ Exceptions
+ Model
+ Util
+
+
+
+ Interfaces
+
+
+
+
+ Env Constants used throughout the SDK.
+
+
+ Classes
+
+
+
+
+ Client Client class to interact with the BitPay API. PosClient Client for handling POS facade specific calls. Tokens Token object used to store the tokens for the different facades.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html
new file mode 100644
index 00000000..a9271280
--- /dev/null
+++ b/docs/namespaces/default.html
@@ -0,0 +1,294 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ API Documentation
+
+
+
+ Table of Contents
+
+
+
+
+
+
+ Namespaces
+
+
+
+
+ BitPaySDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/Application.html b/docs/packages/Application.html
new file mode 100644
index 00000000..57c77635
--- /dev/null
+++ b/docs/packages/Application.html
@@ -0,0 +1,298 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Application
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ JsonMapperFactory
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Client.html b/docs/packages/BitPaySDK-Client.html
new file mode 100644
index 00000000..addcd2c8
--- /dev/null
+++ b/docs/packages/BitPaySDK-Client.html
@@ -0,0 +1,295 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ BillClient Handles interactions with the bill endpoints. InvoiceClient Handles interactions with the invoice endpoints. LedgerClient Handles interactions with the ledger endpoints. PayoutClient Handles interactions with the payout endpoints. PayoutRecipientsClient Handles interactions with the recipients endpoints. RateClient Handles interactions with the rate endpoints. RefundClient Handles interactions with the refund endpoints. SettlementClient Handles interactions with the settlement endpoints. TokenClient Handles interactions with the token endpoints. WalletClient Handles interactions with the wallet endpoints.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Exceptions.html b/docs/packages/BitPaySDK-Exceptions.html
new file mode 100644
index 00000000..0d989dca
--- /dev/null
+++ b/docs/packages/BitPaySDK-Exceptions.html
@@ -0,0 +1,295 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Bill.html b/docs/packages/BitPaySDK-Model-Bill.html
new file mode 100644
index 00000000..5f249071
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Bill.html
@@ -0,0 +1,304 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bill
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ BillStatus Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
+
+
+ Classes
+
+
+
+
+ Bill Item
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Currencies.html b/docs/packages/BitPaySDK-Model-Currencies.html
new file mode 100644
index 00000000..267d8a27
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Currencies.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Currencies
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Currencies Details of what currencies support payments for this wallet CurrencyQr Object containing QR code related information to show for this payment method Wallet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Invoice.html b/docs/packages/BitPaySDK-Model-Invoice.html
new file mode 100644
index 00000000..5ba2a619
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Invoice.html
@@ -0,0 +1,305 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Invoice
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+ Interfaces
+
+
+
+
+ InvoiceStatus The type Invoice status. RefundStatus Refund status list
+
+
+ Classes
+
+
+
+
+ Buyer Allows merchant to pass buyer related information in the invoice object BuyerProvidedInfo Information collected from the buyer during the process of paying an invoice. Initially this object is empty. Invoice ItemizedDetails Class ItemizedDetails MinerFees The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice. MinerFeesItem Class MinerFeesItem Refund Class Refund RefundInfo For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice. RefundWebhook Class RefundWebhook Shopper This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID. SupportedTransactionCurrencies Class SupportedTransactionCurrencies. The currencies that may be used to pay this invoice. SupportedTransactionCurrency Class SupportedTransactionCurrency
+The currency that may be used to pay this invoice. The values are objects with an "enabled" boolean and option. UniversalCodes Object containing wallet-specific URLs for payment protocol.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Ledger.html b/docs/packages/BitPaySDK-Model-Ledger.html
new file mode 100644
index 00000000..c44e4da7
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Ledger.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ledger
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Buyer Ledger LedgerEntry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Payout.html b/docs/packages/BitPaySDK-Model-Payout.html
new file mode 100644
index 00000000..d01084bd
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Payout.html
@@ -0,0 +1,304 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Rate.html b/docs/packages/BitPaySDK-Model-Rate.html
new file mode 100644
index 00000000..3cbe46f5
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Rate.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rate
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ Rate Rates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model-Settlement.html b/docs/packages/BitPaySDK-Model-Settlement.html
new file mode 100644
index 00000000..8e5e9cbe
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model-Settlement.html
@@ -0,0 +1,296 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settlement
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ InvoiceData Object containing relevant information from the paid invoice. PayoutInfo Object containing the settlement info provided by the Merchant in his BitPay account settings. RefundInfo Object containing information about the refund. Settlement Settlement data object. SettlementLedgerEntry WithHoldings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Model.html b/docs/packages/BitPaySDK-Model.html
new file mode 100644
index 00000000..3db2d994
--- /dev/null
+++ b/docs/packages/BitPaySDK-Model.html
@@ -0,0 +1,318 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Model
+
+
+
+ Table of Contents
+
+
+
+
+
+ Packages
+
+
+
+
+ Bill
+ Invoice
+ Ledger
+ Payout
+ Rate
+ Settlement
+ Currencies
+
+
+
+
+ Interfaces
+
+
+
+
+ Facade Facades are named collections of capabilities that can be granted,
+such as the ability to create invoices or grant refunds.
+
+
+ Classes
+
+
+
+
+ Currency Object containing currency information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Util-RESTcli.html b/docs/packages/BitPaySDK-Util-RESTcli.html
new file mode 100644
index 00000000..fc8d09eb
--- /dev/null
+++ b/docs/packages/BitPaySDK-Util-RESTcli.html
@@ -0,0 +1,300 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RESTcli
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ RESTcli Class RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK-Util.html b/docs/packages/BitPaySDK-Util.html
new file mode 100644
index 00000000..7ce1435a
--- /dev/null
+++ b/docs/packages/BitPaySDK-Util.html
@@ -0,0 +1,295 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Util
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ JsonMapperFactory RESTcli
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/BitPaySDK.html b/docs/packages/BitPaySDK.html
new file mode 100644
index 00000000..e5bdc43b
--- /dev/null
+++ b/docs/packages/BitPaySDK.html
@@ -0,0 +1,313 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BitPaySDK
+
+
+
+ Table of Contents
+
+
+
+
+
+ Packages
+
+
+
+
+ Client
+ Exceptions
+ Model
+ Util
+
+
+
+
+ Interfaces
+
+
+
+
+ Env Constants used throughout the SDK.
+
+
+ Classes
+
+
+
+
+ Client Client class to interact with the BitPay API. PosClient Client for handling POS facade specific calls. Tokens Token object used to store the tokens for the different facades.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/Bitpay.html b/docs/packages/Bitpay.html
new file mode 100644
index 00000000..40704b7b
--- /dev/null
+++ b/docs/packages/Bitpay.html
@@ -0,0 +1,302 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/Bitpaylight.html b/docs/packages/Bitpaylight.html
new file mode 100644
index 00000000..88f771bd
--- /dev/null
+++ b/docs/packages/Bitpaylight.html
@@ -0,0 +1,306 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bitpaylight
+
+
+
+ Table of Contents
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+
+ PosClient Class Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/packages/default.html b/docs/packages/default.html
new file mode 100644
index 00000000..93e9d074
--- /dev/null
+++ b/docs/packages/default.html
@@ -0,0 +1,294 @@
+
+
+
+
+ BitPay PHP SDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ API Documentation
+
+
+
+ Table of Contents
+
+
+
+
+
+ Packages
+
+
+
+
+ BitPaySDK
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html
new file mode 100644
index 00000000..751f6546
--- /dev/null
+++ b/docs/reports/deprecated.html
@@ -0,0 +1,162 @@
+
+
+
+
+ BitPay PHP SDK » Deprecated elements
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Deprecated
+
+
+
+ No deprecated elements have been found in this project.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reports/errors.html b/docs/reports/errors.html
new file mode 100644
index 00000000..4a2b3b51
--- /dev/null
+++ b/docs/reports/errors.html
@@ -0,0 +1,161 @@
+
+
+
+
+ BitPay PHP SDK » Compilation errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Errors
+
+
+
No errors have been found in this project.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reports/markers.html b/docs/reports/markers.html
new file mode 100644
index 00000000..a21743f7
--- /dev/null
+++ b/docs/reports/markers.html
@@ -0,0 +1,184 @@
+
+
+
+
+ BitPay PHP SDK » Markers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Markers
+
+
Table of Contents
+
+
+
+
RESTcli.php
+
+
+
+ Type
+ Line
+ Description
+
+
+
+
+ TODO
+ 415
+ Temporary fix for legacy response
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/examples/BitPay.config.json b/examples/BitPay.config.json
deleted file mode 100644
index f04ec579..00000000
--- a/examples/BitPay.config.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
- "BitPayConfiguration": {
- "Environment": "",
- "EnvConfig": {
- "Test": {
- "PrivateKeyPath": "",
- "PrivateKeySecret": "",
- "ApiTokens": {
- "merchant": "",
- "payroll": ""
- }
- }
- }
- }
-}
\ No newline at end of file
diff --git a/examples/BitPay.config.yml b/examples/BitPay.config.yml
deleted file mode 100644
index bf5b80cd..00000000
--- a/examples/BitPay.config.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-BitPayConfiguration:
- Environment: null
- EnvConfig:
- Test:
- PrivateKeyPath: null
- PrivateKeySecret: null
- ApiTokens:
- merchant: null
- payroll: null
- Prod:
- PrivateKeyPath: null
- ApiTokens:
- merchant: null
- payroll: null
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
new file mode 100644
index 00000000..544c2c80
--- /dev/null
+++ b/phpdoc.dist.xml
@@ -0,0 +1,27 @@
+
+
+ BitPay PHP SDK
+
+
+ docs
+
+
+
+
+
+ src
+
+
+ php
+
+ BitPaySDK
+
+
+
+
+
+
\ No newline at end of file
diff --git a/phpunit.xml b/phpunit.xml
new file mode 100644
index 00000000..1b46cbac
--- /dev/null
+++ b/phpunit.xml
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
+ ./test/unit
+
+
+ ./test/functional
+
+
+
+
+
+ ./src
+
+
+ ./src/BitPaySDK/Util/JsonMapper
+
+
+
diff --git a/ruleset.xml b/ruleset.xml
new file mode 100644
index 00000000..d510f668
--- /dev/null
+++ b/ruleset.xml
@@ -0,0 +1,5 @@
+
+
+ BitPay coding standard, based on PSR-12, temporarily excluding some rules.
+
+
diff --git a/setup/.gitignore b/setup/.gitignore
new file mode 100644
index 00000000..a9742772
--- /dev/null
+++ b/setup/.gitignore
@@ -0,0 +1,3 @@
+BitPay.config.json
+BitPay.config.yml
+PrivateKeyName.key
\ No newline at end of file
diff --git a/setup/BitPay.config-example.json b/setup/BitPay.config-example.json
new file mode 100644
index 00000000..0fb5584b
--- /dev/null
+++ b/setup/BitPay.config-example.json
@@ -0,0 +1,25 @@
+{
+ "BitPayConfiguration": {
+ "Environment": "Test",
+ "EnvConfig": {
+ "Test": {
+ "PrivateKeyPath": "null",
+ "PrivateKeySecret": "null",
+ "ApiTokens": {
+ "merchant": "null",
+ "payout": "null"
+ },
+ "proxy": null
+ },
+ "Prod": {
+ "PrivateKeyPath": null,
+ "PrivateKeySecret": null,
+ "ApiTokens": {
+ "merchant": null,
+ "payout": null
+ },
+ "proxy": null
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/setup/BitPay.config-example.yml b/setup/BitPay.config-example.yml
new file mode 100644
index 00000000..83d8fb03
--- /dev/null
+++ b/setup/BitPay.config-example.yml
@@ -0,0 +1,17 @@
+BitPayConfiguration:
+ Environment: Test
+ EnvConfig:
+ Test:
+ PrivateKeyPath: null
+ PrivateKeySecret: null
+ ApiTokens:
+ merchant: null
+ payout: null
+ proxy: null
+ Prod:
+ PrivateKeyPath: null
+ PrivateKeySecret: null
+ ApiTokens:
+ merchant: null
+ payout: null
+ proxy: null
diff --git a/examples/ConfigGenerator.php b/setup/ConfigGenerator.php
similarity index 91%
rename from examples/ConfigGenerator.php
rename to setup/ConfigGenerator.php
index 35f340ff..6cb00700 100644
--- a/examples/ConfigGenerator.php
+++ b/setup/ConfigGenerator.php
@@ -17,13 +17,15 @@
$privateKeyname = 'PrivateKeyName.key'; // Add here the name for your Private key
$generateMerchantToken = true; // Set to true to generate a token for the Merchant facade
-$generatePayrollToken = false; // Set to true to generate a token for the Payroll facade (Request to Support if you need it)
+$generatePayoutToken = true; // Set to true to generate a token for the Payout facade (Request to Support if you need it)
$yourMasterPassword = 'YourMasterPassword'; //Will be used to encrypt your PrivateKey
$generateJSONfile = true; // Set to true to generate the Configuration File in Json format
$generateYMLfile = true; // Set to true to generate the Configuration File in Yml format
+$proxy = null; // The url of your proxy to forward requests through. Example: http://********.com:3128
+
/**
* WARNING: DO NOT CHANGE ANYTHING FROM HERE ON
@@ -82,7 +84,7 @@
$merchantToken = null;
-$payrolToken = null;
+$payoutToken = null;
/**
@@ -138,12 +140,12 @@
}
/**
- * Repeat the process for the Payroll facade
+ * Repeat the process for the Payout facade
*/
- if ($generatePayrollToken) {
+ if ($generatePayoutToken) {
- $facade = 'payroll';
+ $facade = 'payout';
$postData = json_encode(
[
@@ -178,12 +180,12 @@
* 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.
**/
- $payrolToken = $resultData['data'][0]['token'];
- echo "\r\nPayroll Facade\r\n";
+ $payoutToken = $resultData['data'][0]['token'];
+ echo "\r\nPayout Facade\r\n";
echo " -> Pairing Code: ";
echo $resultData['data'][0]['pairingCode'];
echo "\r\n -> Token: ";
- echo $payrolToken;
+ echo $payoutToken;
echo "\r\n";
/** End of request **/
@@ -209,16 +211,18 @@
"PrivateKeySecret" => $isProd ? null : $yourMasterPassword,
"ApiTokens" => [
"merchant" => $isProd ? null : $merchantToken,
- "payroll" => $isProd ? null : $payrolToken,
+ "payout" => $isProd ? null : $payoutToken,
],
+ "Proxy" => $proxy,
],
'Prod' => [
"PrivateKeyPath" => $isProd ? __DIR__."/".$privateKeyname : null,
"PrivateKeySecret" => $isProd ? $yourMasterPassword : null,
"ApiTokens" => [
"merchant" => $isProd ? $merchantToken : null,
- "payroll" => $isProd ? $payrolToken : null,
+ "payout" => $isProd ? $payoutToken : null,
],
+ "Proxy" => $proxy,
],
],
],
diff --git a/src/BitPaySDK/Client.php b/src/BitPaySDK/Client.php
index 7cb3a2d8..5d3f9dc1 100644
--- a/src/BitPaySDK/Client.php
+++ b/src/BitPaySDK/Client.php
@@ -1,241 +1,260 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
*/
class Client
{
- /**
- * @var Config
- */
- protected $_configuration;
-
- /**
- * @var string
- */
- protected $_env;
-
- /**
- * @var Tokens
- */
- protected $_tokenCache; // {facade, token}
-
- /**
- * @var string
- */
- protected $_configFilePath;
-
- /**
- * @var PrivateKey
- */
- protected $_ecKey;
-
- /**
- * @var RESTcli
- */
- protected $_RESTcli = null;
-
- /**
- * @var RESTcli
- */
- protected $_currenciesInfo = null;
+ protected Tokens $tokenCache;
+ protected RESTcli $restCli;
/**
* Client constructor.
*/
- public function __construct()
+ public function __construct(RESTcli $restCli, Tokens $tokenCache)
{
+ $this->restCli = $restCli;
+ $this->tokenCache = $tokenCache;
}
/**
- * Static constructor / factory
+ * Constructor for use if the keys and SIN are managed by this library.
+ *
+ * @param string $environment Target environment. Options: Env.Test / Env.Prod
+ * @param string $privateKey Private Key file path or the HEX value.
+ * @param Tokens $tokens Tokens containing the available tokens.
+ * @param string|null $privateKeySecret Private Key encryption password.
+ * @param string|null $proxy The url of your proxy to forward requests through. Example:
+ * http://********.com:3128
+ * @return Client
+ * @throws BitPayException
*/
- public static function create()
- {
- $instance = new self();
+ public static function createWithData(
+ string $environment,
+ string $privateKey,
+ Tokens $tokens,
+ ?string $privateKeySecret = null,
+ ?string $proxy = null
+ ): Client {
+ try {
+ $key = self::initKeys($privateKey, $privateKeySecret);
+
+ $restCli = new RESTcli($environment, $key, $proxy);
+ $tokenCache = $tokens;
- return $instance;
+ return new Client($restCli, $tokenCache);
+ } catch (Exception $e) {
+ throw new BitPayException("failed to initialize BitPay Client (Config) : " . $e->getMessage());
+ }
}
/**
* Constructor for use if the keys and SIN are managed by this library.
*
- * @param $environment String Target environment. Options: Env.Test / Env.Prod
- * @param $privateKey String Private Key file path or the HEX value.
- * @param $tokens Tokens containing the available tokens.
- * @param $privateKeySecret String|null Private Key encryption password.
+ * @param string $configFilePath The path to the configuration file.
* @return Client
- * @throws BitPayException BitPayException class
+ * @throws BitPayException BitPayException class
*/
- public function withData($environment, $privateKey, Tokens $tokens, $privateKeySecret = null)
+ public static function createWithFile(string $configFilePath): Client
{
try {
- $this->_env = $environment;
- $this->buildConfig($privateKey, $tokens, $privateKeySecret);
- $this->initKeys();
- $this->init();
+ $configData = self::getConfigData($configFilePath);
+ $env = $configData["BitPayConfiguration"]["Environment"];
+ $config = $configData["BitPayConfiguration"]["EnvConfig"][$env];
+
+ $key = self::initKeys($config['PrivateKeyPath'], $config['PrivateKeySecret']);
- return $this;
+ $restCli = new RESTcli($env, $key, $config['proxy']);
+ $tokenCache = new Tokens($config['ApiTokens']['merchant'], $config['ApiTokens']['payout']);
+
+ return new Client($restCli, $tokenCache);
} catch (Exception $e) {
- throw new BitPayException("failed to initialize BitPay Client (Config) : ".$e->getMessage());
+ throw new BitPayException("failed to initialize BitPay Client (Config) : " . $e->getMessage());
}
}
/**
- * Constructor for use if the keys and SIN are managed by this library.
+ * Get Tokens.
*
- * @param $configFilePath String The path to the configuration file.
- * @return Client
- * @throws BitPayException BitPayException class
+ * @return array
+ * @throws BitPayException
+ * @throws \JsonException
*/
- public function withFile($configFilePath)
+ public function getTokens(): array
{
- try {
- $this->_configFilePath = $configFilePath;
- $this->getConfig();
- $this->initKeys();
- $this->init();
+ $tokenClient = $this->getTokenClient();
- return $this;
- } catch (Exception $e) {
- throw new BitPayException("failed to initialize BitPay Client (Config) : ".$e->getMessage());
- }
+ return $tokenClient->getTokens();
}
/**
* Create a BitPay invoice.
*
- * @param $invoice Invoice An Invoice object with request parameters defined.
- * @param $facade string The facade used to create it.
- * @param $signRequest bool Signed request.
- * @return $invoice Invoice A BitPay generated Invoice object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/create-an-invoice Create an Invoice
+ *
+ * @param Invoice $invoice An Invoice object with request parameters defined.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Invoice
+ * @throws BitPayException
*/
public function createInvoice(
Invoice $invoice,
- string $facade = Facade::Merchant,
+ string $facade = Facade::MERCHANT,
bool $signRequest = true
): Invoice {
- try {
- $invoice->setToken($this->_tokenCache->getTokenByFacade($facade));
- $invoice->setGuid(Util::guid());
+ $invoiceClient = $this->getInvoiceClient();
- $responseJson = $this->_RESTcli->post("invoices", $invoice->toArray(), $signRequest);
- } catch (Exception $e) {
- throw new InvoiceCreationException("failed to serialize Invoice object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $invoice = $mapper->map(
- json_decode($responseJson),
- new Invoice()
- );
+ return $invoiceClient->create($invoice, $facade, $signRequest);
+ }
- } catch (Exception $e) {
- throw new InvoiceCreationException(
- "failed to deserialize BitPay server response (Invoice) : ".$e->getMessage());
- }
+ /**
+ * Update a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/update-an-invoice Update an Invoice
+ *
+ * @param string $invoiceId The id of the invoice to updated.
+ * @param string|null $buyerSms The buyer's cell number.
+ * @param string|null $smsCode The buyer's received verification code.
+ * @param string|null $buyerEmail The buyer's email address.
+ * @param bool $autoVerify Skip the user verification on sandbox ONLY.
+ * @return Invoice
+ * @throws BitPayException
+ * @throws InvoiceUpdateException
+ */
+ public function updateInvoice(
+ string $invoiceId,
+ ?string $buyerSms,
+ ?string $smsCode,
+ ?string $buyerEmail,
+ bool $autoVerify = false
+ ): Invoice {
+ $invoiceClient = $this->getInvoiceClient();
- return $invoice;
+ return $invoiceClient->update($invoiceId, $buyerSms, $smsCode, $buyerEmail, $autoVerify);
}
/**
* Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
* authorized for the specified facade (the public facade requires no authorization).
*
- * @param $invoiceId string The id of the invoice to retrieve.
- * @param $facade string The facade used to create it.
- * @param $signRequest bool Signed request.
- * @return Invoice A BitPay Invoice object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid Retrieve an Invoice by GUID
+ *
+ * @param string $invoiceId The id of the invoice to retrieve.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Invoice
+ * @throws InvoiceQueryException
*/
public function getInvoice(
string $invoiceId,
- string $facade = Facade::Merchant,
+ string $facade = Facade::MERCHANT,
bool $signRequest = true
): Invoice {
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade($facade);
-
- $responseJson = $this->_RESTcli->get("invoices/".$invoiceId, $params, $signRequest);
- } catch (Exception $e) {
- throw new InvoiceQueryException("failed to serialize Invoice object : ".$e->getMessage());
- }
+ $invoiceClient = $this->getInvoiceClient();
- try {
- $mapper = new JsonMapper();
- $invoice = $mapper->map(
- json_decode($responseJson),
- new Invoice()
- );
+ return $invoiceClient->get($invoiceId, $facade, $signRequest);
+ }
- } catch (Exception $e) {
- throw new InvoiceQueryException(
- "failed to deserialize BitPay server response (Invoice) : ".$e->getMessage());
- }
+ /**
+ * Retrieve a BitPay invoice by guid using the specified facade.
+ * The client must have been previously authorized for the specified facade.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-an-invoice-by-guid Retrieve an Invoice by GUID
+ *
+ * @param string $guid The guid of the invoice to retrieve.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Invoice
+ * @throws InvoiceQueryException
+ *
+ */
+ public function getInvoiceByGuid(
+ string $guid,
+ string $facade = Facade::MERCHANT,
+ bool $signRequest = true
+ ): Invoice {
+ $invoiceClient = $this->getInvoiceClient();
- return $invoice;
+ return $invoiceClient->getByGuid($guid, $facade, $signRequest);
}
/**
* Retrieve a collection of BitPay invoices.
*
- * @param $dateStart string The start of the date window to query for invoices. Format YYYY-MM-DD.
- * @param $dateEnd string The end of the date window to query for invoices. Format YYYY-MM-DD.
- * @param $status string|null The invoice status you want to query on.
- * @param $orderId string|null The optional order id specified at time of invoice creation.
- * @param $limit int|null Maximum results that the query will return (useful for paging results).
- * @param $offset int|null Number of results to offset (ex. skip 10 will give you results starting with the 11th
- * result).
- * @return array A list of BitPay Invoice objects.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-invoices-filtered-by-query
+ * Retrieve Invoices Filtered by Query
+ *
+ *
+ * @param string $dateStart The start of the date window to query for invoices. Format YYYY-MM-DD.
+ * @param string $dateEnd The end of the date window to query for invoices. Format YYYY-MM-DD.
+ * @param string|null $status The invoice status you want to query on.
+ * @param string|null $orderId The optional order id specified at time of invoice creation.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results starting
+ * with the 11th result).
+ * @return Invoice[]
+ * @throws BitPayException
*/
public function getInvoices(
string $dateStart,
@@ -245,600 +264,673 @@ public function getInvoices(
int $limit = null,
int $offset = null
): array {
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
- $params["dateStart"] = $dateStart;
- $params["dateEnd"] = $dateEnd;
- if ($status) {
- $params["status"] = $status;
- }
- if ($status) {
- $params["orderId"] = $orderId;
- }
- if ($status) {
- $params["limit"] = $limit;
- }
- if ($status) {
- $params["offset"] = $offset;
- }
+ $invoiceClient = $this->getInvoiceClient();
- $responseJson = $this->_RESTcli->get("invoices", $params);
- } catch (Exception $e) {
- throw new InvoiceQueryException("failed to serialize Invoice object : ".$e->getMessage());
- }
+ return $invoiceClient->getInvoices($dateStart, $dateEnd, $status, $orderId, $limit, $offset);
+ }
- try {
- $mapper = new JsonMapper();
- $invoices = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Invoice\Invoice'
- );
+ /**
+ * Request a BitPay Invoice Webhook.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-an-event-token Retrieve an Event Token
+ *
+ * @param string $invoiceId A BitPay invoice ID.
+ * @return bool True if the webhook was successfully requested, false otherwise.
+ * @throws InvoiceQueryException
+ * @throws BitPayException
+ */
+ public function requestInvoiceNotification(string $invoiceId): bool
+ {
+ $invoiceClient = $this->getInvoiceClient();
- } catch (Exception $e) {
- throw new InvoiceQueryException(
- "failed to deserialize BitPay server response (Invoice) : ".$e->getMessage());
- }
+ return $invoiceClient->requestNotification($invoiceId);
+ }
- return $invoices;
+ /**
+ * Cancel a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/cancel-an-invoice Cancel an Invoice
+ *
+ * @param string $invoiceId The id of the invoice to updated.
+ * @return Invoice $invoice Cancelled invoice object.
+ * @throws InvoiceCancellationException
+ * @throws BitPayException
+ */
+ public function cancelInvoice(
+ string $invoiceId,
+ bool $forceCancel = false
+ ): Invoice {
+ $invoiceClient = $this->getInvoiceClient();
+
+ return $invoiceClient->cancel($invoiceId, $forceCancel);
+ }
+
+ /**
+ * Cancel a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/cancel-an-invoice-by-guid Cancel an Invoice by GUID
+ *
+ * @param string $guid The guid of the invoice to cancel.
+ * @return Invoice $invoice Cancelled invoice object.
+ * @throws InvoiceCancellationException
+ * @throws BitPayException
+ */
+ public function cancelInvoiceByGuid(
+ string $guid,
+ bool $forceCancel = false
+ ): Invoice {
+ $invoiceClient = $this->getInvoiceClient();
+
+ return $invoiceClient->cancelByGuid($guid, $forceCancel);
}
/**
- * Create a BitPay refund.
- *
- * @param $invoice Invoice A BitPay invoice object for which a refund request should be made. Must have
- * been obtained using the merchant facade.
- * @param $refundEmail string The email of the buyer to which the refund email will be sent
- * @param $amount float The amount of money to refund. If zero then a request for 100% of the invoice
- * value is created.
- * @param $currency string The three digit currency code specifying the exchange rate to use when
- * calculating the refund bitcoin amount. If this value is "BTC" then no exchange rate
- * calculation is performed.
- * @return bool True if the refund was successfully canceled, false otherwise.
- * @throws BitPayException BitPayException class
+ * Pay an invoice with a mock transaction
+ *
+ * @param string $invoiceId The id of the invoice.
+ * @param string $status Status the invoice will become. Acceptable values are confirmed (default) and complete.
+ * @return Invoice $invoice Invoice object.
+ * @throws InvoicePaymentException
+ * @throws BitPayException
+ */
+ public function payInvoice(
+ string $invoiceId,
+ string $status = 'confirmed'
+ ): Invoice {
+ $invoiceClient = $this->getInvoiceClient();
+
+ return $invoiceClient->pay($invoiceId, $status);
+ }
+
+ /**
+ * Create a refund for a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/create-a-refund-request Create a Refund Request
+ *
+ * @param string $invoiceId The BitPay invoice Id having the associated refund to be created.
+ * @param float $amount Amount to be refunded in the currency indicated.
+ * @param string $currency Reference currency used for the refund, usually the same as the currency used
+ * to create the invoice.
+ * @param bool $preview Whether to create the refund request as a preview (which will not be acted on
+ * until status is updated)
+ * @param bool $immediate Whether funds should be removed from merchant ledger immediately on submission
+ * or at time of processing
+ * @param bool $buyerPaysRefundFee Whether the buyer should pay the refund fee (default is merchant)
+ * @return Refund $refund An updated Refund Object
+ * @throws RefundCreationException RefundCreationException class
+ * @throws BitPayException BitPayException class
*/
public function createRefund(
- Invoice $invoice,
- string $refundEmail,
+ string $invoiceId,
float $amount,
- string $currency
- ): bool {
- try {
- $refund = new Refund($refundEmail, $amount, $currency, $invoice->getToken());
- $refund->setGuid(Util::guid());
+ string $currency,
+ bool $preview = false,
+ bool $immediate = false,
+ bool $buyerPaysRefundFee = false,
+ ?string $guid = null
+ ): Refund {
+ $refundClient = $this->getRefundClient();
- $responseJson = $this->_RESTcli->post("invoices/".$invoice->getId()."/refunds", $refund->toArray());
- } catch (Exception $e) {
- throw new RefundCreationException("failed to serialize Refund object : ".$e->getMessage());
- }
+ return $refundClient->create($invoiceId, $amount, $currency, $preview, $immediate, $buyerPaysRefundFee, $guid);
+ }
- try {
- $result = json_decode($responseJson)->success;
+ /**
+ * Update the status of a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/update-a-refund-request Update a Refund Request
+ *
+ * @param string $refundId BitPay refund ID.
+ * @param string $status The new status for the refund to be updated.
+ * @return Refund $refund Refund A BitPay generated Refund object.
+ * @throws RefundUpdateException
+ * @throws BitPayException
+ */
+ public function updateRefund(
+ string $refundId,
+ string $status
+ ): Refund {
+ $refundClient = $this->getRefundClient();
- } catch (Exception $e) {
- throw new RefundCreationException(
- "failed to deserialize BitPay server response (Refund) : ".$e->getMessage());
- }
+ return $refundClient->update($refundId, $status);
+ }
+
+ /**
+ * Update the status of a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/update-a-refund-by-guid-request Update a Refund by GUID Request
+ *
+ * @param string $guid BitPay refund Guid.
+ * @param string $status The new status for the refund to be updated.
+ * @return Refund $refund Refund A BitPay generated Refund object.
+ * @throws RefundUpdateException
+ * @throws BitPayException
+ */
+ public function updateRefundByGuid(
+ string $guid,
+ string $status
+ ): Refund {
+ $refundClient = $this->getRefundClient();
- return $result;
+ return $refundClient->updateByGuid($guid, $status);
}
/**
* Retrieve all refund requests on a BitPay invoice.
*
- * @param $invoice Invoice The BitPay invoice having the associated refunds.
- * @return array A array of BitPay refund object with the associated Refund object updated.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-refunds-of-an-invoice Retrieve Refunds of an Invoice
+ *
+ * @param string $invoiceId The BitPay invoice object having the associated refunds.
+ * @return Refund[]
+ * @throws RefundQueryException
+ * @throws BitPayException
*/
public function getRefunds(
- Invoice $invoice
+ string $invoiceId
): array {
- try {
- $params = [];
- $params["token"] = $invoice->getToken();
-
- $responseJson = $this->_RESTcli->get("invoices/".$invoice->getId()."/refunds", $params);
- } catch (Exception $e) {
- throw new RefundQueryException("failed to serialize refund object : ".$e->getMessage());
- }
+ $refundClient = $this->getRefundClient();
- try {
- $mapper = new JsonMapper();
- $refunds = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Invoice\Refund'
- );
-
- } catch (Exception $e) {
- throw new RefundQueryException(
- "failed to deserialize BitPay server response (Refund) : ".$e->getMessage());
- }
-
- return $refunds;
+ return $refundClient->getRefunds($invoiceId);
}
/**
* Retrieve a previously made refund request on a BitPay invoice.
*
- * @param $invoice Invoice The BitPay invoice having the associated refund.
- * @param $refundId string The refund id for the refund to be updated with new status.
- * @return Refund A BitPay refund object with the associated Refund object updated.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-a-refund-request Retrieve a Refund Request
+ *
+ * @param string $refundId The BitPay refund ID.
+ * @return Refund $refund BitPay Refund object with the associated Refund object.
+ * @throws RefundQueryException
+ * @throws BitPayException
*/
public function getRefund(
- Invoice $invoice,
string $refundId
): Refund {
- try {
- $params = [];
- $params["token"] = $invoice->getToken();
+ $refundClient = $this->getRefundClient();
- $responseJson = $this->_RESTcli->get("invoices/".$invoice->getId()."/refunds/".$refundId, $params);
- } catch (Exception $e) {
- throw new RefundQueryException("failed to serialize refund object : ".$e->getMessage());
- }
+ return $refundClient->get($refundId);
+ }
- try {
- $mapper = new JsonMapper();
- $Refund = $mapper->map(
- json_decode($responseJson),
- new Refund()
- );
+ /**
+ * Retrieve a previously made refund request on a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-a-refund-by-guid-request Retrieve a Refund by GUID Request
+ *
+ * @param string $guid The BitPay refund Guid
+ * @return Refund BitPay Refund object with the associated Refund object.
+ * @throws BitPayException
+ * @throws RefundQueryException
+ */
+ public function getRefundByGuid(string $guid): Refund
+ {
+ $refundClient = $this->getRefundClient();
- } catch (Exception $e) {
- throw new RefundQueryException(
- "failed to deserialize BitPay server response (Refund) : ".$e->getMessage());
- }
+ return $refundClient->getByGuid($guid);
+ }
+
+ /**
+ * Send a refund notification.
+ *
+ * @see https://developer.bitpay.com/reference/request-a-refund-notification-to-be-resent
+ * Request a Refund Notification to be Resent
+ *
+ * @param string $refundId A BitPay refund ID.
+ * @return bool $result An updated Refund Object
+ * @throws RefundCreationException
+ * @throws BitPayException
+ */
+ public function sendRefundNotification(string $refundId): bool
+ {
+ $refundClient = $this->getRefundClient();
- return $Refund;
+ return $refundClient->sendNotification($refundId);
}
/**
* Cancel a previously submitted refund request on a BitPay invoice.
*
- * @param $invoiceId string The refund id for the refund to be canceled.
- * @param $refund Refund The BitPay invoice having the associated refund to be canceled. Must have been obtained
- * using the merchant facade.
- * @return bool True if the refund was successfully canceled, false otherwise.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/cancel-a-refund-request Cancel a Refund Request
+ *
+ * @param string $refundId The refund Id for the refund to be canceled.
+ * @return Refund $refund Cancelled refund Object.
+ * @throws RefundCancellationException
+ * @throws BitPayException
*/
- public function cancelRefund(string $invoiceId, Refund $refund): bool
+ public function cancelRefund(string $refundId): Refund
{
- try {
- $params = [];
- $params["token"] = $refund->getToken();
+ $refundClient = $this->getRefundClient();
- $responseJson = $this->_RESTcli->delete("invoices/".$invoiceId."/refunds/".$refund->getId(), $params);
- } catch (Exception $e) {
- throw new PayoutCancellationException("failed to serialize server object : ".$e->getMessage());
- }
-
- try {
- $result = strtolower(trim($responseJson, '"')) === "success";
+ return $refundClient->cancel($refundId);
+ }
- } catch (Exception $e) {
- throw new PayoutCancellationException(
- "failed to deserialize BitPay server response (Refund) : ".$e->getMessage());
- }
+ /**
+ * Cancel a previously submitted refund request on a BitPay invoice.
+ *
+ * @see https://developer.bitpay.com/reference/cancel-a-refund-by-guid-request
+ * Cancel a Refund by GUID Request
+ *
+ * @param string $guid The refund Guid for the refund to be canceled.
+ * @return Refund $refund Cancelled refund Object.
+ * @throws RefundCancellationException
+ * @throws BitPayException
+ */
+ public function cancelRefundByGuid(string $guid): Refund
+ {
+ $refundClient = $this->getRefundClient();
- return $result;
+ return $refundClient->cancelByGuid($guid);
}
/**
- * Create a BitPay Bill.
+ * Retrieve all supported wallets.
*
- * @param $bill string A Bill object with request parameters defined.
- * @param $facade string The facade used to create it.
- * @param $signRequest bool Signed request.
- * @return Bill A BitPay generated Bill object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-the-supported-wallets
+ * Retrieve the Supported Wallets
+ *
+ * @return Wallet[]
+ * @throws WalletQueryException
+ * @throws BitPayException
*/
- public function createBill(Bill $bill, string $facade = Facade::Merchant, bool $signRequest = true): Bill
+ public function getSupportedWallets(): array
{
- try {
- $bill->setToken($this->_tokenCache->getTokenByFacade($facade));
-
- $responseJson = $this->_RESTcli->post("bills", $bill->toArray(), $signRequest);
- } catch (Exception $e) {
- throw new BillCreationException("failed to serialize Bill object : ".$e->getMessage());
- }
+ $walletClient = $this->getWalletClient();
- try {
- $mapper = new JsonMapper();
- $bill = $mapper->map(
- json_decode($responseJson),
- new Bill()
- );
+ return $walletClient->getSupportedWallets();
+ }
- } catch (Exception $e) {
- throw new BillCreationException(
- "failed to deserialize BitPay server response (Bill) : ".$e->getMessage());
- }
+ /**
+ * Create a BitPay Bill.
+ *
+ * @see https://developer.bitpay.com/reference/create-a-bill Create a Bill
+ *
+ * @param Bill $bill A Bill object with request parameters defined.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Bill
+ * @throws BitPayException
+ */
+ public function createBill(Bill $bill, string $facade = Facade::MERCHANT, bool $signRequest = true): Bill
+ {
+ $billClient = $this->getBillClient();
- return $bill;
+ return $billClient->create($bill, $facade, $signRequest);
}
/**
* Retrieve a BitPay bill by bill id using the specified facade.
*
+ * @see https://developer.bitpay.com/reference/retrieve-a-bill Retrieve a Bill
+ *
* @param $billId string The id of the bill to retrieve.
* @param $facade string The facade used to retrieve it.
* @param $signRequest bool Signed request.
- * @return Bill A BitPay Bill object.
- * @throws BitPayException BitPayException class
+ * @return Bill
+ * @throws BitPayException
*/
- public function getBill(string $billId, string $facade = Facade::Merchant, bool $signRequest = true): Bill
+ public function getBill(string $billId, string $facade = Facade::MERCHANT, bool $signRequest = true): Bill
{
+ $billClient = $this->getBillClient();
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade($facade);
-
- $responseJson = $this->_RESTcli->get("bills/".$billId, $params, $signRequest);
- } catch (Exception $e) {
- throw new BillQueryException("failed to serialize Bill object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $bill = $mapper->map(
- json_decode($responseJson),
- new Bill()
- );
-
- } catch (Exception $e) {
- throw new BillQueryException(
- "failed to deserialize BitPay server response (Bill) : ".$e->getMessage());
- }
-
- return $bill;
+ return $billClient->get($billId, $facade, $signRequest);
}
/**
* Retrieve a collection of BitPay bills.
*
- * @param $status string|null The status to filter the bills.
- * @return array A list of BitPay Bill objects.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-bills-by-status Retrieve Bills by Status
+ *
+ * @param string|null The status to filter the bills.
+ * @return Bill[]
+ * @throws BitPayException
*/
public function getBills(string $status = null): array
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
- if ($status) {
- $params["status"] = $status;
- }
+ $billClient = $this->getBillClient();
- $responseJson = $this->_RESTcli->get("bills", $params);
- } catch (Exception $e) {
- throw new BillQueryException("failed to serialize Bill object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $bills = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Bill\Bill'
- );
-
- } catch (Exception $e) {
- throw new BillQueryException(
- "failed to deserialize BitPay server response (Bill) : ".$e->getMessage());
- }
-
- return $bills;
+ return $billClient->getBills($status);
}
/**
* Update a BitPay Bill.
*
- * @param $bill Bill A Bill object with the parameters to update defined.
- * @param $billId string $billIdThe Id of the Bill to update.
- * @return Bill An updated Bill object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/update-a-bill Update a Bill
+ *
+ * @param Bill $bill A Bill object with the parameters to update defined.
+ * @param string $billId The Id of the Bill to update.
+ * @return Bill
+ * @throws BitPayException
*/
public function updateBill(Bill $bill, string $billId): Bill
{
- try {
- $billToken = $this->getBill($bill->getId())->getToken();
- $bill->setToken($billToken);
-
- $responseJson = $this->_RESTcli->update("bills/".$billId, $bill->toArray());
- } catch (Exception $e) {
- throw new BillUpdateException("failed to serialize Bill object : ".$e->getMessage());
- }
+ $billClient = $this->getBillClient();
- try {
- $mapper = new JsonMapper();
- $bill = $mapper->map(
- json_decode($responseJson),
- $bill
- );
-
- } catch (Exception $e) {
- throw new BillUpdateException("failed to deserialize BitPay server response (Bill) : ".$e->getMessage());
- }
-
- return $bill;
+ return $billClient->update($bill, $billId);
}
/**
* Deliver a BitPay Bill.
*
- * @param $billId string The id of the requested bill.
- * @param $billToken string The token of the requested bill.
- * @param $signRequest bool Allow unsigned request
- * @return string A response status returned from the API.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/deliver-a-bill-via-email Deliver a Bill Via Email
+ *
+ * @param string $billId The id of the requested bill.
+ * @param string $billToken The token of the requested bill.
+ * @param bool $signRequest Allow unsigned request
+ * @return bool
+ * @throws BitPayException
*/
- public function deliverBill(string $billId, string $billToken, bool $signRequest = true): string
+ public function deliverBill(string $billId, string $billToken, bool $signRequest = true): bool
{
- try {
- $responseJson = $this->_RESTcli->post(
- "bills/".$billId."/deliveries", ['token' => $billToken], $signRequest);
- } catch (Exception $e) {
- throw new BillDeliveryException("failed to serialize Bill object : ".$e->getMessage());
- }
+ $billClient = $this->getBillClient();
- try {
- $result = str_replace("\"", "", $responseJson);
- } catch (Exception $e) {
- throw new BillDeliveryException("failed to deserialize BitPay server response (Bill) : ".$e->getMessage());
- }
-
- return $result;
+ return $billClient->deliver($billId, $billToken, $signRequest);
}
/**
- * Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
+ * Retrieve the exchange rate table maintained by BitPay.
+ * @see https://bitpay.com/bitcoin-exchange-rates
*
- * @return Rates A Rates object populated with the BitPay exchange rate table.
- * @throws BitPayException BitPayException class
+ * @return Rates
+ * @throws BitPayException
*/
public function getRates(): Rates
{
- try {
- $responseJson = $this->_RESTcli->get("rates", null, false);
- } catch (Exception $e) {
- throw new RateQueryException("failed to serialize Rates object : ".$e->getMessage());
- }
+ $rateClient = $this->getRateClient();
- try {
- $mapper = new JsonMapper();
- $rates = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Rate\Rate'
- );
+ return $rateClient->getRates();
+ }
- } catch (Exception $e) {
- throw new RateQueryException(
- "failed to deserialize BitPay server response (Rates) : ".$e->getMessage());
- }
+ /**
+ * Retrieve all the rates for a given cryptocurrency
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-all-the-rates-for-a-given-cryptocurrency
+ * Retrieve all the rates for a given cryptocurrency
+ *
+ * @param string $baseCurrency The cryptocurrency for which you want to fetch the rates.
+ * Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+ * @return Rates A Rates object populated with the currency rates for the requested baseCurrency.
+ * @throws BitPayException
+ */
+ public function getCurrencyRates(string $baseCurrency): Rates
+ {
+ $rateClient = $this->getRateClient();
- return new Rates($rates, $this);
+ return $rateClient->getCurrencyRates($baseCurrency);
}
/**
- * Retrieve a list of ledgers by date range using the merchant facade.
+ * Retrieve the rate for a cryptocurrency / fiat pair
*
- * @param $currency string The three digit currency string for the ledger to retrieve.
- * @param $startDate string The first date for the query filter.
- * @param $endDate string The last date for the query filter.
- * @return Ledger A Ledger object populated with the BitPay ledger entries list.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-the-rates-for-a-cryptocurrency-fiat-pair
+ * Retrieve the rates for a cryptocurrency / fiat pair
+ *
+ * @param string $baseCurrency The cryptocurrency for which you want to fetch the fiat-equivalent rate.
+ * Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+ * @param string $currency The fiat currency for which you want to fetch the baseCurrency rate
+ * @return Rate A Rate object populated with the currency rate for the requested baseCurrency.
+ * @throws BitPayException
*/
- public function getLedger(string $currency, string $startDate, string $endDate): Ledger
+ public function getCurrencyPairRate(string $baseCurrency, string $currency): Rate
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
- if ($currency) {
- $params["currency"] = $currency;
- }
- if ($currency) {
- $params["startDate"] = $startDate;
- }
- if ($currency) {
- $params["endDate"] = $endDate;
- }
+ $rateClient = $this->getRateClient();
- $responseJson = $this->_RESTcli->get("ledgers/".$currency, $params);
- } catch (Exception $e) {
- throw new LedgerQueryException("failed to serialize Ledger object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $ledger = $mapper->map(
- json_decode($responseJson),
- new Ledger()
- );
+ return $rateClient->getCurrencyPairRate($baseCurrency, $currency);
+ }
- } catch (Exception $e) {
- throw new LedgerQueryException(
- "failed to deserialize BitPay server response (Ledger) : ".$e->getMessage());
- }
+ /**
+ * Retrieve a list of ledgers by date range using the merchant facade.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-ledger-entries Retrieve Ledger Entries
+ *
+ * @param string $currency The three digit currency string for the ledger to retrieve.
+ * @param string $startDate The first date for the query filter.
+ * @param string $endDate The last date for the query filter.
+ * @return LedgerEntry[] A Ledger object populated with the BitPay ledger entries list.
+ * @throws BitPayException
+ */
+ public function getLedgerEntries(string $currency, string $startDate, string $endDate): array
+ {
+ $ledgerClient = $this->getLedgerClient();
- return $ledger;
+ return $ledgerClient->get($currency, $startDate, $endDate);
}
/**
* Retrieve a list of ledgers using the merchant facade.
*
- * @return array A list of Ledger objects populated with the currency and current balance of each one.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-account-balances Retrieve Account Balances
+ *
+ * @return Ledger[] A list of Ledger objects populated with the currency and current balance of each one.
+ * @throws BitPayException
*/
public function getLedgers(): array
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
+ $ledgerClient = $this->getLedgerClient();
- $responseJson = $this->_RESTcli->get("ledgers", $params);
- } catch (Exception $e) {
- throw new LedgerQueryException("failed to serialize Ledger object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $ledgers = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Ledger\Ledger'
- );
+ return $ledgerClient->getLedgers();
+ }
- } catch (Exception $e) {
- throw new LedgerQueryException(
- "failed to deserialize BitPay server response (Ledger) : ".$e->getMessage());
- }
+ /**
+ * Submit BitPay Payout Recipients.
+ *
+ * @see https://developer.bitpay.com/reference/invite-recipients Invite Recipients
+ *
+ * @param PayoutRecipients $recipients A PayoutRecipients object with request parameters defined.
+ * @return PayoutRecipient[] A list of BitPay PayoutRecipients objects.
+ * @throws PayoutRecipientCreationException
+ */
+ public function submitPayoutRecipients(PayoutRecipients $recipients): array
+ {
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- return $ledgers;
+ return $payoutRecipientsClient->submit($recipients);
}
/**
- * Submit a BitPay Payout batch.
+ * Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+ * payout facade.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-a-recipient Retrieve a Recipient
*
- * @param $batch PayoutBatch A PayoutBatch object with request parameters defined.
- * @return PayoutBatch A PayoutBatch BitPay generated PayoutBatch object.
- * @throws PayoutCreationException BitPayException class
+ * @param string $recipientId The id of the recipient to retrieve.
+ * @return PayoutRecipient
+ * @throws PayoutQueryException
+ * @throws Exceptions\PayoutRecipientQueryException
*/
- public function submitPayoutBatch(PayoutBatch $batch): PayoutBatch
+ public function getPayoutRecipient(string $recipientId): PayoutRecipient
{
- try {
- $batch->setToken($this->_tokenCache->getTokenByFacade(Facade::Payroll));
- $batch->setGuid(Util::guid());
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- $precision = $this->getCurrencyInfo($batch->getCurrency())->precision ?? 2;
- $batch->formatAmount($precision);
+ return $payoutRecipientsClient->get($recipientId);
+ }
- $responseJson = $this->_RESTcli->post("payouts", $batch->toArray());
- } catch (Exception $e) {
- throw new PayoutCreationException("failed to serialize PayoutBatch object : ".$e->getMessage());
- }
+ /**
+ * Retrieve a collection of BitPay Payout Recipients.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-recipients-by-status Retrieve Recipients by Status
+ *
+ * @param string|null $status The recipient status you want to query on.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results
+ * starting with the 11th result).
+ * @return PayoutRecipient[]
+ * @throws BitPayException
+ */
+ public function getPayoutRecipients(string $status = null, int $limit = null, int $offset = null): array
+ {
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- try {
- $mapper = new JsonMapper();
- $batch = $mapper->map(
- json_decode($responseJson),
- new PayoutBatch()
- );
+ return $payoutRecipientsClient->getPayoutRecipients($status, $limit, $offset);
+ }
- } catch (Exception $e) {
- throw new PayoutCreationException(
- "failed to deserialize BitPay server response (PayoutBatch) : ".$e->getMessage());
- }
+ /**
+ * Update a Payout Recipient.
+ *
+ * @see https://developer.bitpay.com/reference/update-a-recipient Update a Recipient
+ *
+ * @param string $recipientId The recipient id for the recipient to be updated.
+ * @param PayoutRecipient $recipient A PayoutRecipient object with updated parameters defined.
+ * @return PayoutRecipient
+ * @throws PayoutRecipientUpdateException
+ */
+ public function updatePayoutRecipient(string $recipientId, PayoutRecipient $recipient): PayoutRecipient
+ {
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- return $batch;
+ return $payoutRecipientsClient->update($recipientId, $recipient);
}
/**
- * Retrieve a collection of BitPay payout batches.
+ * Delete a Payout Recipient.
*
- * @param $status string The status to filter the Payout Batches.
- * @return array A list of BitPay PayoutBatch objects.
- * @throws PayoutQueryException
+ * @see https://developer.bitpay.com/reference/remove-a-recipient Remove a Recipient
+ *
+ * @param string $recipientId The recipient id for the recipient to be deleted.
+ * @return bool True if the recipient was successfully deleted, false otherwise.
+ * @throws PayoutRecipientCancellationException
*/
- public function getPayoutBatches(string $status = null): array
+ public function deletePayoutRecipient(string $recipientId): bool
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Payroll);
- if ($status) {
- $params["status"] = $status;
- }
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- $responseJson = $this->_RESTcli->get("payouts", $params);
- } catch (Exception $e) {
- throw new PayoutQueryException("failed to serialize PayoutBatch object : ".$e->getMessage());
- }
+ return $payoutRecipientsClient->delete($recipientId);
+ }
- try {
- $mapper = new JsonMapper();
- $batches = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Payout\PayoutBatch'
- );
+ /**
+ * Notify BitPay Payout Recipient.
+ *
+ * @see https://developer.bitpay.com/reference/request-a-recipient-webhook-to-be-resent
+ * Request a Recipient Webhook to be Resent
+ *
+ * @param string $recipientId The id of the recipient to notify.
+ * @return bool True if the notification was successfully sent, false otherwise.
+ * @throws PayoutRecipientNotificationException
+ */
+ public function requestPayoutRecipientNotification(string $recipientId): bool
+ {
+ $payoutRecipientsClient = $this->getPayoutRecipientsClient();
- } catch (Exception $e) {
- throw new PayoutQueryException(
- "failed to deserialize BitPay server response (PayoutBatch) : ".$e->getMessage());
- }
+ return $payoutRecipientsClient->requestNotification($recipientId);
+ }
+
+ /**
+ * Submit a BitPay Payout.
+ *
+ * @see https://developer.bitpay.com/reference/create-a-payout Create a Payout
+ *
+ * @param Payout $payout A Payout object with request parameters defined.
+ * @return Payout
+ * @throws PayoutCreationException
+ */
+ public function submitPayout(Payout $payout): Payout
+ {
+ $payoutClient = $this->getPayoutClient();
- return $batches;
+ return $payoutClient->submit($payout);
}
/**
- * Retrieve a BitPay payout batch by batch id using. The client must have been previously authorized for the
- * payroll facade.
+ * Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+ * for the payout facade.
*
- * @param $batchId string The id of the batch to retrieve.
- * @return PayoutBatch A BitPay PayoutBatch object.
- * @throws PayoutQueryException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-a-payout Retrieve a Payout
+ *
+ * @param string $payoutId The id of the payout to retrieve.
+ * @return Payout
+ * @throws PayoutQueryException
*/
- public function getPayoutBatch(string $batchId): PayoutBatch
+ public function getPayout(string $payoutId): Payout
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Payroll);
+ $payoutClient = $this->getPayoutClient();
- $responseJson = $this->_RESTcli->get("payouts/".$batchId, $params);
- } catch (Exception $e) {
- throw new PayoutQueryException("failed to serialize PayoutBatch object : ".$e->getMessage());
- }
+ return $payoutClient->get($payoutId);
+ }
- try {
- $mapper = new JsonMapper();
- $batch = $mapper->map(
- json_decode($responseJson),
- new PayoutBatch()
- );
+ /**
+ * Retrieve a collection of BitPay payouts.
+ *
+ * @see https://developer.bitpay.com/reference/retrieve-payouts-filtered-by-query Retrieve Payouts Filtered by Query
+ *
+ * @param string|null $startDate The start date to filter the Payout Batches.
+ * @param string|null $endDate The end date to filter the Payout Batches.
+ * @param string|null $status The status to filter the Payout Batches.
+ * @param string|null $reference The optional reference specified at payout request creation.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results
+ * starting with the 11th result).
+ * @return Payout[]
+ * @throws PayoutQueryException
+ */
+ public function getPayouts(
+ string $startDate = null,
+ string $endDate = null,
+ string $status = null,
+ string $reference = null,
+ int $limit = null,
+ int $offset = null
+ ): array {
+ $payoutClient = $this->getPayoutClient();
- } catch (Exception $e) {
- throw new PayoutQueryException(
- "failed to deserialize BitPay server response (PayoutBatch) : ".$e->getMessage());
- }
+ return $payoutClient->getPayouts($startDate, $endDate, $status, $reference, $limit, $offset);
+ }
- return $batch;
+ /**
+ * Cancel a BitPay Payout.
+ *
+ * @see https://developer.bitpay.com/reference/cancel-a-payout Cancel a Payout
+ *
+ * @param string $payoutId The id of the payout to cancel.
+ * @return bool
+ * @throws PayoutCancellationException
+ */
+ public function cancelPayout(string $payoutId): bool
+ {
+ $payoutClient = $this->getPayoutClient();
+
+ return $payoutClient->cancel($payoutId);
}
/**
- * Cancel a BitPay Payout batch.
+ * Notify BitPay Payout.
*
- * @param $batchId string The id of the batch to cancel.
- * @return PayoutBatch A BitPay generated PayoutBatch object.
- * @throws PayoutCancellationException BitPayException class
+ * @see https://developer.bitpay.com/reference/request-a-payout-webhook-to-be-resent
+ * Request a Payout Webhook to be Resent
+ *
+ * @param string $payoutId The id of the Payout to notify.
+ * @return bool
+ * @throws PayoutNotificationException BitPayException class
*/
- public function cancelPayoutBatch(string $batchId): PayoutBatch
+ public function requestPayoutNotification(string $payoutId): bool
{
- try {
- $batch = $this->getPayoutBatch($batchId);
- $params = [];
- $params["token"] = $batch->getToken();
+ $payoutClient = $this->getPayoutClient();
- $responseJson = $this->_RESTcli->delete("payouts/".$batchId, $params);
- } catch (Exception $e) {
- throw new PayoutCancellationException("failed to serialize PayoutBatch object : ".$e->getMessage());
- }
+ return $payoutClient->requestNotification($payoutId);
+ }
- try {
- $mapper = new JsonMapper();
- $batch = $mapper->map(
- json_decode($responseJson),
- new PayoutBatch()
- );
+ /**
+ * @see https://developer.bitpay.com/reference/create-payout-group Create Payout Group
+ *
+ * @param Payout[] $payouts
+ * @return PayoutGroup
+ * @throws PayoutCreationException
+ */
+ public function createPayoutGroup(array $payouts): PayoutGroup
+ {
+ $payoutClient = $this->getPayoutClient();
- } catch (Exception $e) {
- throw new PayoutCancellationException(
- "failed to deserialize BitPay server response (PayoutBatch) : ".$e->getMessage());
- }
+ return $payoutClient->createGroup($payouts);
+ }
- return $batch;
+ /**
+ * @see https://developer.bitpay.com/reference/cancel-a-payout-group Cancel a Payout Group
+ *
+ * @param string $groupId
+ * @return PayoutGroup
+ * @throws PayoutCancellationException
+ */
+ public function cancelPayoutGroup(string $groupId): PayoutGroup
+ {
+ $payoutClient = $this->getPayoutClient();
+
+ return $payoutClient->cancelGroup($groupId);
}
/**
@@ -846,14 +938,16 @@ public function cancelPayoutBatch(string $batchId): PayoutBatch
* The `limit` and `offset` parameters
* specify pages for large query sets.
*
+ * @see https://developer.bitpay.com/reference/retrieve-settlements Retrieve Settlements
+ *
* @param $currency string The three digit currency string for the ledger to retrieve.
* @param $dateStart string The start date for the query.
* @param $dateEnd string The end date for the query.
- * @param $status string Can be `processing`, `completed`, or `failed`.
- * @param $limit int Maximum number of settlements to retrieve.
- * @param $offset int Offset for paging.
- * @return array A list of BitPay Settlement objects.
- * @throws BitPayException BitPayException class
+ * @param string|null $status string Can be `processing`, `completed`, or `failed`.
+ * @param int|null $limit int Maximum number of settlements to retrieve.
+ * @param int|null $offset int Offset for paging.
+ * @return Settlement[]
+ * @throws BitPayException
*/
public function getSettlements(
string $currency,
@@ -863,422 +957,187 @@ public function getSettlements(
int $limit = null,
int $offset = null
): array {
- try {
- $status = $status != null ? $status : "";
- $limit = $limit != null ? $limit : 100;
- $offset = $offset != null ? $offset : 0;
-
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
- $params["dateStart"] = $dateStart;
- $params["dateEnd"] = $dateEnd;
- $params["currency"] = $currency;
- $params["status"] = $status;
- $params["limit"] = (string)$limit;
- $params["offset"] = (string)$offset;
-
- $responseJson = $this->_RESTcli->get("settlements", $params);
- } catch (Exception $e) {
- throw new SettlementQueryException("failed to serialize Settlement object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $settlements = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Settlement\Settlement'
- );
+ $settlementsClient = $this->getSettlementClient();
- } catch (Exception $e) {
- throw new SettlementQueryException(
- "failed to deserialize BitPay server response (Settlement) : ".$e->getMessage());
- }
-
- return $settlements;
+ return $settlementsClient->getSettlements($currency, $dateStart, $dateEnd, $status, $limit, $offset);
}
/**
* Retrieves a summary of the specified settlement.
*
- * @param $settlementId Settlement Id.
- * @return Settlement A BitPay Settlement object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/retrieve-a-settlement Retrieve a Settlement
+ *
+ * @param string $settlementId Settlement Id.
+ * @return Settlement
+ * @throws BitPayException
*/
public function getSettlement(string $settlementId): Settlement
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
-
- $responseJson = $this->_RESTcli->get("settlements/".$settlementId, $params);
- } catch (Exception $e) {
- throw new SettlementQueryException("failed to serialize Settlement object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $settlement = $mapper->map(
- json_decode($responseJson),
- new Settlement()
- );
-
- } catch (Exception $e) {
- throw new SettlementQueryException(
- "failed to deserialize BitPay server response (Settlement) : ".$e->getMessage());
- }
+ $settlementsClient = $this->getSettlementClient();
- return $settlement;
+ return $settlementsClient->get($settlementId);
}
/**
* Gets a detailed reconciliation report of the activity within the settlement period.
*
- * @param $settlement Settlement to generate report for.
- * @return Settlement A detailed BitPay Settlement object.
- * @throws BitPayException BitPayException class
+ * @see https://developer.bitpay.com/reference/fetch-a-reconciliation-report Fetch a Reconciliation Report
+ *
+ * @param Settlement $settlement Settlement to generate report for.
+ * @return Settlement
+ * @throws BitPayException
*/
public function getSettlementReconciliationReport(Settlement $settlement): Settlement
{
- try {
- $params = [];
- $params["token"] = $settlement->getToken();
+ $settlementsClient = $this->getSettlementClient();
- $responseJson = $this->_RESTcli->get("settlements/".$settlement->getId()."/reconciliationReport", $params);
- } catch (Exception $e) {
- throw new SettlementQueryException("failed to serialize Reconciliation Report object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $reconciliationReport = $mapper->map(
- json_decode($responseJson),
- new Settlement()
- );
-
- } catch (Exception $e) {
- throw new SettlementQueryException(
- "failed to deserialize BitPay server response (Reconciliation Report) : ".$e->getMessage());
- }
-
- return $reconciliationReport;
+ return $settlementsClient->getReconciliationReport($settlement);
}
/**
- * Create a BitPay Subscription.
- *
- * @param $subscription string A Subscription object with request parameters defined.
- * @return Subscription A BitPay generated Subscription object.
- * @throws BitPayException BitPayException class
+ * @param string|null $privateKey
+ * @param string|null $privateKeySecret
+ * @return PrivateKey|null
+ * @throws BitPayException
+ * @throws Exception
*/
- public function createSubscription(Subscription $subscription): Subscription
+ private static function initKeys(?string $privateKey, ?string $privateKeySecret): ?PrivateKey
{
- try {
- $subscription->setToken($this->_tokenCache->getTokenByFacade(Facade::Merchant));
+ $key = null;
- $responseJson = $this->_RESTcli->post("subscriptions", $subscription->toArray());
- } catch (Exception $e) {
- throw new SubscriptionCreationException("failed to serialize Subscription object : ".$e->getMessage());
+ if (!file_exists($privateKey)) {
+ $key = new PrivateKey("plainHex");
+ $key->setHex($privateKey);
+ if (!$key->isValid()) {
+ throw new BitPayException("Private Key not found/valid");
+ }
}
- try {
- $mapper = new JsonMapper();
- $subscription = $mapper->map(
- json_decode($responseJson),
- new Subscription()
- );
-
- } catch (Exception $e) {
- throw new SubscriptionCreationException(
- "failed to deserialize BitPay server response (Subscription) : ".$e->getMessage());
+ if (!$key) {
+ $storageEngine = new EncryptedFilesystemStorage($privateKeySecret);
+ $key = $storageEngine->load($privateKey);
}
- return $subscription;
+ return $key;
}
/**
- * Retrieve a BitPay subscription by subscription id using the specified facade.
- *
- * @param $subscriptionId string The id of the subscription to retrieve.
- * @return Subscription A BitPay Subscription object.
- * @throws BitPayException BitPayException class
+ * @param string $configFilePath
+ * @return array
+ * @throws BitPayException
*/
- public function getSubscription(string $subscriptionId): Subscription
+ private static function getConfigData(string $configFilePath): array
{
-
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
-
- $responseJson = $this->_RESTcli->get("subscriptions/".$subscriptionId, $params);
- } catch (Exception $e) {
- throw new SubscriptionQueryException("failed to serialize Subscription object : ".$e->getMessage());
+ if (!file_exists($configFilePath)) {
+ throw new BitPayException("Configuration file not found");
}
try {
- $mapper = new JsonMapper();
- $subscription = $mapper->map(
- json_decode($responseJson),
- new Subscription()
- );
-
- } catch (Exception $e) {
- throw new SubscriptionQueryException(
- "failed to deserialize BitPay server response (Subscription) : ".$e->getMessage());
+ $configData = json_decode(file_get_contents($configFilePath), true, 512, JSON_THROW_ON_ERROR);
+ } catch (\JsonException $e) {
+ $configData = Yaml::parseFile($configFilePath);
}
- return $subscription;
+ return $configData;
}
/**
- * Retrieve a collection of BitPay subscriptions.
+ * Gets token client
*
- * @param $status string|null The status to filter the subscriptions.
- * @return array A list of BitPay Subscription objects.
- * @throws BitPayException BitPayException class
+ * @return TokenClient
*/
- public function getSubscriptions(string $status = null): array
+ private function getTokenClient(): TokenClient
{
- try {
- $params = [];
- $params["token"] = $this->_tokenCache->getTokenByFacade(Facade::Merchant);
- if ($status) {
- $params["status"] = $status;
- }
-
- $responseJson = $this->_RESTcli->get("subscriptions", $params);
- } catch (Exception $e) {
- throw new SubscriptionQueryException("failed to serialize Subscription object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $subscriptions = $mapper->mapArray(
- json_decode($responseJson),
- [],
- 'BitPaySDK\Model\Subscription\Subscription'
- );
-
- } catch (Exception $e) {
- throw new SubscriptionQueryException(
- "failed to deserialize BitPay server response (Subscription) : ".$e->getMessage());
- }
-
- return $subscriptions;
+ return TokenClient::getInstance($this->restCli);
}
/**
- * Update a BitPay Subscription.
+ * Gets invoice client
*
- * @param $subscription Subscription A Subscription object with the parameters to update defined.
- * @param $subscriptionId string $subscriptionIdThe Id of the Subscription to update.
- * @return Subscription An updated Subscription object.
- * @throws BitPayException BitPayException class
+ * @return InvoiceClient the invoice client
*/
- public function updateSubscription(Subscription $subscription, string $subscriptionId): Subscription
+ protected function getInvoiceClient(): InvoiceClient
{
- try {
- $subscriptionToken = $this->getSubscription($subscription->getId())->getToken();
- $subscription->setToken($subscriptionToken);
-
- $responseJson = $this->_RESTcli->update("subscriptions/".$subscriptionId, $subscription->toArray());
- } catch (Exception $e) {
- throw new SubscriptionUpdateException("failed to serialize Subscription object : ".$e->getMessage());
- }
-
- try {
- $mapper = new JsonMapper();
- $subscription = $mapper->map(
- json_decode($responseJson),
- $subscription
- );
-
- } catch (Exception $e) {
- throw new SubscriptionUpdateException(
- "failed to deserialize BitPay server response (Subscription) : ".$e->getMessage());
- }
-
- return $subscription;
+ return InvoiceClient::getInstance($this->tokenCache, $this->restCli);
}
/**
- * Fetch the supported currencies.
+ * Gets refund client
*
- * @return array A list of BitPay Invoice objects.
- * @throws BitPayException BitPayException class
+ * @return RefundClient the refund client
*/
- public function getCurrencies(): array
+ protected function getRefundClient(): RefundClient
{
- try {
- $currencies = json_decode($this->_RESTcli->get("currencies/", null, false), false);
- } catch (Exception $e) {
- throw new CurrencyQueryException("failed to serialize Currency object : ".$e->getMessage());
- }
-
- return $currencies;
+ return RefundClient::getInstance($this->tokenCache, $this->restCli);
}
- ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-
/**
- * Builds the configuration object
+ * Gets wallet client
*
- * @param $privateKey String The full path to the securely located private key or the HEX key value.
- * @param $tokens Tokens object containing the BitPay's API tokens.
- * @param $privateKeySecret String Private Key encryption password only for key file.
- * @throws BitPayException BitPayException class
+ * @return WalletClient the wallet client
*/
- private function buildConfig($privateKey, $tokens, $privateKeySecret = null)
+ protected function getWalletClient(): WalletClient
{
- try {
- if (!file_exists($privateKey)) {
- $key = new PrivateKey("plainHex");
- $key->setHex($privateKey);
- if (!$key->isValid()) {
- throw new BitPayException("Private Key not found/valid");
- }
- $this->_ecKey = $key;
- }
- $this->_configuration = new Config();
- $this->_configuration->setEnvironment($this->_env);
-
- $envConfig[$this->_env] = [
- "PrivateKeyPath" => $privateKey,
- "PrivateKeySecret" => $privateKeySecret,
- "ApiTokens" => $tokens,
- ];
-
- $this->_configuration->setEnvConfig($envConfig);
- } catch (Exception $e) {
- throw new BitPayException("failed to build configuration : ".$e->getMessage());
- }
+ return WalletClient::getInstance($this->restCli);
}
/**
- * Loads the configuration file (JSON)
+ * Gets bill client
*
- * @throws BitPayException BitPayException class
+ * @return BillClient the bill client
*/
- public function getConfig()
+ protected function getBillClient(): BillClient
{
- try {
- $this->_configuration = new Config();
- if (!file_exists($this->_configFilePath)) {
- throw new BitPayException("Configuration file not found");
- }
- $configData = json_decode(file_get_contents($this->_configFilePath), true);
-
- if (!$configData) {
- $configData = Yaml::parseFile($this->_configFilePath);
- }
- $this->_configuration->setEnvironment($configData["BitPayConfiguration"]["Environment"]);
- $this->_env = $this->_configuration->getEnvironment();
-
- $tokens = Tokens::loadFromArray($configData["BitPayConfiguration"]["EnvConfig"][$this->_env]["ApiTokens"]);
- $privateKeyPath = $configData["BitPayConfiguration"]["EnvConfig"][$this->_env]["PrivateKeyPath"];
- $privateKeySecret = $configData["BitPayConfiguration"]["EnvConfig"][$this->_env]["PrivateKeySecret"];
-
- $envConfig[$this->_env] = [
- "PrivateKeyPath" => $privateKeyPath,
- "PrivateKeySecret" => $privateKeySecret,
- "ApiTokens" => $tokens,
- ];
-
- $this->_configuration->setEnvConfig($envConfig);
- } catch (Exception $e) {
- throw new BitPayException("failed to initialize BitPay Client (Config) : ".$e->getMessage());
- }
+ return BillClient::getInstance($this->tokenCache, $this->restCli);
}
/**
- * Initialize the public/private key pair by either loading the existing one or by creating a new one.
+ * Gets rate client
*
- * @throws BitPayException BitPayException class
+ * @return RateClient the rate client
*/
- private function initKeys()
+ protected function getRateClient(): RateClient
{
- $privateKey = $this->_configuration->getEnvConfig()[$this->_env]["PrivateKeyPath"];
- $privateKeySecret = $this->_configuration->getEnvConfig()[$this->_env]["PrivateKeySecret"];
-
- try {
- if (!$this->_ecKey) {
- $this->_ecKey = new PrivateKey($privateKey);
- $storageEngine = new EncryptedFilesystemStorage($privateKeySecret);
- $this->_ecKey = $storageEngine->load($privateKey);
- }
- } catch (Exception $e) {
- throw new BitPayException("failed to build configuration : ".$e->getMessage());
- }
+ return RateClient::getInstance($this->restCli);
}
/**
- * Initialize this object with the client name and the environment Url.
+ * Gets ledger client
*
- * @throws BitPayException BitPayException class
+ * @return LedgerClient the ledger client
*/
- private function init()
+ protected function getLedgerClient(): LedgerClient
{
- try {
- $this->_RESTcli = new RESTcli($this->_env, $this->_ecKey);
- $this->loadAccessTokens();
- $this->loadCurrencies();
- } catch (Exception $e) {
- throw new BitPayException("failed to build configuration : ".$e->getMessage());
- }
+ return LedgerClient::getInstance($this->tokenCache, $this->restCli);
}
/**
- * Load tokens from configuration.
+ * Gets payout recipients client
*
- * @throws BitPayException BitPayException class
+ * @return PayoutRecipientsClient the payout recipients client
*/
- private function loadAccessTokens()
+ protected function getPayoutRecipientsClient(): PayoutRecipientsClient
{
- try {
- $this->clearAccessTokenCache();
-
- $this->_tokenCache = $this->_configuration->getEnvConfig()[$this->_env]["ApiTokens"];
- } catch (Exception $e) {
- throw new BitPayException("When trying to load the tokens : ".$e->getMessage());
- }
- }
-
- private function clearAccessTokenCache()
- {
- $this->_tokenCache = new Tokens();
+ return PayoutRecipientsClient::getInstance($this->tokenCache, $this->restCli);
}
/**
- * Load currencies info.
+ * Gets payout client
*
- * @throws BitPayException BitPayException class
+ * @return PayoutClient the payout client
*/
- private function loadCurrencies()
+ protected function getPayoutClient(): PayoutClient
{
- try {
- $this->_currenciesInfo = $this->getCurrencies();
- } catch (Exception $e) {
- throw new BitPayException("When loading currencies info : ".$e->getMessage());
- }
+ return PayoutClient::getInstance($this->tokenCache, $this->restCli);
}
/**
- * Gets info for specific currency.
- *
- * @param $currencyCode String Currency code for which the info will be retrieved.
+ * Gets settlement client
*
- * @return object|null
+ * @return SettlementClient the settlements client
*/
- public function getCurrencyInfo(string $currencyCode)
+ protected function getSettlementClient(): SettlementClient
{
- foreach ($this->_currenciesInfo as $currencyInfo) {
- if ($currencyInfo->code == $currencyCode) {
- return $currencyInfo;
- }
- }
-
- return null;
+ return SettlementClient::getInstance($this->tokenCache, $this->restCli);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Client/BillClient.php b/src/BitPaySDK/Client/BillClient.php
new file mode 100644
index 00000000..b0cddcc9
--- /dev/null
+++ b/src/BitPaySDK/Client/BillClient.php
@@ -0,0 +1,270 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class BillClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Bill Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Create a BitPay Bill.
+ *
+ * @param Bill $bill A Bill object with request parameters defined.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Bill
+ * @throws BitPayException
+ */
+ public function create(Bill $bill, string $facade = Facade::MERCHANT, bool $signRequest = true): Bill
+ {
+ try {
+ $bill->setToken($this->tokenCache->getTokenByFacade($facade));
+
+ $responseJson = $this->restCli->post("bills", $bill->toArray(), $signRequest);
+ } catch (BitPayException $e) {
+ throw new BillCreationException(
+ "failed to serialize Bill object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new BillCreationException("failed to serialize Bill object : " . $e->getMessage());
+ }
+
+ try {
+ return $this->mapJsonToBillClass($responseJson);
+ } catch (Exception $e) {
+ throw new BillCreationException(
+ "failed to deserialize BitPay server response (Bill) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a BitPay bill by bill id using the specified facade.
+ *
+ * @param $billId string The id of the bill to retrieve.
+ * @param $facade string The facade used to retrieve it.
+ * @param $signRequest bool Signed request.
+ * @return Bill
+ * @throws BitPayException
+ */
+ public function get(string $billId, string $facade = Facade::MERCHANT, bool $signRequest = true): Bill
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade($facade);
+
+ $responseJson = $this->restCli->get("bills/" . $billId, $params, $signRequest);
+ } catch (BitPayException $e) {
+ throw new BillQueryException(
+ "failed to serialize Bill object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new BillQueryException("failed to serialize Bill object : " . $e->getMessage());
+ }
+
+ try {
+ return $this->mapJsonToBillClass($responseJson);
+ } catch (Exception $e) {
+ throw new BillQueryException(
+ "failed to deserialize BitPay server response (Bill) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a collection of BitPay bills.
+ *
+ * @param string|null The status to filter the bills.
+ * @return Bill[]
+ * @throws BitPayException
+ */
+ public function getBills(string $status = null): array
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ if ($status) {
+ $params["status"] = $status;
+ }
+
+ $responseJson = $this->restCli->get("bills", $params);
+ } catch (BitPayException $e) {
+ throw new BillQueryException(
+ "failed to serialize Bill object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new BillQueryException("failed to serialize Bill object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+ $bills = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Bill::class
+ );
+ } catch (Exception $e) {
+ throw new BillQueryException(
+ "failed to deserialize BitPay server response (Bill) : " . $e->getMessage()
+ );
+ }
+
+ return $bills;
+ }
+
+ /**
+ * Update a BitPay Bill.
+ *
+ * @param Bill $bill A Bill object with the parameters to update defined.
+ * @param string $billId The Id of the Bill to update.
+ * @return Bill
+ * @throws BitPayException
+ */
+ public function update(Bill $bill, string $billId): Bill
+ {
+ try {
+ $billToken = $this->get($bill->getId())->getToken();
+ $bill->setToken($billToken);
+
+ $responseJson = $this->restCli->update("bills/" . $billId, $bill->toArray());
+ } catch (BitPayException $e) {
+ throw new BillUpdateException(
+ "failed to serialize Bill object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new BillUpdateException("failed to serialize Bill object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ $bill
+ );
+ } catch (Exception $e) {
+ throw new BillUpdateException("failed to deserialize BitPay server response (Bill) : " . $e->getMessage());
+ }
+ }
+
+ /**
+ * Deliver a BitPay Bill.
+ *
+ * @param string $billId The id of the requested bill.
+ * @param string $billToken The token of the requested bill.
+ * @param bool $signRequest Allow unsigned request
+ * @return bool
+ * @throws BitPayException
+ */
+ public function deliver(string $billId, string $billToken, bool $signRequest = true): bool
+ {
+ try {
+ $responseJson = $this->restCli->post(
+ "bills/" . $billId . "/deliveries",
+ ['token' => $billToken],
+ $signRequest
+ );
+ } catch (BitPayException $e) {
+ throw new BillDeliveryException(
+ "failed to serialize Bill object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new BillDeliveryException("failed to serialize Bill object : " . $e->getMessage());
+ }
+
+ try {
+ $result = str_replace("\"", "", $responseJson);
+
+ return strtolower($result) === 'success';
+ } catch (Exception $e) {
+ throw new BillDeliveryException(
+ "failed to deserialize BitPay server response (Bill) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * @param string|null $responseJson
+ * @return mixed
+ * @throws \JsonException
+ * @throws \JsonMapper_Exception
+ */
+ private function mapJsonToBillClass(?string $responseJson): mixed
+ {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Bill()
+ );
+ }
+}
diff --git a/src/BitPaySDK/Client/InvoiceClient.php b/src/BitPaySDK/Client/InvoiceClient.php
new file mode 100644
index 00000000..c8d92713
--- /dev/null
+++ b/src/BitPaySDK/Client/InvoiceClient.php
@@ -0,0 +1,523 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class InvoiceClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Invoice Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Create a BitPay invoice.
+ *
+ * @param Invoice $invoice An Invoice object with request parameters defined.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Invoice
+ * @throws BitPayException
+ */
+ public function create(
+ Invoice $invoice,
+ string $facade = Facade::MERCHANT,
+ bool $signRequest = true
+ ): Invoice {
+ try {
+ $invoice->setToken($this->tokenCache->getTokenByFacade($facade));
+ $invoice->setGuid(Util::guid());
+
+ $responseJson = $this->restCli->post("invoices", $invoice->toArray(), $signRequest);
+ } catch (BitPayException $e) {
+ throw new InvoiceCreationException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCreationException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCreationException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Update a BitPay invoice.
+ *
+ * @param string $invoiceId The id of the invoice to updated.
+ * @param string|null $buyerSms The buyer's cell number.
+ * @param string|null $smsCode The buyer's received verification code.
+ * @param string|null $buyerEmail The buyer's email address.
+ * @param false $autoVerify Skip the user verification on sandbox ONLY.
+ * @return Invoice
+ * @throws InvoiceUpdateException
+ */
+ public function update(
+ string $invoiceId,
+ ?string $buyerSms,
+ ?string $smsCode,
+ ?string $buyerEmail,
+ bool $autoVerify = false
+ ): Invoice {
+ // Updating the invoice will require EITHER SMS or E-mail, but not both.
+ if ($this->buyerEmailOrSms($buyerEmail, $buyerSms)) {
+ throw new InvoiceUpdateException("Updating the invoice requires buyerSms or buyerEmail, but not both.");
+ }
+
+ // smsCode required only when verifying SMS, except when autoVerify is true.
+ if ($this->isSmsCodeRequired($autoVerify, $buyerSms, $smsCode)) {
+ throw new InvoiceUpdateException(
+ "Updating the invoice requires both buyerSms and smsCode when verifying SMS."
+ );
+ }
+
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["buyerEmail"] = $buyerEmail;
+ $params["buyerSms"] = $buyerSms;
+ $params["smsCode"] = $smsCode;
+ $params["autoVerify"] = $autoVerify;
+
+ $responseJson = $this->restCli->update("invoices/" . $invoiceId, $params);
+ } catch (BitPayException $e) {
+ throw new InvoiceUpdateException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceUpdateException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceUpdateException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+ * authorized for the specified facade (the public facade requires no authorization).
+ *
+ * @param string $invoiceId The id of the invoice to retrieve.
+ * @param string $facade The facade used to create it.
+ * @param bool $signRequest Signed request.
+ * @return Invoice
+ * @throws InvoiceQueryException
+ */
+ public function get(
+ string $invoiceId,
+ string $facade = Facade::MERCHANT,
+ bool $signRequest = true
+ ): Invoice {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade($facade);
+
+ $responseJson = $this->restCli->get("invoices/" . $invoiceId, $params, $signRequest);
+ } catch (BitPayException $e) {
+ throw new InvoiceQueryException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * @param string $guid
+ * @param string $facade
+ * @param bool $signRequest
+ * @return Invoice
+ * @throws InvoiceQueryException
+ */
+ public function getByGuid(
+ string $guid,
+ string $facade = Facade::MERCHANT,
+ bool $signRequest = true
+ ): Invoice {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade($facade);
+
+ $responseJson = $this->restCli->get("invoices/guid/" . $guid, $params, $signRequest);
+ } catch (BitPayException $e) {
+ throw new InvoiceQueryException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a collection of BitPay invoices.
+ *
+ * @param string $dateStart The start of the date window to query for invoices. Format YYYY-MM-DD.
+ * @param string $dateEnd The end of the date window to query for invoices. Format YYYY-MM-DD.
+ * @param string|null $status The invoice status you want to query on.
+ * @param string|null $orderId The optional order id specified at time of invoice creation.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results starting
+ * with the 11th result).
+ * @return Invoice[]
+ * @throws BitPayException
+ */
+ public function getInvoices(
+ string $dateStart,
+ string $dateEnd,
+ string $status = null,
+ string $orderId = null,
+ int $limit = null,
+ int $offset = null
+ ): array {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["dateStart"] = $dateStart;
+ $params["dateEnd"] = $dateEnd;
+ if ($status) {
+ $params["status"] = $status;
+ }
+ if ($orderId) {
+ $params["orderId"] = $orderId;
+ }
+ if ($limit) {
+ $params["limit"] = $limit;
+ }
+ if ($offset) {
+ $params["offset"] = $offset;
+ }
+
+ $responseJson = $this->restCli->get("invoices", $params);
+ } catch (BitPayException $e) {
+ throw new InvoiceQueryException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Invoice::class
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Request a BitPay Invoice Webhook.
+ *
+ * @param string $invoiceId A BitPay invoice ID.
+ * @return bool True if the webhook was successfully requested, false otherwise.
+ * @throws InvoiceQueryException
+ * @throws BitPayException
+ */
+ public function requestNotification(string $invoiceId): bool
+ {
+ try {
+ $params = ['token' => $this->tokenCache->getTokenByFacade(Facade::MERCHANT)];
+ } catch (BitPayException $e) {
+ throw new InvoiceQueryException(
+ "failed to serialize invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceQueryException("failed to serialize invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $responseJson = $this->restCli->post("invoices/" . $invoiceId . "/notifications", $params);
+
+ return strtolower($responseJson) === "success";
+ } catch (Exception $e) {
+ throw new InvoiceQueryException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Cancel a BitPay invoice.
+ *
+ * @param string $invoiceId The id of the invoice to updated.
+ * @return Invoice $invoice Cancelled invoice object.
+ * @throws InvoiceCancellationException
+ * @throws BitPayException
+ */
+ public function cancel(
+ string $invoiceId,
+ bool $forceCancel = false
+ ): Invoice {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ if ($forceCancel) {
+ $params["forceCancel"] = $forceCancel;
+ }
+
+ $responseJson = $this->restCli->delete("invoices/" . $invoiceId, $params);
+ } catch (BitPayException $e) {
+ throw new InvoiceCancellationException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCancellationException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCancellationException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Cancel a BitPay invoice.
+ *
+ * @param string $guid The guid of the invoice to cancel.
+ * @return Invoice $invoice Cancelled invoice object.
+ * @throws InvoiceCancellationException
+ * @throws BitPayException
+ */
+ public function cancelByGuid(
+ string $guid,
+ bool $forceCancel = false
+ ): Invoice {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ if ($forceCancel) {
+ $params["forceCancel"] = $forceCancel;
+ }
+
+ $responseJson = $this->restCli->delete("invoices/guid/" . $guid, $params);
+ } catch (BitPayException $e) {
+ throw new InvoiceCancellationException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCancellationException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoiceCancellationException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Pay an invoice with a mock transaction
+ *
+ * @param string $invoiceId The id of the invoice.
+ * @param string $status Status the invoice will become. Acceptable values are confirmed (default) and complete.
+ * @return Invoice $invoice Invoice object.
+ * @throws InvoicePaymentException
+ * @throws BitPayException
+ */
+ public function pay(
+ string $invoiceId,
+ string $status = 'confirmed'
+ ): Invoice {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["status"] = $status;
+ $responseJson = $this->restCli->update("invoices/pay/" . $invoiceId, $params);
+ } catch (BitPayException $e) {
+ throw new InvoicePaymentException(
+ "failed to serialize Invoice object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new InvoicePaymentException("failed to serialize Invoice object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Invoice()
+ );
+ } catch (Exception $e) {
+ throw new InvoicePaymentException(
+ "failed to deserialize BitPay server response (Invoice) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Check if buyerEmail or buyerSms is present, and not both.
+ *
+ * @param string|null $buyerEmail The buyer's email address.
+ * @param string|null $buyerSms The buyer's cell number.
+ *
+ * @return bool
+ */
+ private function buyerEmailOrSms(?string $buyerEmail, ?string $buyerSms): bool
+ {
+ return (empty($buyerSms) && empty($buyerEmail)) || (!empty($buyerSms) && empty(!$buyerEmail));
+ }
+
+ /**
+ * Check if smsCode is required.
+ *
+ * @param bool $autoVerify Skip the user verification on sandbox ONLY.
+ * @param string $buyerSms The buyer's cell number.
+ * @param string $smsCode The buyer's received verification code.
+ * @return bool
+ */
+ private function isSmsCodeRequired(bool $autoVerify, string $buyerSms, string $smsCode): bool
+ {
+ return ($autoVerify === false &&
+ (!empty($buyerSms) && empty($smsCode))) || (!empty($smsCode) && empty($buyerSms));
+ }
+}
diff --git a/src/BitPaySDK/Client/LedgerClient.php b/src/BitPaySDK/Client/LedgerClient.php
new file mode 100644
index 00000000..a948f1f5
--- /dev/null
+++ b/src/BitPaySDK/Client/LedgerClient.php
@@ -0,0 +1,149 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class LedgerClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Ledger Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Retrieve a list of ledgers by date range using the merchant facade.
+ *
+ * @param string $currency The three digit currency string for the ledger to retrieve.
+ * @param string $startDate The first date for the query filter.
+ * @param string $endDate The last date for the query filter.
+ * @return LedgerEntry[] A Ledger object populated with the BitPay ledger entries list.
+ * @throws LedgerQueryException
+ */
+ public function get(string $currency, string $startDate, string $endDate): array
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ if ($currency) {
+ $params["currency"] = $currency;
+ }
+ if ($currency) {
+ $params["startDate"] = $startDate;
+ }
+ if ($currency) {
+ $params["endDate"] = $endDate;
+ }
+
+ $responseJson = $this->restCli->get("ledgers/" . $currency, $params);
+ } catch (BitPayException $e) {
+ throw new LedgerQueryException(
+ "failed to serialize Ledger object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new LedgerQueryException("failed to serialize Ledger object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+ $ledger = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ LedgerEntry::class
+ );
+ } catch (Exception $e) {
+ throw new LedgerQueryException(
+ "failed to deserialize BitPay server response (Ledger) : " . $e->getMessage()
+ );
+ }
+
+ return $ledger;
+ }
+
+ /**
+ * Retrieve a list of ledgers using the merchant facade.
+ *
+ * @return Ledger[] A list of Ledger objects populated with the currency and current balance of each one.
+ * @throws BitPayException
+ */
+ public function getLedgers(): array
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ $responseJson = $this->restCli->get("ledgers", $params);
+ } catch (BitPayException $e) {
+ throw new LedgerQueryException(
+ "failed to serialize Ledger object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new LedgerQueryException("failed to serialize Ledger object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+ $ledgers = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Ledger::class
+ );
+ } catch (Exception $e) {
+ throw new LedgerQueryException(
+ "failed to deserialize BitPay server response (Ledger) : " . $e->getMessage()
+ );
+ }
+
+ return $ledgers;
+ }
+}
diff --git a/src/BitPaySDK/Client/PayoutClient.php b/src/BitPaySDK/Client/PayoutClient.php
new file mode 100644
index 00000000..1587075f
--- /dev/null
+++ b/src/BitPaySDK/Client/PayoutClient.php
@@ -0,0 +1,379 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Payout Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Submit a BitPay Payout.
+ *
+ * @param Payout $payout A Payout object with request parameters defined.
+ * @return Payout
+ * @throws PayoutCreationException
+ */
+ public function submit(Payout $payout): Payout
+ {
+ try {
+ $payout->setToken($this->tokenCache->getTokenByFacade(Facade::PAYOUT));
+
+ $payout->formatAmount(2);
+
+ $responseJson = $this->restCli->post("payouts", $payout->toArray());
+ } catch (BitPayException $e) {
+ throw new PayoutCreationException(
+ "failed to serialize Payout object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutCreationException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Payout()
+ );
+ } catch (Exception $e) {
+ throw new PayoutCreationException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+ * for the payout facade.
+ *
+ * @param string $payoutId The id of the payout to retrieve.
+ * @return Payout
+ * @throws PayoutQueryException
+ */
+ public function get(string $payoutId): Payout
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->get("payouts/" . $payoutId, $params);
+ } catch (BitPayException $e) {
+ throw new PayoutQueryException(
+ "failed to serialize Payout object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutQueryException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Payout()
+ );
+ } catch (Exception $e) {
+ throw new PayoutQueryException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a collection of BitPay payouts.
+ *
+ * @param string|null $startDate The start date to filter the Payout Batches.
+ * @param string|null $endDate The end date to filter the Payout Batches.
+ * @param string|null $status The status to filter the Payout Batches.
+ * @param string|null $reference The optional reference specified at payout request creation.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results
+ * starting with the 11th result).
+ * @return Payout[]
+ * @throws PayoutQueryException
+ */
+ public function getPayouts(
+ string $startDate = null,
+ string $endDate = null,
+ string $status = null,
+ string $reference = null,
+ int $limit = null,
+ int $offset = null
+ ): array {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+ if ($startDate) {
+ $params["startDate"] = $startDate;
+ }
+ if ($endDate) {
+ $params["endDate"] = $endDate;
+ }
+ if ($status) {
+ $params["status"] = $status;
+ }
+ if ($reference) {
+ $params["reference"] = $reference;
+ }
+ if ($limit) {
+ $params["limit"] = $limit;
+ }
+ if ($offset) {
+ $params["offset"] = $offset;
+ }
+
+ $responseJson = $this->restCli->get("payouts", $params);
+ } catch (BitPayException $e) {
+ throw new PayoutQueryException(
+ "failed to serialize Payout object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutQueryException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Payout::class
+ );
+ } catch (Exception $e) {
+ throw new PayoutQueryException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Cancel a BitPay Payout.
+ *
+ * @param string $payoutId The id of the payout to cancel.
+ * @return bool
+ * @throws PayoutCancellationException
+ */
+ public function cancel(string $payoutId): bool
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->delete("payouts/" . $payoutId, $params);
+ } catch (BitPayException $e) {
+ throw new PayoutCancellationException(
+ "failed to serialize Payout object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutCancellationException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ try {
+ $result = json_decode($responseJson, false, 512, JSON_THROW_ON_ERROR);
+
+ return strtolower($result->status) === "success";
+ } catch (Exception $e) {
+ throw new PayoutCancellationException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Notify BitPay Payout.
+ *
+ * @param string $payoutId The id of the Payout to notify.
+ * @return bool
+ * @throws PayoutNotificationException BitPayException class
+ */
+ public function requestNotification(string $payoutId): bool
+ {
+ try {
+ $content = [];
+ $content["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->post("payouts/" . $payoutId . "/notifications", $content);
+ } catch (BitPayException $e) {
+ throw new PayoutNotificationException(
+ "failed to serialize Payout object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutNotificationException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ try {
+ $result = json_decode($responseJson, false, 512, JSON_THROW_ON_ERROR);
+
+ return strtolower($result->status) === "success";
+ } catch (Exception $e) {
+ throw new PayoutNotificationException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * @param Payout[] $payouts
+ * @throws PayoutCreationException
+ */
+ public function createGroup(array $payouts): PayoutGroup
+ {
+ try {
+ $request = [];
+ $request['token'] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+ } catch (Exception $e) {
+ throw new PayoutCreationException("Missing facade token");
+ }
+
+ try {
+ foreach ($payouts as $payout) {
+ $request['instructions'][] = $payout->toArray();
+ }
+
+ $responseJson = $this->restCli->post("payouts/group", $request);
+ } catch (BitPayException $e) {
+ throw new PayoutCreationException(
+ "failed to serialize Payout object : " . $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutCreationException("failed to serialize Payout object : " . $e->getMessage());
+ }
+
+ return $this->getPayoutGroupResponse($responseJson, 'created');
+ }
+
+ /**
+ * @throws PayoutCancellationException
+ */
+ public function cancelGroup(string $groupId): PayoutGroup
+ {
+ try {
+ $request = [];
+ $request['token'] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+ } catch (Exception $e) {
+ throw new PayoutCancellationException("Missing facade token");
+ }
+
+ try {
+ $responseJson = $this->restCli->delete("payouts/group/" . $groupId, $request);
+
+ return $this->getPayoutGroupResponse($responseJson, 'cancelled');
+ } catch (BitPayException $e) {
+ throw new PayoutCancellationException(
+ "failed to serialize Payout object : " . $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutCancellationException("failed to serialize Payout object : " . $e->getMessage());
+ }
+ }
+
+ /**
+ * @param string $responseJson
+ * @param string $responseType completed/cancelled
+ * @return PayoutGroup
+ * @throws PayoutCreationException
+ */
+ private function getPayoutGroupResponse(string $responseJson, string $responseType): PayoutGroup
+ {
+ try {
+ $mapper = JsonMapperFactory::create();
+ $response = json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR);
+
+ if (!array_key_exists($responseType, $response)) {
+ throw new \RuntimeException(print_r($response, true));
+ }
+
+ $payouts = $mapper->mapArray($response[$responseType], [], Payout::class);
+ $mapper->bIgnoreVisibility = true;
+ $failed = $mapper->mapArray($response['failed'], [], PayoutGroupFailed::class);
+
+ $payoutGroup = new PayoutGroup();
+ $payoutGroup->setPayouts($payouts);
+ $payoutGroup->setFailed($failed);
+
+ return $payoutGroup;
+ } catch (Exception $e) {
+ throw new PayoutCreationException(
+ "failed to deserialize BitPay server response (Payout) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Client/PayoutRecipientsClient.php b/src/BitPaySDK/Client/PayoutRecipientsClient.php
new file mode 100644
index 00000000..50125470
--- /dev/null
+++ b/src/BitPaySDK/Client/PayoutRecipientsClient.php
@@ -0,0 +1,320 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientsClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Payout Recipients Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Submit BitPay Payout Recipients.
+ *
+ * @param PayoutRecipients $recipients A PayoutRecipients object with request parameters defined.
+ * @return PayoutRecipients[] A list of BitPay PayoutRecipients objects.
+ * @throws PayoutRecipientCreationException
+ */
+ public function submit(PayoutRecipients $recipients): array
+ {
+ try {
+ $recipients->setToken($this->tokenCache->getTokenByFacade(Facade::PAYOUT));
+ $recipients->setGuid(Util::guid());
+
+ $responseJson = $this->restCli->post("recipients", $recipients->toArray());
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientCreationException(
+ "failed to serialize PayoutRecipients object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientCreationException(
+ "failed to serialize PayoutRecipients object : " . $e->getMessage()
+ );
+ }
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ PayoutRecipient::class
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientCreationException(
+ "failed to deserialize BitPay server response (PayoutRecipients) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the
+ * payout facade.
+ *
+ * @param string $recipientId The id of the recipient to retrieve.
+ * @return PayoutRecipient
+ * @throws PayoutQueryException|PayoutRecipientQueryException
+ */
+ public function get(string $recipientId): PayoutRecipient
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->get("recipients/" . $recipientId, $params);
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientQueryException(
+ "failed to serialize PayoutRecipients object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientQueryException("failed to serialize PayoutRecipient object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new PayoutRecipient()
+ );
+ } catch (Exception $e) {
+ throw new PayoutQueryException(
+ "failed to deserialize BitPay server response (PayoutRecipient) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a collection of BitPay Payout Recipients.
+ *
+ * @param string|null $status The recipient status you want to query on.
+ * @param int|null $limit Maximum results that the query will return (useful for paging results).
+ * @param int|null $offset Number of results to offset (ex. skip 10 will give you results
+ * starting with the 11th result).
+ * @return PayoutRecipient[]
+ * @throws BitPayException
+ */
+ public function getPayoutRecipients(string $status = null, int $limit = null, int $offset = null): array
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ if ($status) {
+ $params["status"] = $status;
+ }
+ if ($limit) {
+ $params["limit"] = $limit;
+ }
+ if ($offset) {
+ $params["offset"] = $offset;
+ }
+
+ $responseJson = $this->restCli->get("recipients", $params);
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientQueryException(
+ "failed to serialize PayoutRecipients object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientQueryException(
+ "failed to serialize PayoutRecipients object : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ PayoutRecipient::class
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientQueryException(
+ "failed to deserialize BitPay server response (PayoutRecipients) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Update a Payout Recipient.
+ *
+ * @param string $recipientId The recipient id for the recipient to be updated.
+ * @param PayoutRecipient $recipient A PayoutRecipient object with updated parameters defined.
+ * @return PayoutRecipient
+ * @throws PayoutRecipientUpdateException
+ */
+ public function update(string $recipientId, PayoutRecipient $recipient): PayoutRecipient
+ {
+ try {
+ $recipient->setToken($this->tokenCache->getTokenByFacade(Facade::PAYOUT));
+
+ $responseJson = $this->restCli->update("recipients/" . $recipientId, $recipient->toArray());
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientUpdateException(
+ "failed to serialize PayoutRecipient object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientUpdateException(
+ "failed to serialize PayoutRecipient object : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new PayoutRecipient()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientUpdateException(
+ "failed to deserialize BitPay server response (PayoutRecipient) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Delete a Payout Recipient.
+ *
+ * @param string $recipientId The recipient id for the recipient to be deleted.
+ * @return bool True if the recipient was successfully deleted, false otherwise.
+ * @throws PayoutRecipientCancellationException
+ */
+ public function delete(string $recipientId): bool
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->delete("recipients/" . $recipientId, $params);
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientCancellationException(
+ "failed to serialize PayoutRecipient object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientCancellationException(
+ "failed to serialize PayoutRecipient object : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $result = json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR);
+
+ return strtolower($result['status']) === "success";
+ } catch (Exception $e) {
+ throw new PayoutRecipientCancellationException(
+ "failed to deserialize BitPay server response (PayoutRecipient) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Notify BitPay Payout Recipient.
+ *
+ * @param string $recipientId The id of the recipient to notify.
+ * @return bool True if the notification was successfully sent, false otherwise.
+ * @throws PayoutRecipientNotificationException
+ */
+ public function requestNotification(string $recipientId): bool
+ {
+ try {
+ $content = [];
+ $content["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);
+
+ $responseJson = $this->restCli->post("recipients/" . $recipientId . "/notifications", $content);
+ } catch (BitPayException $e) {
+ throw new PayoutRecipientNotificationException(
+ "failed to serialize PayoutRecipient object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new PayoutRecipientNotificationException(
+ "failed to serialize PayoutRecipient object : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $result = json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR);
+
+ return strtolower($result['status']) === "success";
+ } catch (Exception $e) {
+ throw new PayoutRecipientNotificationException(
+ "failed to deserialize BitPay server response (PayoutRecipient) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Client/RateClient.php b/src/BitPaySDK/Client/RateClient.php
new file mode 100644
index 00000000..436db58f
--- /dev/null
+++ b/src/BitPaySDK/Client/RateClient.php
@@ -0,0 +1,167 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class RateClient
+{
+ private static ?self $instance = null;
+ private RESTcli $restCli;
+
+ private function __construct(RESTcli $restCli)
+ {
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Rate Client.
+ *
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
+ *
+ * @return Rates
+ * @throws BitPayException
+ */
+ public function getRates(): Rates
+ {
+ try {
+ $responseJson = $this->restCli->get("rates", null, false);
+ } catch (BitPayException $e) {
+ throw new RateQueryException(
+ "failed to serialize Rates object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException("failed to serialize Rates object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+ $rates = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Rate::class
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException(
+ "failed to deserialize BitPay server response (Rates) : " . $e->getMessage()
+ );
+ }
+
+ return new Rates($rates);
+ }
+
+ /**
+ * Retrieve all the rates for a given cryptocurrency
+ *
+ * @param string $baseCurrency The cryptocurrency for which you want to fetch the rates.
+ * Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+ * @return Rates A Rates object populated with the currency rates for the requested baseCurrency.
+ * @throws BitPayException
+ */
+ public function getCurrencyRates(string $baseCurrency): Rates
+ {
+ try {
+ $responseJson = $this->restCli->get("rates/" . $baseCurrency, null, false);
+ } catch (BitPayException $e) {
+ throw new RateQueryException(
+ "failed to serialize Rates object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException("failed to serialize Rates object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+ $rates = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Rate::class
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException(
+ "failed to deserialize BitPay server response (Rates) : " . $e->getMessage()
+ );
+ }
+
+ return new Rates($rates);
+ }
+
+ /**
+ * Retrieve the rate for a cryptocurrency / fiat pair
+ *
+ * @param string $baseCurrency The cryptocurrency for which you want to fetch the fiat-equivalent rate.
+ * Current supported values are BTC, BCH, ETH, XRP, DOGE and LTC
+ * @param string $currency The fiat currency for which you want to fetch the baseCurrency rate
+ * @return Rate A Rate object populated with the currency rate for the requested baseCurrency.
+ * @throws BitPayException
+ */
+ public function getCurrencyPairRate(string $baseCurrency, string $currency): Rate
+ {
+ try {
+ $responseJson = $this->restCli->get("rates/" . $baseCurrency . "/" . $currency, null, false);
+ } catch (BitPayException $e) {
+ throw new RateQueryException(
+ "failed to serialize Rates object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException("failed to serialize Rate object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Rate()
+ );
+ } catch (Exception $e) {
+ throw new RateQueryException(
+ "failed to deserialize BitPay server response (Rate) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Client/RefundClient.php b/src/BitPaySDK/Client/RefundClient.php
new file mode 100644
index 00000000..431baf75
--- /dev/null
+++ b/src/BitPaySDK/Client/RefundClient.php
@@ -0,0 +1,473 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class RefundClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Bill Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new RefundClient($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Create a refund for a BitPay invoice.
+ *
+ * @param string $invoiceId The BitPay invoice Id having the associated refund to be created.
+ * @param float $amount Amount to be refunded in the currency indicated.
+ * @param string $currency Reference currency used for the refund, usually the same as the currency used
+ * to create the invoice.
+ * @param bool $preview Whether to create the refund request as a preview (which will not be acted on
+ * until status is updated)
+ * @param bool $immediate Whether funds should be removed from merchant ledger immediately on submission
+ * or at time of processing
+ * @param bool $buyerPaysRefundFee Whether the buyer should pay the refund fee (default is merchant)
+ * @param string|null $guid Variable provided by the merchant and designed to be used by the merchant to
+ * correlate the refund with a refund ID in their system
+ * @return Refund $refund An updated Refund Object
+ * @throws RefundCreationException RefundCreationException class
+ * @throws BitPayException BitPayException class*@throws Exception
+ * @throws Exception
+ * @since 7.2.0)
+ */
+ public function create(
+ string $invoiceId,
+ float $amount,
+ string $currency,
+ bool $preview = false,
+ bool $immediate = false,
+ bool $buyerPaysRefundFee = false,
+ string $guid = null
+ ): Refund {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["invoiceId"] = $invoiceId;
+ $params["amount"] = $amount;
+ $params["currency"] = $currency;
+ $params["preview"] = $preview;
+ $params["immediate"] = $immediate;
+ $params["buyerPaysRefundFee"] = $buyerPaysRefundFee;
+ $params["guid"] = $guid ?: Util::guid();
+
+ try {
+ $responseJson = $this->restCli->post("refunds/", $params, true);
+ } catch (BitPayException $e) {
+ throw new RefundCreationException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundCreationException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundCreationException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Update the status of a BitPay invoice.
+ *
+ * @param string $refundId BitPay refund ID.
+ * @param string $status The new status for the refund to be updated.
+ * @return Refund $refund Refund A BitPay generated Refund object.
+ * @throws RefundUpdateException
+ * @throws BitPayException
+ * @throws Exception
+ */
+ public function update(
+ string $refundId,
+ string $status
+ ): Refund {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["status"] = $status;
+
+ try {
+ $responseJson = $this->restCli->update("refunds/" . $refundId, $params);
+ } catch (BitPayException $e) {
+ throw new RefundUpdateException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundUpdateException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundUpdateException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Update the status of a BitPay invoice.
+ *
+ * @param string $guid BitPay refund Guid.
+ * @param string $status The new status for the refund to be updated.
+ * @return Refund $refund Refund A BitPay generated Refund object.
+ * @throws RefundUpdateException
+ * @throws BitPayException
+ * @throws Exception
+ * @since 7.2.0
+ */
+ public function updateByGuid(
+ string $guid,
+ string $status
+ ): Refund {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["status"] = $status;
+
+ try {
+ $responseJson = $this->restCli->update("refunds/guid/" . $guid, $params);
+ } catch (BitPayException $e) {
+ throw new RefundUpdateException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundUpdateException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundUpdateException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve all refund requests on a BitPay invoice.
+ *
+ * @param string $invoiceId The BitPay invoice object having the associated refunds.
+ * @return Refund[]
+ * @throws RefundQueryException
+ * @throws BitPayException
+ * @throws Exception
+ */
+ public function getRefunds(
+ string $invoiceId
+ ): array {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["invoiceId"] = $invoiceId;
+
+ try {
+ $responseJson = $this->restCli->get("refunds/", $params, true);
+ } catch (BitPayException $e) {
+ throw new RefundQueryException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Refund::class
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a previously made refund request on a BitPay invoice.
+ *
+ * @param string $refundId The BitPay refund ID.
+ * @return Refund $refund BitPay Refund object with the associated Refund object.
+ * @throws RefundQueryException
+ * @throws BitPayException
+ * @throws Exception
+ */
+ public function get(
+ string $refundId
+ ): Refund {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ try {
+ $responseJson = $this->restCli->get("refunds/" . $refundId, $params, true);
+ } catch (BitPayException $e) {
+ throw new RefundQueryException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieve a previously made refund request on a BitPay invoice by guid.
+ *
+ * @param string $guid The BitPay refund Guid.
+ * @return Refund $refund BitPay Refund object with the associated Refund object.
+ * @throws RefundQueryException
+ * @throws BitPayException
+ * @throws Exception
+ * @since 7.2.0
+ */
+ public function getByGuid(string $guid): Refund
+ {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ try {
+ $responseJson = $this->restCli->get("refunds/guid/" . $guid, $params, true);
+ } catch (BitPayException $e) {
+ throw new RefundQueryException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundQueryException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Send a refund notification.
+ *
+ * @param string $refundId A BitPay refund ID.
+ * @return bool $result An updated Refund Object
+ * @throws BitPayException
+ * @throws Exception
+ */
+ public function sendNotification(string $refundId): bool
+ {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ try {
+ $responseJson = $this->restCli->post("refunds/" . $refundId . "/notifications", $params, true);
+ } catch (BitPayException $e) {
+ throw new RefundNotificationException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundNotificationException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $result = json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR);
+
+ return $result['status'] === "success";
+ } catch (Exception $e) {
+ throw new RefundNotificationException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Cancel a previously submitted refund request on a BitPay invoice.
+ *
+ * @param string $refundId The refund Id for the refund to be canceled.
+ * @return Refund $refund Cancelled refund Object.
+ * @throws RefundCancellationException
+ * @throws BitPayException
+ * @throws Exception
+ */
+ public function cancel(string $refundId): Refund
+ {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ try {
+ $responseJson = $this->restCli->delete("refunds/" . $refundId, $params);
+ } catch (BitPayException $e) {
+ throw new RefundCancellationException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundCancellationException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundCancellationException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Cancel a previously submitted refund request on a BitPay invoice.
+ *
+ * @param string $guid The refund Guid for the refund to be canceled.
+ * @return Refund $refund Cancelled refund Object.
+ * @throws RefundCancellationException
+ * @throws BitPayException
+ * @throws Exception
+ * @since 7.2.0
+ */
+ public function cancelByGuid(string $guid): Refund
+ {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ try {
+ $responseJson = $this->restCli->delete("refunds/guid/" . $guid, $params);
+ } catch (BitPayException $e) {
+ throw new RefundCancellationException(
+ "failed to serialize refund object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new RefundCancellationException("failed to serialize refund object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Refund()
+ );
+ } catch (Exception $e) {
+ throw new RefundCancellationException(
+ "failed to deserialize BitPay server response (Refund) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Client/SettlementClient.php b/src/BitPaySDK/Client/SettlementClient.php
new file mode 100644
index 00000000..98c57191
--- /dev/null
+++ b/src/BitPaySDK/Client/SettlementClient.php
@@ -0,0 +1,203 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class SettlementClient
+{
+ private static ?self $instance = null;
+ private Tokens $tokenCache;
+ private RESTcli $restCli;
+
+ private function __construct(Tokens $tokenCache, RESTcli $restCli)
+ {
+ $this->tokenCache = $tokenCache;
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Settlements Client.
+ *
+ * @param Tokens $tokenCache
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(Tokens $tokenCache, RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($tokenCache, $restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Retrieves settlement reports for the calling merchant filtered by query.
+ * The `limit` and `offset` parameters
+ * specify pages for large query sets.
+ *
+ * @param string $currency The three digit currency string for the ledger to retrieve.
+ * @param string $dateStart The start date for the query.
+ * @param string $dateEnd The end date for the query.
+ * @param string|null $status string Can be `processing`, `completed`, or `failed`.
+ * @param int|null $limit int Maximum number of settlements to retrieve.
+ * @param int|null $offset int Offset for paging.
+ * @return Settlement[]
+ * @throws SettlementQueryException
+ */
+ public function getSettlements(
+ string $currency,
+ string $dateStart,
+ string $dateEnd,
+ string $status = null,
+ int $limit = null,
+ int $offset = null
+ ): array {
+ try {
+ $status = $status ?? "";
+ $limit = $limit ?? 100;
+ $offset = $offset ?? 0;
+
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+ $params["dateStart"] = $dateStart;
+ $params["dateEnd"] = $dateEnd;
+ $params["currency"] = $currency;
+ $params["status"] = $status;
+ $params["limit"] = (string)$limit;
+ $params["offset"] = (string)$offset;
+
+ $responseJson = $this->restCli->get("settlements", $params);
+ } catch (BitPayException $e) {
+ throw new SettlementQueryException(
+ "failed to serialize Settlement object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException("failed to serialize Settlement object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Settlement::class
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException(
+ "failed to deserialize BitPay server response (Settlement) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Retrieves a summary of the specified settlement.
+ *
+ * @param string $settlementId Settlement Id.
+ * @return Settlement
+ * @throws BitPayException
+ */
+ public function get(string $settlementId): Settlement
+ {
+ try {
+ $params = [];
+ $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);
+
+ $responseJson = $this->restCli->get("settlements/" . $settlementId, $params);
+ } catch (BitPayException $e) {
+ throw new SettlementQueryException(
+ "failed to serialize Settlement object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException("failed to serialize Settlement object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Settlement()
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException(
+ "failed to deserialize BitPay server response (Settlement) : " . $e->getMessage()
+ );
+ }
+ }
+
+ /**
+ * Gets a detailed reconciliation report of the activity within the settlement period.
+ *
+ * @param Settlement $settlement Settlement to generate report for.
+ * @return Settlement
+ * @throws BitPayException
+ */
+ public function getReconciliationReport(Settlement $settlement): Settlement
+ {
+ try {
+ $params = [];
+ $params["token"] = $settlement->getToken();
+
+ $responseJson = $this->restCli->get(
+ "settlements/" . $settlement->getId() . "/reconciliationReport",
+ $params
+ );
+ } catch (BitPayException $e) {
+ throw new SettlementQueryException(
+ "failed to serialize Reconciliation Report object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException(
+ "failed to serialize Reconciliation Report object : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->map(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ new Settlement()
+ );
+ } catch (Exception $e) {
+ throw new SettlementQueryException(
+ "failed to deserialize BitPay server response (Reconciliation Report) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Client/TokenClient.php b/src/BitPaySDK/Client/TokenClient.php
new file mode 100644
index 00000000..fad10187
--- /dev/null
+++ b/src/BitPaySDK/Client/TokenClient.php
@@ -0,0 +1,57 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class TokenClient
+{
+ private static ?self $instance = null;
+ private RESTcli $restCli;
+
+ private function __construct(RESTcli $restCli)
+ {
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Token Client.
+ *
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Get Tokens.
+ *
+ * @throws \BitPaySDK\Exceptions\BitPayException
+ * @throws \JsonException
+ */
+ public function getTokens(): array
+ {
+ $response = $this->restCli->get('tokens');
+
+ return json_decode($response, true, 512, JSON_THROW_ON_ERROR);
+ }
+}
diff --git a/src/BitPaySDK/Client/WalletClient.php b/src/BitPaySDK/Client/WalletClient.php
new file mode 100644
index 00000000..94971b4a
--- /dev/null
+++ b/src/BitPaySDK/Client/WalletClient.php
@@ -0,0 +1,89 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class WalletClient
+{
+ private static ?self $instance = null;
+ private RESTcli $restCli;
+
+ private function __construct(RESTcli $restCli)
+ {
+ $this->restCli = $restCli;
+ }
+
+ /**
+ * Factory method for Wallet Client.
+ *
+ * @param RESTcli $restCli
+ * @return static
+ */
+ public static function getInstance(RESTcli $restCli): self
+ {
+ if (!self::$instance) {
+ self::$instance = new self($restCli);
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Retrieve all supported wallets.
+ *
+ * @return Wallet[]
+ * @throws WalletQueryException
+ * @throws BitPayException
+ */
+ public function getSupportedWallets(): array
+ {
+ try {
+ $responseJson = $this->restCli->get("supportedWallets/", null, false);
+ } catch (BitPayException $e) {
+ throw new WalletQueryException(
+ "failed to serialize Wallet object : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new WalletQueryException(
+ "failed to deserialize BitPay server response (Wallet) : " . $e->getMessage()
+ );
+ }
+
+ try {
+ $mapper = JsonMapperFactory::create();
+
+ return $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Wallet::class
+ );
+ } catch (Exception $e) {
+ throw new WalletQueryException(
+ "failed to deserialize BitPay server response (Wallet) : " . $e->getMessage()
+ );
+ }
+ }
+}
diff --git a/src/BitPaySDK/Config.php b/src/BitPaySDK/Config.php
deleted file mode 100644
index ed8f860f..00000000
--- a/src/BitPaySDK/Config.php
+++ /dev/null
@@ -1,53 +0,0 @@
-_environment;
- }
-
- /**
- * @param $environment
- */
- public function setEnvironment($environment)
- {
- $this->_environment = $environment;
- }
-
- /**
- * @return mixed
- */
- public function getEnvConfig()
- {
- return $this->_envConfig;
- }
-
- /**
- * @param $envConfig
- */
- public function setEnvConfig($envConfig)
- {
- $this->_envConfig = $envConfig;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Env.php b/src/BitPaySDK/Env.php
index 0c328bd4..29de8cd8 100644
--- a/src/BitPaySDK/Env.php
+++ b/src/BitPaySDK/Env.php
@@ -1,17 +1,23 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
interface Env
{
- const Test = "Test";
- const Prod = "Prod";
- const TestUrl = "https://test.bitpay.com/";
- const ProdUrl = "https://bitpay.com/";
- const BitpayApiVersion = "2.0.0";
- const BitpayPluginInfo = "BitPay_PHP_Client_v3.5.2003";
- const BitpayApiFrame = "custom";
- const BitpayApiFrameVersion = "1.0.0";
-}
\ No newline at end of file
+ public const TEST = "Test";
+ public const PROD = "Prod";
+ public const TEST_URL = "https://test.bitpay.com/";
+ public const PROD_URL = "https://bitpay.com/";
+ public const BITPAY_API_VERSION = "2.0.0";
+ public const BITPAY_PLUGIN_INFO = "BitPay_PHP_Client_v8.0.2";
+ public const BITPAY_API_FRAME = "std";
+ public const BITPAY_API_FRAME_VERSION = "1.0.0";
+}
diff --git a/src/BitPaySDK/Exceptions/BillCreationException.php b/src/BitPaySDK/Exceptions/BillCreationException.php
index 8bec9549..d5df3ba2 100644
--- a/src/BitPaySDK/Exceptions/BillCreationException.php
+++ b/src/BitPaySDK/Exceptions/BillCreationException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BillCreationException extends BillException
{
- private $bitPayMessage = "Failed to create bill";
- private $bitPayCode = "BITPAY-BILL-CREATE";
+ private string $bitPayMessage = "Failed to create bill";
+ private string $bitPayCode = "BITPAY-BILL-CREATE";
/**
* Construct the BillCreationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 112)
+ public function __construct($message = "", $code = 112, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/BillDeliveryException.php b/src/BitPaySDK/Exceptions/BillDeliveryException.php
index 2bc90ddd..2c61e5b8 100644
--- a/src/BitPaySDK/Exceptions/BillDeliveryException.php
+++ b/src/BitPaySDK/Exceptions/BillDeliveryException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BillDeliveryException extends BillException
{
- private $bitPayMessage = "Failed to deliver bill";
- private $bitPayCode = "BITPAY-BILL-DELIVERY";
+ private string $bitPayMessage = "Failed to deliver bill";
+ private string $bitPayCode = "BITPAY-BILL-DELIVERY";
/**
* Construct the BillDeliveryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 115)
+ public function __construct($message = "", $code = 115, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/BillException.php b/src/BitPaySDK/Exceptions/BillException.php
index 2d8478e6..587f7a8d 100644
--- a/src/BitPaySDK/Exceptions/BillException.php
+++ b/src/BitPaySDK/Exceptions/BillException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BillException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the bill";
- private $bitPayCode = "BITPAY-BILL-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the bill";
+ private string $bitPayCode = "BITPAY-BILL-GENERIC";
/**
* Construct the BillException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 111)
+ public function __construct($message = "", $code = 111, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/BillQueryException.php b/src/BitPaySDK/Exceptions/BillQueryException.php
index 93378939..6c799b1a 100644
--- a/src/BitPaySDK/Exceptions/BillQueryException.php
+++ b/src/BitPaySDK/Exceptions/BillQueryException.php
@@ -1,25 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BillQueryException extends BillException
{
- private $bitPayMessage = "Failed to retrieve bill";
- private $bitPayCode = "BITPAY-BILL-GET";
+ private string $bitPayMessage = "Failed to retrieve bill";
+ private string $bitPayCode = "BITPAY-BILL-GET";
/**
* Construct the BillQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 113)
+ public function __construct($message = "", $code = 113, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/BillUpdateException.php b/src/BitPaySDK/Exceptions/BillUpdateException.php
index 6a26ac02..15300ad8 100644
--- a/src/BitPaySDK/Exceptions/BillUpdateException.php
+++ b/src/BitPaySDK/Exceptions/BillUpdateException.php
@@ -1,25 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BillUpdateException extends BillException
{
- private $bitPayMessage = "Failed to update bill";
- private $bitPayCode = "BITPAY-BILL-UPDATE";
+ private string $bitPayMessage = "Failed to update bill";
+ private string $bitPayCode = "BITPAY-BILL-UPDATE";
/**
* Construct the BillUpdateException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 114)
+ public function __construct($message = "", $code = 114, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/BitPayException.php b/src/BitPaySDK/Exceptions/BitPayException.php
index 02b143d5..cb3d1725 100644
--- a/src/BitPaySDK/Exceptions/BitPayException.php
+++ b/src/BitPaySDK/Exceptions/BitPayException.php
@@ -1,27 +1,50 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class BitPayException extends Exception
{
- private $bitPayMessage = "Unexpected Bitpay exeption.";
- private $bitPayCode = "BITPAY-GENERIC";
+ private string $bitPayMessage = "Unexpected Bitpay exeption.";
+ private string $bitPayCode = "BITPAY-GENERIC";
+ protected ?string $apiCode;
/**
* Construct the BitPayException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 100)
+ public function __construct($message = "", $code = 100, Exception $previous = null, ?string $apiCode = null)
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
+ $this->apiCode = $apiCode;
+ $code = $code ?? 100;
+ parent::__construct($message, $code, $previous);
+ }
- parent::__construct($message, $code);
+ /**
+ * @return string Error code provided by the BitPay REST API
+ */
+ public function getApiCode()
+ {
+ return $this->apiCode;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/CurrencyException.php b/src/BitPaySDK/Exceptions/CurrencyException.php
index f599898e..afe9a9de 100644
--- a/src/BitPaySDK/Exceptions/CurrencyException.php
+++ b/src/BitPaySDK/Exceptions/CurrencyException.php
@@ -1,25 +1,40 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class CurrencyException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the currencies";
- private $bitPayCode = "BITPAY-CURRENCY-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the currencies";
+ private string $bitPayCode = "BITPAY-CURRENCY-GENERIC";
/**
* Construct the CurrencyException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param Exception|null $previous
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 171)
+ public function __construct($message = "", $code = 181, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/CurrencyQueryException.php b/src/BitPaySDK/Exceptions/CurrencyQueryException.php
index 25ed4a11..44bb4bf5 100644
--- a/src/BitPaySDK/Exceptions/CurrencyQueryException.php
+++ b/src/BitPaySDK/Exceptions/CurrencyQueryException.php
@@ -1,25 +1,38 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class CurrencyQueryException extends CurrencyException
{
- private $bitPayMessage = "Failed to retrieve currencies";
- private $bitPayCode = "BITPAY-CURRENCY-GET";
+ private string $bitPayMessage = "Failed to retrieve currencies";
+ private string $bitPayCode = "BITPAY-CURRENCY-GET";
/**
* Construct the CurrencyQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 173)
+ public function __construct($message = "", $code = 182, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ $this->apiCode = $apiCode;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/InvoiceCancellationException.php b/src/BitPaySDK/Exceptions/InvoiceCancellationException.php
new file mode 100644
index 00000000..cade0a51
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/InvoiceCancellationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class InvoiceCancellationException extends InvoiceException
+{
+ private string $bitPayMessage = "Failed to cancel invoice object";
+ private string $bitPayCode = "BITPAY-INVOICE-CANCEL";
+
+ /**
+ * Construct the InvoiceCancellationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 105, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/InvoiceCreationException.php b/src/BitPaySDK/Exceptions/InvoiceCreationException.php
index 7a2b3af0..94e68698 100644
--- a/src/BitPaySDK/Exceptions/InvoiceCreationException.php
+++ b/src/BitPaySDK/Exceptions/InvoiceCreationException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class InvoiceCreationException extends InvoiceException
{
- private $bitPayMessage = "Failed to create invoice";
- private $bitPayCode = "BITPAY-INVOICE-CREATE";
+ private string $bitPayMessage = "Failed to create invoice";
+ private string $bitPayCode = "BITPAY-INVOICE-CREATE";
/**
* Construct the InvoiceCreationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 102)
+ public function __construct($message = "", $code = 102, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/InvoiceException.php b/src/BitPaySDK/Exceptions/InvoiceException.php
index b4c8eb40..0117ca61 100644
--- a/src/BitPaySDK/Exceptions/InvoiceException.php
+++ b/src/BitPaySDK/Exceptions/InvoiceException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class InvoiceException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the invoice";
- private $bitPayCode = "BITPAY-INVOICE-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the invoice";
+ private string $bitPayCode = "BITPAY-INVOICE-GENERIC";
/**
* Construct the InvoiceException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 101)
+ public function __construct($message = "", $code = 101, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/InvoicePaymentException.php b/src/BitPaySDK/Exceptions/InvoicePaymentException.php
new file mode 100644
index 00000000..49dddf8a
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/InvoicePaymentException.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class InvoicePaymentException extends InvoiceException
+{
+ private string $bitPayMessage = "Failed to pay invoice";
+ private string $bitPayCode = "BITPAY-INVOICE-PAY-UPDATE";
+
+ /**
+ * Construct the InvoicePaymentException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 107, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ $this->apiCode = $apiCode;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/InvoiceQueryException.php b/src/BitPaySDK/Exceptions/InvoiceQueryException.php
index 7aee9a89..60c0fb73 100644
--- a/src/BitPaySDK/Exceptions/InvoiceQueryException.php
+++ b/src/BitPaySDK/Exceptions/InvoiceQueryException.php
@@ -1,24 +1,38 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class InvoiceQueryException extends InvoiceException
{
- private $bitPayMessage = "Failed to retrieve invoice";
- private $bitPayCode = "BITPAY-INVOICE-GET";
+ private string $bitPayMessage = "Failed to retrieve invoice";
+ private string $bitPayCode = "BITPAY-INVOICE-GET";
+ protected ?string $apiCode;
/**
* Construct the InvoiceQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 103)
+ public function __construct($message = "", $code = 103, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/InvoiceUpdateException.php b/src/BitPaySDK/Exceptions/InvoiceUpdateException.php
new file mode 100644
index 00000000..30c36b79
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/InvoiceUpdateException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class InvoiceUpdateException extends InvoiceException
+{
+ private string $bitPayMessage = "Failed to update invoice";
+ private string $bitPayCode = "BITPAY-INVOICE-UPDATE";
+
+ /**
+ * Construct the InvoiceUpdateException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 104, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/LedgerException.php b/src/BitPaySDK/Exceptions/LedgerException.php
index 227f50c6..ca34d296 100644
--- a/src/BitPaySDK/Exceptions/LedgerException.php
+++ b/src/BitPaySDK/Exceptions/LedgerException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class LedgerException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the ledger";
- private $bitPayCode = "BITPAY-LEDGER-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the ledger";
+ private string $bitPayCode = "BITPAY-LEDGER-GENERIC";
/**
* Construct the LedgerException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 131)
+ public function __construct($message = "", $code = 131, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/LedgerQueryException.php b/src/BitPaySDK/Exceptions/LedgerQueryException.php
index 138d3fed..3e826673 100644
--- a/src/BitPaySDK/Exceptions/LedgerQueryException.php
+++ b/src/BitPaySDK/Exceptions/LedgerQueryException.php
@@ -1,24 +1,38 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class LedgerQueryException extends LedgerException
{
- private $bitPayMessage = "Failed to retrieve ledger";
- private $bitPayCode = "BITPAY-LEDGER-GET";
+ private string $bitPayMessage = "Failed to retrieve ledger";
+ private string $bitPayCode = "BITPAY-LEDGER-GET";
/**
* Construct the LedgerQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 132)
+ public function __construct($message = "", $code = 132, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ $this->apiCode = $apiCode;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutBatchCancellationException.php b/src/BitPaySDK/Exceptions/PayoutBatchCancellationException.php
new file mode 100644
index 00000000..97bcf758
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutBatchCancellationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutBatchCancellationException extends PayoutBatchException
+{
+ private string $bitPayMessage = "Failed to cancel payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-CANCEL";
+
+ /**
+ * Construct the PayoutBatchCancellationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 204, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutBatchCreationException.php b/src/BitPaySDK/Exceptions/PayoutBatchCreationException.php
new file mode 100644
index 00000000..ac255512
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutBatchCreationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutBatchCreationException extends PayoutBatchException
+{
+ private string $bitPayMessage = "Failed to create payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-SUBMIT";
+
+ /**
+ * Construct the PayoutBatchCreationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 202, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutBatchException.php b/src/BitPaySDK/Exceptions/PayoutBatchException.php
new file mode 100644
index 00000000..57545813
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutBatchException.php
@@ -0,0 +1,39 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutBatchException extends BitPayException
+{
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-GENERIC";
+
+ /**
+ * Construct the PayoutBatchException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 201, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ if (!$message) {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ }
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutBatchNotificationException.php b/src/BitPaySDK/Exceptions/PayoutBatchNotificationException.php
new file mode 100644
index 00000000..cea24560
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutBatchNotificationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutBatchNotificationException extends PayoutBatchException
+{
+ private string $bitPayMessage = "Failed to send payout batch notification";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-NOTIFICATION";
+
+ /**
+ * Construct the PayoutBatchNotificationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 205, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutBatchQueryException.php b/src/BitPaySDK/Exceptions/PayoutBatchQueryException.php
new file mode 100644
index 00000000..db4e761c
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutBatchQueryException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutBatchQueryException extends PayoutBatchException
+{
+ private string $bitPayMessage = "Failed to retrieve payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-GET";
+
+ /**
+ * Construct the PayoutBatchQueryException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 203, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutCancellationException.php b/src/BitPaySDK/Exceptions/PayoutCancellationException.php
index 832b6653..3a4a9494 100644
--- a/src/BitPaySDK/Exceptions/PayoutCancellationException.php
+++ b/src/BitPaySDK/Exceptions/PayoutCancellationException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class PayoutCancellationException extends PayoutException
{
- private $bitPayMessage = "Failed to cancel payout batch";
- private $bitPayCode = "BITPAY-PAYOUT-BATCH-CANCEL";
+ private string $bitPayMessage = "Failed to cancel payout";
+ private string $bitPayCode = "BITPAY-PAYOUT-CANCEL";
/**
* Construct the PayoutCancellationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 124)
+ public function __construct($message = "", $code = 124, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutCreationException.php b/src/BitPaySDK/Exceptions/PayoutCreationException.php
index 2ba4c3fb..febcee79 100644
--- a/src/BitPaySDK/Exceptions/PayoutCreationException.php
+++ b/src/BitPaySDK/Exceptions/PayoutCreationException.php
@@ -1,25 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutCreationException extends PayoutException
{
- private $bitPayMessage = "Failed to create payout batch";
- private $bitPayCode = "BITPAY-PAYOUT-BATCH-SUBMIT";
+ private string $bitPayMessage = "Failed to create payout";
+ private string $bitPayCode = "BITPAY-PAYOUT-SUBMIT";
/**
* Construct the PayoutCreationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 122)
+ public function __construct($message = "", $code = 122, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutException.php b/src/BitPaySDK/Exceptions/PayoutException.php
index e34ec301..853b5cf2 100644
--- a/src/BitPaySDK/Exceptions/PayoutException.php
+++ b/src/BitPaySDK/Exceptions/PayoutException.php
@@ -1,25 +1,40 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class PayoutException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the payout batch";
- private $bitPayCode = "BITPAY-PAYOUT-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the payout";
+ private string $bitPayCode = "BITPAY-PAYOUT-GENERIC";
/**
* Construct the PayoutException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 121)
+ public function __construct($message = "", $code = 121, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutNotificationException.php b/src/BitPaySDK/Exceptions/PayoutNotificationException.php
new file mode 100644
index 00000000..4f625e52
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutNotificationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutNotificationException extends PayoutException
+{
+ private string $bitPayMessage = "Failed to send payout notification";
+ private string $bitPayCode = "BITPAY-PAYOUT-NOTIFICATION";
+
+ /**
+ * Construct the PayoutNotificationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 126, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutQueryException.php b/src/BitPaySDK/Exceptions/PayoutQueryException.php
index cb4b5f97..9722cca0 100644
--- a/src/BitPaySDK/Exceptions/PayoutQueryException.php
+++ b/src/BitPaySDK/Exceptions/PayoutQueryException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class PayoutQueryException extends PayoutException
{
- private $bitPayMessage = "Failed to retrieve payout batch";
- private $bitPayCode = "BITPAY-PAYOUT-BATCH-GET";
+ private string $bitPayMessage = "Failed to retrieve payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-GET";
/**
* Construct the PayoutQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 123)
+ public function __construct($message = "", $code = 123, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientCancellationException.php b/src/BitPaySDK/Exceptions/PayoutRecipientCancellationException.php
new file mode 100644
index 00000000..627f4f02
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientCancellationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientCancellationException extends PayoutRecipientException
+{
+ private string $bitPayMessage = "Failed to cancel payout recipient";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-CANCEL";
+
+ /**
+ * Construct the PayoutRecipientCancellationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 194, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientCreationException.php b/src/BitPaySDK/Exceptions/PayoutRecipientCreationException.php
new file mode 100644
index 00000000..efe7272b
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientCreationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientCreationException extends PayoutRecipientException
+{
+ private string $bitPayMessage = "Failed to create payout recipient";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-SUBMIT";
+
+ /**
+ * Construct the PayoutRecipientCreationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 192, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientException.php b/src/BitPaySDK/Exceptions/PayoutRecipientException.php
new file mode 100644
index 00000000..6857cd5f
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientException.php
@@ -0,0 +1,39 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientException extends BitPayException
+{
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the payout recipient";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-GENERIC";
+
+ /**
+ * Construct the PayoutRecipientException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 191, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ if (!$message) {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ }
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientNotificationException.php b/src/BitPaySDK/Exceptions/PayoutRecipientNotificationException.php
new file mode 100644
index 00000000..d7d34b49
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientNotificationException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientNotificationException extends PayoutRecipientException
+{
+ private string $bitPayMessage = "Failed to send payout recipient notification";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-NOTIFICATION";
+
+ /**
+ * Construct the PayoutRecipientNotificationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 196, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientQueryException.php b/src/BitPaySDK/Exceptions/PayoutRecipientQueryException.php
new file mode 100644
index 00000000..6af932ba
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientQueryException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientQueryException extends PayoutRecipientException
+{
+ private string $bitPayMessage = "Failed to retrieve payout recipient";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-GET";
+
+ /**
+ * Construct the PayoutRecipientQueryException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 193, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutRecipientUpdateException.php b/src/BitPaySDK/Exceptions/PayoutRecipientUpdateException.php
new file mode 100644
index 00000000..5b30bf24
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutRecipientUpdateException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutRecipientUpdateException extends PayoutRecipientException
+{
+ private string $bitPayMessage = "Failed to update payout recipient";
+ private string $bitPayCode = "BITPAY-PAYOUT-RECIPIENT-UPDATE";
+
+ /**
+ * Construct the PayoutRecipientUpdateException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 195, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/PayoutUpdateException.php b/src/BitPaySDK/Exceptions/PayoutUpdateException.php
new file mode 100755
index 00000000..79df4770
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/PayoutUpdateException.php
@@ -0,0 +1,37 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutUpdateException extends PayoutException
+{
+ private string $bitPayMessage = "Failed to update payout batch";
+ private string $bitPayCode = "BITPAY-PAYOUT-BATCH-UPDATE";
+
+ /**
+ * Construct the PayoutUpdateException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 125, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/RateException.php b/src/BitPaySDK/Exceptions/RateException.php
index 95d0285a..f398fd41 100644
--- a/src/BitPaySDK/Exceptions/RateException.php
+++ b/src/BitPaySDK/Exceptions/RateException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RateException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the rates";
- private $bitPayCode = "BITPAY-RATES-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the rates";
+ private string $bitPayCode = "BITPAY-RATES-GENERIC";
/**
* Construct the RateException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 141)
+ public function __construct($message = "", $code = 141, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RateQueryException.php b/src/BitPaySDK/Exceptions/RateQueryException.php
index ce4063e7..4a5003b5 100644
--- a/src/BitPaySDK/Exceptions/RateQueryException.php
+++ b/src/BitPaySDK/Exceptions/RateQueryException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RateQueryException extends RateException
{
- private $bitPayMessage = "Failed to retrieve rates";
- private $bitPayCode = "BITPAY-RATES-GET";
+ private string $bitPayMessage = "Failed to retrieve rates";
+ private string $bitPayCode = "BITPAY-RATES-GET";
/**
* Construct the RateQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 142)
+ public function __construct($message = "", $code = 142, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RefundCancellationException.php b/src/BitPaySDK/Exceptions/RefundCancellationException.php
index 12b62d05..d244c705 100644
--- a/src/BitPaySDK/Exceptions/RefundCancellationException.php
+++ b/src/BitPaySDK/Exceptions/RefundCancellationException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RefundCancellationException extends RefundException
{
- private $bitPayMessage = "Failed to cancel refund batch";
- private $bitPayCode = "BITPAY-REFUND-CANCEL";
+ private string $bitPayMessage = "Failed to cancel refund object";
+ private string $bitPayCode = "BITPAY-REFUND-CANCEL";
/**
* Construct the RefundCancellationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 164)
+ public function __construct($message = "", $code = 165, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RefundCreationException.php b/src/BitPaySDK/Exceptions/RefundCreationException.php
index 2f728569..ba3667c1 100644
--- a/src/BitPaySDK/Exceptions/RefundCreationException.php
+++ b/src/BitPaySDK/Exceptions/RefundCreationException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RefundCreationException extends RefundException
{
- private $bitPayMessage = "Failed to create refund";
- private $bitPayCode = "BITPAY-REFUND-CREATE";
+ private string $bitPayMessage = "Failed to create refund";
+ private string $bitPayCode = "BITPAY-REFUND-CREATE";
/**
* Construct the RefundCreationException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 162)
+ public function __construct($message = "", $code = 162, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RefundException.php b/src/BitPaySDK/Exceptions/RefundException.php
index f1b5262f..55ada224 100644
--- a/src/BitPaySDK/Exceptions/RefundException.php
+++ b/src/BitPaySDK/Exceptions/RefundException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RefundException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the refund";
- private $bitPayCode = "BITPAY-REFUND-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the refund";
+ private string $bitPayCode = "BITPAY-REFUND-GENERIC";
/**
* Construct the RefundException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 161)
+ public function __construct($message = "", $code = 161, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RefundNotificationException.php b/src/BitPaySDK/Exceptions/RefundNotificationException.php
new file mode 100644
index 00000000..a16c1b37
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/RefundNotificationException.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class RefundNotificationException extends RefundException
+{
+ private string $bitPayMessage = "Failed to send refund notification";
+ private string $bitPayCode = "BITPAY-REFUND-NOTIFICATION";
+
+ /**
+ * Construct the RefundNotificationException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 166, Exception $previous = null, ?string $apiCode = "000000")
+ {
+
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/RefundQueryException.php b/src/BitPaySDK/Exceptions/RefundQueryException.php
index f7941938..e4b5b2be 100644
--- a/src/BitPaySDK/Exceptions/RefundQueryException.php
+++ b/src/BitPaySDK/Exceptions/RefundQueryException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RefundQueryException extends RefundException
{
- private $bitPayMessage = "Failed to retrieve refund";
- private $bitPayCode = "BITPAY-REFUND-GET";
+ private string $bitPayMessage = "Failed to retrieve refund";
+ private string $bitPayCode = "BITPAY-REFUND-GET";
/**
* Construct the RefundQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 163)
+ public function __construct($message = "", $code = 163, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/RefundUpdateException.php b/src/BitPaySDK/Exceptions/RefundUpdateException.php
new file mode 100644
index 00000000..8b6c4f0f
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/RefundUpdateException.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class RefundUpdateException extends RefundException
+{
+ private string $bitPayMessage = "Failed to update refund";
+ private string $bitPayCode = "BITPAY-REFUND-UPDATE";
+
+ /**
+ * Construct the RefundUpdateException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 164, Exception $previous = null, ?string $apiCode = "000000")
+ {
+
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/SettlementException.php b/src/BitPaySDK/Exceptions/SettlementException.php
index 2b1a6d6e..49ddc54e 100644
--- a/src/BitPaySDK/Exceptions/SettlementException.php
+++ b/src/BitPaySDK/Exceptions/SettlementException.php
@@ -1,25 +1,39 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class SettlementException extends BitPayException
{
- private $bitPayMessage = "An unexpected error occurred while trying to manage the settlements";
- private $bitPayCode = "BITPAY-SETTLEMENTS-GENERIC";
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the settlements";
+ private string $bitPayCode = "BITPAY-SETTLEMENTS-GENERIC";
/**
* Construct the SettlementException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 151)
+ public function __construct($message = "", $code = 151, Exception $previous = null, ?string $apiCode = "000000")
{
if (!$message) {
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
}
-
- parent::__construct($message, $code);
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/SettlementQueryException.php b/src/BitPaySDK/Exceptions/SettlementQueryException.php
index 3f3a233b..d432b27c 100644
--- a/src/BitPaySDK/Exceptions/SettlementQueryException.php
+++ b/src/BitPaySDK/Exceptions/SettlementQueryException.php
@@ -1,24 +1,37 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class SettlementQueryException extends SettlementException
{
- private $bitPayMessage = "Failed to retrieve settlements";
- private $bitPayCode = "BITPAY-SETTLEMENTS-GET";
+ private string $bitPayMessage = "Failed to retrieve settlements";
+ private string $bitPayCode = "BITPAY-SETTLEMENTS-GET";
/**
* Construct the SettlementQueryException.
*
* @param string $message [optional] The Exception message to throw.
- * @param int $code [optional] The Exception code to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
*/
- public function __construct($message = "", $code = 152)
+ public function __construct($message = "", $code = 152, Exception $previous = null, ?string $apiCode = "000000")
{
-
- $message = $this->bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Exceptions/SubscriptionCreationException.php b/src/BitPaySDK/Exceptions/SubscriptionCreationException.php
deleted file mode 100644
index 123e4728..00000000
--- a/src/BitPaySDK/Exceptions/SubscriptionCreationException.php
+++ /dev/null
@@ -1,24 +0,0 @@
-bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Exceptions/SubscriptionException.php b/src/BitPaySDK/Exceptions/SubscriptionException.php
deleted file mode 100644
index 3fa82f52..00000000
--- a/src/BitPaySDK/Exceptions/SubscriptionException.php
+++ /dev/null
@@ -1,25 +0,0 @@
-bitPayCode.": ".$this->bitPayMessage."-> ".$message;
- }
-
- parent::__construct($message, $code);
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Exceptions/SubscriptionQueryException.php b/src/BitPaySDK/Exceptions/SubscriptionQueryException.php
deleted file mode 100644
index 2d0db678..00000000
--- a/src/BitPaySDK/Exceptions/SubscriptionQueryException.php
+++ /dev/null
@@ -1,25 +0,0 @@
-bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Exceptions/SubscriptionUpdateException.php b/src/BitPaySDK/Exceptions/SubscriptionUpdateException.php
deleted file mode 100644
index 9523e622..00000000
--- a/src/BitPaySDK/Exceptions/SubscriptionUpdateException.php
+++ /dev/null
@@ -1,25 +0,0 @@
-bitPayCode.": ".$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, $code);
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Exceptions/WalletException.php b/src/BitPaySDK/Exceptions/WalletException.php
new file mode 100644
index 00000000..b7188e93
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/WalletException.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class WalletException extends BitPayException
+{
+ private string $bitPayMessage = "An unexpected error occurred while trying to manage the wallet";
+ private string $bitPayCode = "BITPAY-WALLET-GENERIC";
+
+ /**
+ * Construct the WalletException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 181, Exception $previous = null, ?string $apiCode = "000000")
+ {
+ if (!$message) {
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ }
+
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Exceptions/WalletQueryException.php b/src/BitPaySDK/Exceptions/WalletQueryException.php
new file mode 100644
index 00000000..fcf9563e
--- /dev/null
+++ b/src/BitPaySDK/Exceptions/WalletQueryException.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class WalletQueryException extends WalletException
+{
+ private string $bitPayMessage = "Failed to retrieve supported wallets";
+ private string $bitPayCode = "BITPAY-WALLET-GET";
+
+ /**
+ * Construct the WalletQueryException.
+ *
+ * @param string $message [optional] The Exception message to throw.
+ * @param int $code [optional] The Exception code to throw.
+ * @param string|null $apiCode [optional] The API Exception code to throw.
+ */
+ public function __construct($message = "", $code = 183, Exception $previous = null, ?string $apiCode = "000000")
+ {
+
+ $message = $this->bitPayCode . ": " . $this->bitPayMessage . "-> " . $message;
+ parent::__construct($message, $code, $previous, $apiCode);
+ }
+}
diff --git a/src/BitPaySDK/Model/Bill/Bill.php b/src/BitPaySDK/Model/Bill/Bill.php
index 6b6bc5ec..887e4cb6 100644
--- a/src/BitPaySDK/Model/Bill/Bill.php
+++ b/src/BitPaySDK/Model/Bill/Bill.php
@@ -1,47 +1,52 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
*/
class Bill
{
- protected $_currency;
- protected $_token = "";
- protected $_email;
- protected $_items;
- protected $_number;
- protected $_name;
- protected $_address1;
- protected $_address2;
- protected $_city;
- protected $_state;
- protected $_zip;
- protected $_country;
- protected $_cc;
- protected $_phone;
- protected $_dueDate;
- protected $_passProcessingFee;
- protected $_status;
- protected $_url;
- protected $_createDate;
- protected $_id;
- protected $_merchant;
+ protected ?string $currency = null;
+ protected ?string $token = null;
+ protected ?string $email = null;
+ protected array $items = [];
+ protected ?string $number = null;
+ protected ?string $name = null;
+ protected ?string $address1 = null;
+ protected ?string $address2 = null;
+ protected ?string $city = null;
+ protected ?string $state = null;
+ protected ?string $zip = null;
+ protected ?string $country = null;
+ protected ?array $cc = null;
+ protected ?string $phone = null;
+ protected ?string $dueDate = null;
+ protected ?bool $passProcessingFee = null;
+ protected ?string $status = null;
+ protected ?string $url = null;
+ protected ?string $createDate = null;
+ protected ?string $id = null;
+ protected ?string $merchant = null;
/**
* Constructor, create a minimal request Bill object.
*
- * @param $number string A string for tracking purposes.
- * @param $currency string The three digit currency type used to compute the bill's amount.
- * @param $email string The email address of the receiver for this bill.
- * @param $items array The list of itens to add to this bill.
+ * @param string|null $number string A string for tracking purposes.
+ * @param string|null $currency string The three digit currency type used to compute the bill's amount.
+ * @param string|null $email string The email address of the receiver for this bill.
+ * @param array|null $items array The list of items to add to this bill.
*/
public function __construct(
string $number = null,
@@ -49,263 +54,517 @@ public function __construct(
string $email = null,
array $items = null
) {
- $this->_number = $number;
- $this->_currency = $currency;
- $this->_email = $email;
- $this->_items = $items;
- }
+ $this->number = $number;
+ $this->currency = $currency;
+ $this->email = $email;
- // API fields
- //
+ if (!$items) {
+ $items = [];
+ }
+ $this->setItems($items);
+ }
- public function getToken()
+ /**
+ * Gets token
+ *
+ * API token for bill resource. This token is actually derived from the API token used to
+ * create the bill and is tied to the specific resource id created.
+ *
+ * @return string|null the token
+ */
+ public function getToken(): ?string
{
- return $this->_token;
+ return $this->token;
}
- public function setToken(string $token)
+ /**
+ * Sets Bill's token
+ *
+ * API token for bill resource. This token is actually derived from the API token used to
+ * create the bill and is tied to the specific resource id created.
+ *
+ * @param string $token API token for bill resource
+ */
+ public function setToken(string $token): void
{
- $this->_token = $token;
+ $this->token = $token;
}
- // Required fields
- //
-
- public function getCurrency()
+ /**
+ * Gets bill currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the price field
+ *
+ * @return string|null the bill currency
+ */
+ public function getCurrency(): ?string
{
- return $this->_currency;
+ return $this->currency;
}
- public function setCurrency(string $currency)
+ /**
+ * Sets Bill's currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the price field
+ *
+ * @param string $currency 3-character currency code
+ * @throws BitPayException
+ */
+ public function setCurrency(string $currency): void
{
if (!Currency::isValid($currency)) {
throw new BitPayException("currency code must be a type of Model.Currency");
}
- $this->_currency = $currency;
+ $this->currency = $currency;
}
- public function getEmail()
+ /**
+ * Gets bill email
+ *
+ * @return string|null the email
+ */
+ public function getEmail(): ?string
{
- return $this->_email;
+ return $this->email;
}
- public function setEmail(string $email)
+ /**
+ * Sets Bill's email
+ *
+ * @param string $email Bill's email
+ */
+ public function setEmail(string $email): void
{
- $this->_email = $email;
+ $this->email = $email;
}
- public function getItems()
+ /**
+ * Gets items from bill
+ *
+ * @return array Item[]
+ */
+ public function getItems(): array
{
- return $this->_items;
+ return $this->items;
}
- public function getItemsAsArray()
+ /**
+ * Gets items as array from bill
+ *
+ * @return array|null items as array from bill
+ */
+ public function getItemsAsArray(): ?array
{
$items = [];
- foreach ($this->_items as $item) {
- if ($item instanceof Item) {
- array_push($items, $item->toArray());
- } else {
- array_push($items, $item);
- }
+ foreach ($this->items as $item) {
+ $items[] = $item->toArray();
}
return $items;
}
- public function setItems(array $items)
+ /**
+ * Sets Bill's items
+ *
+ * @param array $items Item[]
+ */
+ public function setItems(array $items): void
{
$itemsArray = [];
foreach ($items as $item) {
if ($item instanceof Item) {
- array_push($itemsArray, $item);
+ $itemsArray[] = $item;
} else {
- array_push($itemsArray, Item::createFromArray((array)$item));
+ $itemsArray[] = Item::createFromArray((array)$item);
}
}
- $this->_items = $itemsArray;
- }
- // Optional fields
- //
+ $this->items = $itemsArray;
+ }
- public function getNumber()
+ /**
+ * Gets bill number
+ *
+ * Bill identifier, specified by merchant
+ *
+ * @return string|null the number
+ */
+ public function getNumber(): ?string
{
- return $this->_number;
+ return $this->number;
}
- public function setNumber(string $number)
+ /**
+ * Sets Bill's number
+ *
+ * Bill identifier, specified by merchant
+ *
+ * @param string $number Bill identifier, specified by merchant
+ */
+ public function setNumber(string $number): void
{
- $this->_number = $number;
+ $this->number = $number;
}
- public function getName()
+ /**
+ * Gets Bill recipient's name
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
{
- return $this->_name;
+ return $this->name;
}
- public function setName(string $name)
+ /**
+ * Sets Bill recipient's name
+ *
+ * @param string $name Bill recipient's name
+ */
+ public function setName(string $name): void
{
- $this->_name = $name;
+ $this->name = $name;
}
- public function getAddress1()
+ /**
+ * Gets Bill recipient's address
+ *
+ * @return string|null the address1
+ */
+ public function getAddress1(): ?string
{
- return $this->_address1;
+ return $this->address1;
}
- public function setAddress1(string $address1)
+ /**
+ * Sets Bill recipient's address
+ *
+ * @param string $address1 Bill recipient's address
+ */
+ public function setAddress1(string $address1): void
{
- $this->_address1 = $address1;
+ $this->address1 = $address1;
}
- public function getAddress2()
+ /**
+ * Gets Bill recipient's address
+ *
+ * @return string|null the address2
+ */
+ public function getAddress2(): ?string
{
- return $this->_address2;
+ return $this->address2;
}
- public function setAddress2(string $address2)
+ /**
+ * Sets Bill recipient's address
+ *
+ * @param string $address2 Bill recipient's address
+ */
+ public function setAddress2(string $address2): void
{
- $this->_address2 = $address2;
+ $this->address2 = $address2;
}
- public function getCity()
+ /**
+ * Gets Bill recipient's city
+ *
+ * @return string|null the city
+ */
+ public function getCity(): ?string
{
- return $this->_city;
+ return $this->city;
}
- public function setCity(string $city)
+ /**
+ * Sets Bill recipient's city
+ *
+ * @param string $city Bill recipient's city
+ */
+ public function setCity(string $city): void
{
- $this->_city = $city;
+ $this->city = $city;
}
- public function getState()
+ /**
+ * Gets Bill recipient's state or province
+ *
+ * @return string|null the state
+ */
+ public function getState(): ?string
{
- return $this->_state;
+ return $this->state;
}
- public function setState(string $state)
+ /**
+ * Sets Bill recipient's state or province
+ *
+ * @param string $state Bill recipient's state or province
+ */
+ public function setState(string $state): void
{
- $this->_state = $state;
+ $this->state = $state;
}
- public function getZip()
+ /**
+ * Gets Bill recipient's ZIP code
+ *
+ * @return string|null the zip
+ */
+ public function getZip(): ?string
{
- return $this->_zip;
+ return $this->zip;
}
- public function setZip(string $zip)
+ /**
+ * Sets Bill recipient's ZIP code
+ *
+ * @param string $zip Bill recipient's ZIP code
+ */
+ public function setZip(string $zip): void
{
- $this->_zip = $zip;
+ $this->zip = $zip;
}
- public function getCountry()
+ /**
+ * Gets Bill recipient's country
+ *
+ * @return string|null the country
+ */
+ public function getCountry(): ?string
{
- return $this->_country;
+ return $this->country;
}
- public function setCountry(string $country)
+ /**
+ * Sets Bill recipient's country
+ *
+ * @param string $country Bill recipient's country
+ */
+ public function setCountry(string $country): void
{
- $this->_country = $country;
+ $this->country = $country;
}
- public function getCc()
+ /**
+ * Gets Bill cc
+ *
+ * Email addresses to which a copy of the bill must be sent
+ *
+ * @return array|null the cc
+ */
+ public function getCc(): ?array
{
- return $this->_cc;
+ return $this->cc;
}
- public function setCc(array $cc)
+ /**
+ * Sets Bill's cc
+ *
+ * Email addresses to which a copy of the bill must be sent
+ *
+ * @param array $cc Email addresses to which a copy of the bill must be sent
+ */
+ public function setCc(array $cc): void
{
- $this->_cc = $cc;
+ $this->cc = $cc;
}
- public function getPhone()
+ /**
+ * Gets Bill recipient's phone number
+ *
+ * @return string|null the phone
+ */
+ public function getPhone(): ?string
{
- return $this->_phone;
+ return $this->phone;
}
- public function setPhone(string $phone)
+ /**
+ * Sets Bill recipient's phone number
+ *
+ * @param string $phone Bill recipient's phone number
+ */
+ public function setPhone(string $phone): void
{
- $this->_phone = $phone;
+ $this->phone = $phone;
}
- public function getDueDate()
+ /**
+ * Gets Bill due date
+ *
+ * Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+ *
+ * @return string|null the number
+ */
+ public function getDueDate(): ?string
{
- return $this->_dueDate;
+ return $this->dueDate;
}
- public function setDueDate(string $dueDate)
+ /**
+ * Sets Bill's due date
+ *
+ * Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+ *
+ * @param string $dueDate Date and time at which a bill is due
+ */
+ public function setDueDate(string $dueDate): void
{
- $this->_dueDate = $dueDate;
+ $this->dueDate = $dueDate;
}
- public function getPassProcessingFee()
+ /**
+ * Gets bill pass processing fee
+ *
+ * @return bool|null the pass processing fee
+ */
+ public function getPassProcessingFee(): ?bool
{
- return $this->_passProcessingFee;
+ return $this->passProcessingFee;
}
- public function setPassProcessingFee(bool $passProcessingFee)
+ /**
+ * Sets Bill's pass processing fee
+ *
+ * If set to true, BitPay's processing fee will be included in the amount charged on the invoice
+ *
+ * @param bool $passProcessingFee Bill's pass processing fee
+ */
+ public function setPassProcessingFee(bool $passProcessingFee): void
{
- $this->_passProcessingFee = $passProcessingFee;
+ $this->passProcessingFee = $passProcessingFee;
}
- // Response fields
- //
-
- public function getStatus()
+ /**
+ * Gets bill status
+ *
+ * Can "draft", "sent", "new", "paid", or "complete"
+ *
+ * @return string|null the status
+ */
+ public function getStatus(): ?string
{
- return $this->_status;
+ return $this->status;
}
- public function setStatus(string $status)
+ /**
+ * Sets Bill's status
+ *
+ * Can "draft", "sent", "new", "paid", or "complete"
+ *
+ * @param string $status Bill's status
+ */
+ public function setStatus(string $status): void
{
- $this->_status = $status;
+ $this->status = $status;
}
- public function getUrl()
+ /**
+ * Gets bill url
+ *
+ * Web address of bill
+ *
+ * @return string|null the url
+ */
+ public function getUrl(): ?string
{
- return $this->_url;
+ return $this->url;
}
- public function setUrl(string $url)
+ /**
+ * Sets Bill's url
+ *
+ * Web address of bill
+ *
+ * @param string $url Web address of bill
+ */
+ public function setUrl(string $url): void
{
- $this->_url = $url;
+ $this->url = $url;
}
- public function getCreateDate()
+ /**
+ * Gets bill create date
+ *
+ * Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+ *
+ * @return string|null the creation date
+ */
+ public function getCreateDate(): ?string
{
- return $this->_createDate;
+ return $this->createDate;
}
- public function setCreateDate(string $createDate)
+ /**
+ * Sets Bill's create date
+ *
+ * Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
+ *
+ * @param string $createDate Bill's create date
+ */
+ public function setCreateDate(string $createDate): void
{
- $this->_createDate = $createDate;
+ $this->createDate = $createDate;
}
- public function getId()
+ /**
+ * Gets bill id
+ *
+ * Bill resource id
+ *
+ * @return string|null the id
+ */
+ public function getId(): ?string
{
- return $this->_id;
+ return $this->id;
}
- public function setId(string $id)
+ /**
+ * Sets Bill's id
+ *
+ * Bill resource id
+ *
+ * @param string $id Bill resource id
+ */
+ public function setId(string $id): void
{
- $this->_id = $id;
+ $this->id = $id;
}
- public function getMerchant()
+ /**
+ * Gets bill merchant
+ *
+ * Internal identifier for BitPay, this field can be ignored by the merchants.
+ *
+ * @return string|null the merchant
+ */
+ public function getMerchant(): ?string
{
- return $this->_merchant;
+ return $this->merchant;
}
- public function setMerchant(string $merchant)
+ /**
+ * Sets Bill's merchant
+ *
+ * Internal identifier for BitPay, this field can be ignored by the merchants.
+ *
+ * @param string $merchant Internal identifier for BitPay
+ */
+ public function setMerchant(string $merchant): void
{
- $this->_merchant = $merchant;
+ $this->merchant = $merchant;
}
- public function toArray()
+ /**
+ * Get bill data as array
+ *
+ * @return array bill data as array
+ */
+ public function toArray(): array
{
$elements = [
'currency' => $this->getCurrency(),
diff --git a/src/BitPaySDK/Model/Bill/BillStatus.php b/src/BitPaySDK/Model/Bill/BillStatus.php
index ee7b8aee..527a5a23 100644
--- a/src/BitPaySDK/Model/Bill/BillStatus.php
+++ b/src/BitPaySDK/Model/Bill/BillStatus.php
@@ -1,14 +1,29 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+namespace BitPaySDK\Model\Bill;
+/**
+ * Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
+ *
+ * @package BitPaySDK\Model\Bill
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://developer.bitpay.com/reference/bills REST API Bills
+ */
interface BillStatus
{
- const Draft = "draft";
- const Sent = "sent";
- const New = "new";
- const Paid = "paid";
- const Complete = "complete";
+ public const DRAFT = "draft";
+ public const SENT = "sent";
+ public const NEW = "new";
+ public const PAID = "paid";
+ public const COMPLETE = "complete";
}
diff --git a/src/BitPaySDK/Model/Bill/Item.php b/src/BitPaySDK/Model/Bill/Item.php
index 3281588f..00bb06db 100644
--- a/src/BitPaySDK/Model/Bill/Item.php
+++ b/src/BitPaySDK/Model/Bill/Item.php
@@ -1,75 +1,139 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+
namespace BitPaySDK\Model\Bill;
/**
+ * @see https://developer.bitpay.com/reference/bills REST API Bills
*
- * @package Bitpay
+ * @package BitPaySDK\Model\Bill
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
*/
+
+#[\AllowDynamicProperties]
class Item
{
-
- protected $_id;
- protected $_description;
- protected $_price;
- protected $_quantity;
+ protected ?string $id = null;
+ protected ?string $description = null;
+ protected ?float $price = null;
+ protected ?int $quantity = null;
public function __construct()
{
}
- public function getId()
+ /**
+ * Gets id.
+ *
+ * @return string|null the id
+ */
+ public function getId(): ?string
{
- return $this->_id;
+ return $this->id;
}
- public function setId(string $id)
+ /**
+ * Sets id.
+ *
+ * @param string $id the id
+ */
+ public function setId(string $id): void
{
- $this->_id = $id;
+ $this->id = $id;
}
- public function getDescription()
+ /**
+ * Gets Line item description
+ *
+ * @return string|null the description
+ */
+ public function getDescription(): ?string
{
- return $this->_description;
+ return $this->description;
}
- public function setDescription(string $description)
+ /**
+ * Sets Line item description
+ *
+ * @param string $description the description
+ */
+ public function setDescription(string $description): void
{
- $this->_description = $description;
+ $this->description = $description;
}
- public function getPrice()
+ /**
+ * Gets Line item unit price for the corresponding currency
+ *
+ * @return float|null the price
+ */
+ public function getPrice(): ?float
{
- return $this->_price;
+ return $this->price;
}
- public function setPrice(float $price)
+ /**
+ * Sets Line item unit price for the corresponding currency
+ *
+ * @param float $price the price
+ */
+ public function setPrice(float $price): void
{
- $this->_price = $price;
+ $this->price = $price;
}
- public function getQuantity()
+ /**
+ * Gets Line item number of units
+ *
+ * @return int|null the quantity
+ */
+ public function getQuantity(): ?int
{
- return $this->_quantity;
+ return $this->quantity;
}
- public function setQuantity(int $quantity)
+ /**
+ * Sets Line item number of units
+ *
+ * @param int $quantity the quantity
+ */
+ public function setQuantity(int $quantity): void
{
- $this->_quantity = $quantity;
+ $this->quantity = $quantity;
}
- public static function createFromArray(array $item)
+ /**
+ * @param array $item List of line items
+ * @return Item
+ */
+ public static function createFromArray(array $item): Item
{
$instance = new self();
foreach ($item as $key => $value) {
- $instance->{'_'.$key} = $value;
+ $instance->{$key} = $value;
}
return $instance;
}
- public function toArray()
+ /**
+ * Gets Item data as array
+ *
+ * @return array item data as array
+ */
+ public function toArray(): array
{
$elements = [
'id' => $this->getId(),
diff --git a/src/BitPaySDK/Model/Currency.php b/src/BitPaySDK/Model/Currency.php
index 68875370..c82e1118 100644
--- a/src/BitPaySDK/Model/Currency.php
+++ b/src/BitPaySDK/Model/Currency.php
@@ -1,340 +1,493 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+namespace BitPaySDK\Model;
use Exception;
use ReflectionClass;
+/**
+ * Object containing currency information.
+ *
+ * @package BitPaySDK\Model
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class Currency
{
-
// Crypto
- const BCH = "BCH";
- const BTC = "BTC";
- const ETH = "ETH";
- const USDC = "USDC";
- const GUSD = "GUSD";
- const PAX = "PAX";
+ public const BCH = "BCH";
+ public const BTC = "BTC";
+ public const ETH = "ETH";
+ public const USDC = "USDC";
+ public const GUSD = "GUSD";
+ public const PAX = "PAX";
+ public const XRP = "XRP";
+ public const BUSD = "BUSD";
+ public const DOGE = "DOGE";
+ public const LTC = "LTC";
+ public const SHIB = "SHIB";
// FIAT
- const AED = "AED";
- const AFN = "AFN";
- const ALL = "ALL";
- const AMD = "AMD";
- const ANG = "ANG";
- const AOA = "AOA";
- const ARS = "ARS";
- const AUD = "AUD";
- const AWG = "AWG";
- const AZN = "AZN";
- const BAM = "BAM";
- const BBD = "BBD";
- const BDT = "BDT";
- const BGN = "BGN";
- const BHD = "BHD";
- const BIF = "BIF";
- const BMD = "BMD";
- const BND = "BND";
- const BOB = "BOB";
- const BOV = "BOV";
- const BRL = "BRL";
- const BSD = "BSD";
- const BTN = "BTN";
- const BWP = "BWP";
- const BYR = "BYR";
- const BZD = "BZD";
- const CAD = "CAD";
- const CDF = "CDF";
- const CHE = "CHE";
- const CHF = "CHF";
- const CHW = "CHW";
- const CLF = "CLF";
- const CLP = "CLP";
- const CNY = "CNY";
- const COP = "COP";
- const COU = "COU";
- const CRC = "CRC";
- const CUC = "CUC";
- const CUP = "CUP";
- const CVE = "CVE";
- const CZK = "CZK";
- const DJF = "DJF";
- const DKK = "DKK";
- const DOP = "DOP";
- const DZD = "DZD";
- const EGP = "EGP";
- const ERN = "ERN";
- const ETB = "ETB";
- const EUR = "EUR";
- const FJD = "FJD";
- const FKP = "FKP";
- const GBP = "GBP";
- const GEL = "GEL";
- const GHS = "GHS";
- const GIP = "GIP";
- const GMD = "GMD";
- const GNF = "GNF";
- const GTQ = "GTQ";
- const GYD = "GYD";
- const HKD = "HKD";
- const HNL = "HNL";
- const HRK = "HRK";
- const HTG = "HTG";
- const HUF = "HUF";
- const IDR = "IDR";
- const ILS = "ILS";
- const INR = "INR";
- const IQD = "IQD";
- const IRR = "IRR";
- const ISK = "ISK";
- const JMD = "JMD";
- const JOD = "JOD";
- const JPY = "JPY";
- const KES = "KES";
- const KGS = "KGS";
- const KHR = "KHR";
- const KMF = "KMF";
- const KPW = "KPW";
- const KRW = "KRW";
- const KWD = "KWD";
- const KYD = "KYD";
- const KZT = "KZT";
- const LAK = "LAK";
- const LBP = "LBP";
- const LKR = "LKR";
- const LRD = "LRD";
- const LSL = "LSL";
- const LYD = "LYD";
- const MAD = "MAD";
- const MDL = "MDL";
- const MGA = "MGA";
- const MKD = "MKD";
- const MMK = "MMK";
- const MNT = "MNT";
- const MOP = "MOP";
- const MRU = "MRU";
- const MUR = "MUR";
- const MVR = "MVR";
- const MWK = "MWK";
- const MXN = "MXN";
- const MXV = "MXV";
- const MYR = "MYR";
- const MZN = "MZN";
- const NAD = "NAD";
- const NGN = "NGN";
- const NIO = "NIO";
- const NOK = "NOK";
- const NPR = "NPR";
- const NZD = "NZD";
- const OMR = "OMR";
- const PAB = "PAB";
- const PEN = "PEN";
- const PGK = "PGK";
- const PHP = "PHP";
- const PKR = "PKR";
- const PLN = "PLN";
- const PYG = "PYG";
- const QAR = "QAR";
- const RON = "RON";
- const RSD = "RSD";
- const RUB = "RUB";
- const RWF = "RWF";
- const SAR = "SAR";
- const SBD = "SBD";
- const SCR = "SCR";
- const SDG = "SDG";
- const SEK = "SEK";
- const SGD = "SGD";
- const SHP = "SHP";
- const SLL = "SLL";
- const SOS = "SOS";
- const SRD = "SRD";
- const SSP = "SSP";
- const STN = "STN";
- const SVC = "SVC";
- const SYP = "SYP";
- const SZL = "SZL";
- const THB = "THB";
- const TJS = "TJS";
- const TMT = "TMT";
- const TND = "TND";
- const TOP = "TOP";
- const TRY = "TRY";
- const TTD = "TTD";
- const TWD = "TWD";
- const TZS = "TZS";
- const UAH = "UAH";
- const UGX = "UGX";
- const USD = "USD";
- const USN = "USN";
- const UYI = "UYI";
- const UYU = "UYU";
- const UZS = "UZS";
- const VEF = "VEF";
- const VND = "VND";
- const VUV = "VUV";
- const WST = "WST";
- const XAF = "XAF";
- const XCD = "XCD";
- const XDR = "XDR";
- const XOF = "XOF";
- const XPF = "XPF";
- const XSU = "XSU";
- const XUA = "XUA";
- const YER = "YER";
- const ZAR = "ZAR";
- const ZMW = "ZMW";
- const ZWL = "ZWL";
-
- protected $_code;
- protected $_symbol;
- protected $_precision;
- protected $_currentlySettled;
- protected $_name;
- protected $_plural;
- protected $_alts;
- protected $_minimum;
- protected $_sanctioned;
- protected $_decimals;
- protected $_payoutFields;
- protected $_settlementMinimum;
-
- public static function isValid($value)
+ public const AED = "AED";
+ public const AFN = "AFN";
+ public const ALL = "ALL";
+ public const AMD = "AMD";
+ public const ANG = "ANG";
+ public const AOA = "AOA";
+ public const ARS = "ARS";
+ public const AUD = "AUD";
+ public const AWG = "AWG";
+ public const AZN = "AZN";
+ public const BAM = "BAM";
+ public const BBD = "BBD";
+ public const BDT = "BDT";
+ public const BGN = "BGN";
+ public const BHD = "BHD";
+ public const BIF = "BIF";
+ public const BMD = "BMD";
+ public const BND = "BND";
+ public const BOB = "BOB";
+ public const BOV = "BOV";
+ public const BRL = "BRL";
+ public const BSD = "BSD";
+ public const BTN = "BTN";
+ public const BWP = "BWP";
+ public const BYR = "BYR";
+ public const BZD = "BZD";
+ public const CAD = "CAD";
+ public const CDF = "CDF";
+ public const CHE = "CHE";
+ public const CHF = "CHF";
+ public const CHW = "CHW";
+ public const CLF = "CLF";
+ public const CLP = "CLP";
+ public const CNY = "CNY";
+ public const COP = "COP";
+ public const COU = "COU";
+ public const CRC = "CRC";
+ public const CUC = "CUC";
+ public const CUP = "CUP";
+ public const CVE = "CVE";
+ public const CZK = "CZK";
+ public const DJF = "DJF";
+ public const DKK = "DKK";
+ public const DOP = "DOP";
+ public const DZD = "DZD";
+ public const EGP = "EGP";
+ public const ERN = "ERN";
+ public const ETB = "ETB";
+ public const EUR = "EUR";
+ public const FJD = "FJD";
+ public const FKP = "FKP";
+ public const GBP = "GBP";
+ public const GEL = "GEL";
+ public const GHS = "GHS";
+ public const GIP = "GIP";
+ public const GMD = "GMD";
+ public const GNF = "GNF";
+ public const GTQ = "GTQ";
+ public const GYD = "GYD";
+ public const HKD = "HKD";
+ public const HNL = "HNL";
+ public const HRK = "HRK";
+ public const HTG = "HTG";
+ public const HUF = "HUF";
+ public const IDR = "IDR";
+ public const ILS = "ILS";
+ public const INR = "INR";
+ public const IQD = "IQD";
+ public const IRR = "IRR";
+ public const ISK = "ISK";
+ public const JMD = "JMD";
+ public const JOD = "JOD";
+ public const JPY = "JPY";
+ public const KES = "KES";
+ public const KGS = "KGS";
+ public const KHR = "KHR";
+ public const KMF = "KMF";
+ public const KPW = "KPW";
+ public const KRW = "KRW";
+ public const KWD = "KWD";
+ public const KYD = "KYD";
+ public const KZT = "KZT";
+ public const LAK = "LAK";
+ public const LBP = "LBP";
+ public const LKR = "LKR";
+ public const LRD = "LRD";
+ public const LSL = "LSL";
+ public const LYD = "LYD";
+ public const MAD = "MAD";
+ public const MDL = "MDL";
+ public const MGA = "MGA";
+ public const MKD = "MKD";
+ public const MMK = "MMK";
+ public const MNT = "MNT";
+ public const MOP = "MOP";
+ public const MRU = "MRU";
+ public const MUR = "MUR";
+ public const MVR = "MVR";
+ public const MWK = "MWK";
+ public const MXN = "MXN";
+ public const MXV = "MXV";
+ public const MYR = "MYR";
+ public const MZN = "MZN";
+ public const NAD = "NAD";
+ public const NGN = "NGN";
+ public const NIO = "NIO";
+ public const NOK = "NOK";
+ public const NPR = "NPR";
+ public const NZD = "NZD";
+ public const OMR = "OMR";
+ public const PAB = "PAB";
+ public const PEN = "PEN";
+ public const PGK = "PGK";
+ public const PHP = "PHP";
+ public const PKR = "PKR";
+ public const PLN = "PLN";
+ public const PYG = "PYG";
+ public const QAR = "QAR";
+ public const RON = "RON";
+ public const RSD = "RSD";
+ public const RUB = "RUB";
+ public const RWF = "RWF";
+ public const SAR = "SAR";
+ public const SBD = "SBD";
+ public const SCR = "SCR";
+ public const SDG = "SDG";
+ public const SEK = "SEK";
+ public const SGD = "SGD";
+ public const SHP = "SHP";
+ public const SLL = "SLL";
+ public const SOS = "SOS";
+ public const SRD = "SRD";
+ public const SSP = "SSP";
+ public const STN = "STN";
+ public const SVC = "SVC";
+ public const SYP = "SYP";
+ public const SZL = "SZL";
+ public const THB = "THB";
+ public const TJS = "TJS";
+ public const TMT = "TMT";
+ public const TND = "TND";
+ public const TOP = "TOP";
+ public const TRY = "TRY";
+ public const TTD = "TTD";
+ public const TWD = "TWD";
+ public const TZS = "TZS";
+ public const UAH = "UAH";
+ public const UGX = "UGX";
+ public const USD = "USD";
+ public const USN = "USN";
+ public const UYI = "UYI";
+ public const UYU = "UYU";
+ public const UZS = "UZS";
+ public const VEF = "VEF";
+ public const VND = "VND";
+ public const VUV = "VUV";
+ public const WST = "WST";
+ public const XAF = "XAF";
+ public const XCD = "XCD";
+ public const XDR = "XDR";
+ public const XOF = "XOF";
+ public const XPF = "XPF";
+ public const XSU = "XSU";
+ public const XUA = "XUA";
+ public const YER = "YER";
+ public const ZAR = "ZAR";
+ public const ZMW = "ZMW";
+ public const ZWL = "ZWL";
+
+ protected ?string $code = null;
+ protected ?string $symbol = null;
+ protected ?int $precision = null;
+ protected ?bool $currentlySettled = null;
+ protected ?string $name = null;
+ protected ?string $plural = null;
+ protected ?string $alts = null;
+ protected ?string $minimum = null;
+ protected ?bool $sanctioned = null;
+ protected ?string $decimals = null;
+ protected array $payoutFields = [];
+ protected array $settlementMinimum = [];
+
+ /**
+ * Currency validation
+ *
+ * @param string $value the currency value
+ * @return bool
+ */
+ public static function isValid(string $value): bool
{
try {
$reflect = new ReflectionClass(Currency::class);
return array_key_exists($value, $reflect->getConstants());
- } catch (Exception $e) {
+ } catch (Exception) {
return false;
}
}
- public function __construct() { }
+ public function __construct()
+ {
+ }
- public function getCode()
+ /**
+ * Get ISO 4217 3-character currency code
+ *
+ * @return string|null the code
+ */
+ public function getCode(): ?string
{
- return $this->_code;
+ return $this->code;
}
- public function setCode(string $code)
+ /**
+ * Sets ISO 4217 3-character currency code
+ *
+ * @param string $code the code
+ */
+ public function setCode(string $code): void
{
- $this->_code = $code;
+ $this->code = $code;
}
- public function getSymbol()
+ /**
+ * Display symbol
+ *
+ * @return string|null the symbol
+ */
+ public function getSymbol(): ?string
{
- return $this->_symbol;
+ return $this->symbol;
}
- public function setSymbol(string $symbol = null)
+ /**
+ * Sets symbol
+ *
+ * @param string|null $symbol
+ */
+ public function setSymbol(?string $symbol = null): void
{
- $this->_symbol = $symbol;
+ $this->symbol = $symbol;
}
- public function getPrecision()
+ /**
+ * Number of decimal places
+ *
+ * @return int|null the precision
+ */
+ public function getPrecision(): ?int
{
- return $this->_precision;
+ return $this->precision;
}
- public function setPrecision(int $precision)
+ /**
+ * Sets number of decimal places
+ *
+ * @param int $precision the precision
+ */
+ public function setPrecision(int $precision): void
{
- $this->_precision = $precision;
+ $this->precision = $precision;
}
- public function getCurrentlySettled()
+ /**
+ * Gets currently settled value
+ *
+ * @return bool|null
+ */
+ public function getCurrentlySettled(): ?bool
{
- return $this->_currentlySettled;
+ return $this->currentlySettled;
}
- public function setCurrentlySettled(bool $currentlySettled)
+ /**
+ * Sets currently settled value
+ *
+ * @param bool $currentlySettled
+ */
+ public function setCurrentlySettled(bool $currentlySettled): void
{
- $this->_currentlySettled = $currentlySettled;
+ $this->currentlySettled = $currentlySettled;
}
- public function getName()
+ /**
+ * Gets currency name
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
{
- return $this->_name;
+ return $this->name;
}
- public function setName(string $name)
+ /**
+ * Sets currency name
+ *
+ * @param string $name the name
+ */
+ public function setName(string $name): void
{
- $this->_name = $name;
+ $this->name = $name;
}
- public function getPlural()
+ /**
+ * Gets English plural form
+ *
+ * @return string|null the plural form
+ */
+ public function getPlural(): ?string
{
- return $this->_plural;
+ return $this->plural;
}
- public function setPlural(string $plural)
+ /**
+ * Sets English plural form
+ *
+ * @param string $plural the plural form
+ */
+ public function setPlural(string $plural): void
{
- $this->_plural = $plural;
+ $this->plural = $plural;
}
- public function getAlts()
+ /**
+ * Gets alternative currency name(s)
+ *
+ * @return string|null the alts
+ */
+ public function getAlts(): ?string
{
- return $this->_alts;
+ return $this->alts;
}
- public function setAlts(string $alts)
+ /**
+ * Sets alternative currency name(s)
+ *
+ * @param string $alts the alts
+ */
+ public function setAlts(string $alts): void
{
- $this->_alts = $alts;
+ $this->alts = $alts;
}
- public function getMinimum()
+ /**
+ * Gets minimum supported value when creating an invoice, bill or payout for instance
+ *
+ * @return string|null the minimum
+ */
+ public function getMinimum(): ?string
{
- return $this->_minimum;
+ return $this->minimum;
}
- public function setMinimum(string $minimum)
+ /**
+ * Sets minimum supported value when creating an invoice, bill or payout for instance
+ *
+ * @param string $minimum the minimum
+ */
+ public function setMinimum(string $minimum): void
{
- $this->_minimum = $minimum;
+ $this->minimum = $minimum;
}
- public function getSanctioned()
+ /**
+ * Gets if the currency is linked to a sanctionned country
+ *
+ * @return bool|null the sanctioned
+ */
+ public function getSanctioned(): ?bool
{
- return $this->_sanctioned;
+ return $this->sanctioned;
}
- public function setSanctioned(bool $sanctioned)
+ /**
+ * Sets if the currency is linked to a sanctionned country
+ *
+ * @param bool $sanctioned the sanctioned
+ */
+ public function setSanctioned(bool $sanctioned): void
{
- $this->_sanctioned = $sanctioned;
+ $this->sanctioned = $sanctioned;
}
- public function getDecimals()
+ /**
+ * Gets decimal precision
+ *
+ * @return string|null decimals
+ */
+ public function getDecimals(): ?string
{
- return $this->_decimals;
+ return $this->decimals;
}
- public function setDecimals(string $decimals)
+ /**
+ * Sets decimal precision
+ *
+ * @param string $decimals decimals
+ */
+ public function setDecimals(string $decimals): void
{
- $this->_decimals = $decimals;
+ $this->decimals = $decimals;
}
- public function getPayoutFields()
+ /**
+ * Gets payout fields
+ *
+ * @return array the payout fields
+ */
+ public function getPayoutFields(): array
{
- return $this->_payoutFields;
+ return $this->payoutFields;
}
- public function setPayoutFields(array $payoutFields)
+ /**
+ * Sets payout fields
+ *
+ * @param array $payoutFields the payout fields
+ */
+ public function setPayoutFields(array $payoutFields): void
{
- $this->_payoutFields = $payoutFields;
+ $this->payoutFields = $payoutFields;
}
- public function getSettlementMinimum()
+ /**
+ * Gets settlement minimum
+ *
+ * @return array the settlement minimum
+ */
+ public function getSettlementMinimum(): array
{
- return $this->_settlementMinimum;
+ return $this->settlementMinimum;
}
- public function setSettlementMinimum(array $settlementMinimum)
+ /**
+ * Sets settlement minimum
+ *
+ * @param array $settlementMinimum the settlement minimum
+ */
+ public function setSettlementMinimum(array $settlementMinimum): void
{
- $this->_settlementMinimum = $settlementMinimum;
+ $this->settlementMinimum = $settlementMinimum;
}
- public function toArray()
+ /**
+ * Gets currency data as array
+ *
+ * @return array currency data as array
+ */
+ public function toArray(): array
{
$elements = [
'code' => $this->getCode(),
@@ -359,4 +512,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Facade.php b/src/BitPaySDK/Model/Facade.php
index 44864c66..e4071e8b 100644
--- a/src/BitPaySDK/Model/Facade.php
+++ b/src/BitPaySDK/Model/Facade.php
@@ -1,11 +1,38 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/concepts#facades REST API facades
+ */
interface Facade
{
- const Merchant = "merchant";
- const Payroll = "payroll";
-}
\ No newline at end of file
+ /**
+ * The broadest set of capabilities against a merchant organization. Allows for create, search,
+ * and view actions for Invoices and Bills; ledger download,
+ * as well as the creation of new merchant or pos tokens associated with the account.
+ */
+ public const MERCHANT = "merchant";
+
+ /**
+ * This is the facade which allows merchant to access the Payouts related resources and corresponding endpoints.
+ * Access to this facade is not enabled by default.
+ */
+ public const PAYOUT = "payout";
+
+ /**
+ * Limited to creating new invoice or bills and search specific invoices
+ * or bills based on their id for the merchant's organization
+ */
+ public const POS = "pos";
+}
diff --git a/src/BitPaySDK/Model/Invoice/Buyer.php b/src/BitPaySDK/Model/Invoice/Buyer.php
index bd970fd9..f7234bb9 100644
--- a/src/BitPaySDK/Model/Invoice/Buyer.php
+++ b/src/BitPaySDK/Model/Invoice/Buyer.php
@@ -1,129 +1,255 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
*/
+
class Buyer
{
- protected $_name;
- protected $_address1;
- protected $_address2;
- protected $_locality;
- protected $_region;
- protected $_postalCode;
- protected $_country;
- protected $_email;
- protected $_phone;
- protected $_notify;
+ protected ?string $name = null;
+ protected ?string $address1 = null;
+ protected ?string $address2 = null;
+ protected ?string $locality = null;
+ protected ?string $region = null;
+ protected ?string $postalCode = null;
+ protected ?string $country = null;
+ protected ?string $email = null;
+ protected ?string $phone = null;
+ protected ?bool $notify = null;
public function __construct()
{
}
- public function getName()
+ /**
+ * Gets Buyer's name
+ *
+ * @return string|null Buyer's name
+ */
+ public function getName(): ?string
{
- return $this->_name;
+ return $this->name;
}
- public function setName(string $name)
+ /**
+ * Sets Buyer's name
+ *
+ * @param string $name Buyer's name
+ */
+ public function setName(string $name): void
{
- $this->_name = $name;
+ $this->name = $name;
}
- public function getAddress1()
+ /**
+ * Gets Buyer's address
+ *
+ * @return string|null Buyer's address
+ */
+ public function getAddress1(): ?string
{
- return $this->_address1;
+ return $this->address1;
}
- public function setAddress1(string $address1)
+ /**
+ * Sets Buyer's address
+ *
+ * @param string $address1 Buyer's address
+ */
+ public function setAddress1(string $address1): void
{
- $this->_address1 = $address1;
+ $this->address1 = $address1;
}
- public function getAddress2()
+ /**
+ * Gets Buyer's appartment or suite number
+ *
+ * @return string|null Buyer's appartment or suite number
+ */
+ public function getAddress2(): ?string
{
- return $this->_address2;
+ return $this->address2;
}
- public function setAddress2(string $address2)
+ /**
+ * Sets Buyer's appartment or suite number
+ *
+ * @param string $address2 Buyer's appartment or suite number
+ */
+ public function setAddress2(string $address2): void
{
- $this->_address2 = $address2;
+ $this->address2 = $address2;
}
- public function getLocality()
+ /**
+ * Gets Buyer's city or locality
+ *
+ * @return string|null Buyer's city or locality
+ */
+ public function getLocality(): ?string
{
- return $this->_locality;
+ return $this->locality;
}
- public function setLocality(string $locality)
+ /**
+ * Sets Buyer's city or locality
+ *
+ * @param string $locality Buyer's city or locality
+ */
+ public function setLocality(string $locality): void
{
- $this->_locality = $locality;
+ $this->locality = $locality;
}
- public function getRegion()
+ /**
+ * Buyer's state or province
+ *
+ * @return string|null Buyer's state or province
+ */
+ public function getRegion(): ?string
{
- return $this->_region;
+ return $this->region;
}
- public function setRegion(string $region)
+ /**
+ * Sets Buyer's state or province
+ *
+ * @param string $region Buyer's state or province
+ */
+ public function setRegion(string $region): void
{
- $this->_region = $region;
+ $this->region = $region;
}
- public function getPostalCode()
+ /**
+ * Gets Buyer's Zip or Postal Code
+ *
+ * @return string|null Buyer's Zip or Postal Code
+ */
+ public function getPostalCode(): ?string
{
- return $this->_postalCode;
+ return $this->postalCode;
}
- public function setPostalCode(string $postalCode)
+ /**
+ * Sets Buyer's Zip or Postal Code
+ *
+ * @param string $postalCode Buyer's Zip or Postal Code
+ */
+ public function setPostalCode(string $postalCode): void
{
- $this->_postalCode = $postalCode;
+ $this->postalCode = $postalCode;
}
- public function getCountry()
+ /**
+ * Gets Buyer's Country code
+ *
+ * Format ISO 3166-1 alpha-2
+ *
+ * @return string|null Buyer's Country code
+ */
+ public function getCountry(): ?string
{
- return $this->_country;
+ return $this->country;
}
- public function setCountry(string $country)
+ /**
+ * Sets Buyer's Country code
+ *
+ * @param string $country Buyer's Country code
+ */
+ public function setCountry(string $country): void
{
- $this->_country = $country;
+ $this->country = $country;
}
- public function getEmail()
+ /**
+ * Gets Buyer's email address.
+ *
+ * If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+ *
+ * @return string|null Buyer's email address
+ */
+ public function getEmail(): ?string
{
- return $this->_email;
+ return $this->email;
}
- public function setEmail(string $email)
+ /**
+ * Sets Buyer's email address
+ *
+ * If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+ *
+ * @param string $email Buyer's email address
+ */
+ public function setEmail(string $email): void
{
- $this->_email = $email;
+ $this->email = $email;
}
- public function getPhone()
+ /**
+ * Gets Buyer's phone number
+ *
+ * @return string|null Buyer's phone number
+ */
+ public function getPhone(): ?string
{
- return $this->_phone;
+ return $this->phone;
}
- public function setPhone(string $phone)
+ /**
+ * Sets Buyer's phone number
+ *
+ * @param string $phone Buyer's phone number
+ */
+ public function setPhone(string $phone): void
{
- $this->_phone = $phone;
+ $this->phone = $phone;
}
- public function getNotify()
+ /**
+ * Gets Buyer's notify
+ *
+ * Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
+ *
+ * @return bool|null Buyer's notify
+ */
+ public function getNotify(): ?bool
{
- return $this->_notify;
+ return $this->notify;
}
- public function setNotify(bool $notify)
+ /**
+ * Sets Buyer's notify
+ *
+ * Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
+ *
+ * @param bool $notify Buyer's notify
+ */
+ public function setNotify(bool $notify): void
{
- $this->_notify = $notify;
+ $this->notify = $notify;
}
- public function toArray()
+ /**
+ * Gets Buyer as array
+ *
+ * @return array Buyer as array
+ */
+ public function toArray(): array
{
$elements = [
'name' => $this->getName(),
diff --git a/src/BitPaySDK/Model/Invoice/BuyerProvidedInfo.php b/src/BitPaySDK/Model/Invoice/BuyerProvidedInfo.php
index e0fe0591..54dc28b2 100644
--- a/src/BitPaySDK/Model/Invoice/BuyerProvidedInfo.php
+++ b/src/BitPaySDK/Model/Invoice/BuyerProvidedInfo.php
@@ -1,67 +1,222 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class BuyerProvidedInfo
{
- protected $_name;
- protected $_phoneNumber;
- protected $_emailAddress;
- protected $_selectedTransactionCurrency;
+ protected ?string $name = null;
+ protected ?string $phoneNumber = null;
+ protected ?string $selectedWallet = null;
+ protected ?string $emailAddress = null;
+ protected ?string $selectedTransactionCurrency = null;
+ protected ?string $sms = null;
+ protected ?bool $smsVerified = null;
public function __construct()
{
}
- public function getName()
+ /**
+ * Gets name
+ *
+ * Populated with the buyer's name address if passed in the buyer object by the merchant
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
+ {
+ return $this->name;
+ }
+
+ /**
+ * Sets name
+ *
+ * Populated with the buyer's name address if passed in the buyer object by the merchant
+ *
+ * @param string $name the name
+ */
+ public function setName(string $name): void
+ {
+ $this->name = $name;
+ }
+
+ /**
+ * Gets phone number
+ *
+ * Populated with the buyer's phone number if passed in the buyer object by the merchant
+ *
+ * @return string|null the phone number
+ */
+ public function getPhoneNumber(): ?string
+ {
+ return $this->phoneNumber;
+ }
+
+ /**
+ * Sets phone number
+ *
+ * Populated with the buyer's phone number if passed in the buyer object by the merchant
+ *
+ * @param string $phoneNumber the phone number
+ */
+ public function setPhoneNumber(string $phoneNumber): void
+ {
+ $this->phoneNumber = $phoneNumber;
+ }
+
+ /**
+ * Gets selected wallet
+ *
+ * This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.
+ *
+ * @return string|null the selected wallet
+ */
+ public function getSelectedWallet(): ?string
+ {
+ return $this->selectedWallet;
+ }
+
+ /**
+ * Sets selected wallet
+ *
+ * This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.
+ *
+ * @param string|null $selectedWallet the selected wallet
+ */
+ public function setSelectedWallet(?string $selectedWallet): void
+ {
+ $this->selectedWallet = $selectedWallet;
+ }
+
+ /**
+ * Gets email address
+ *
+ * Populated with the buyer's email address if passed in the buyer object,
+ * otherwise this field is not returned in the response.
+ *
+ * @return string|null the email address
+ */
+ public function getEmailAddress(): ?string
{
- return $this->_name;
+ return $this->emailAddress;
}
- public function setName($name)
+ /**
+ * Sets email address
+ *
+ * Populated with the buyer's email address if passed in the buyer object,
+ * otherwise this field is not returned in the response.
+ *
+ * @param string $emailAddress the email address
+ */
+ public function setEmailAddress(string $emailAddress): void
{
- $this->_name = $name;
+ $this->emailAddress = $emailAddress;
}
- public function getPhoneNumber()
+ /**
+ * Gets selected transaction currency
+ *
+ * This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+ * current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * If not yet selected, this field will not be returned.
+ *
+ * @return string|null the selected transaction currency
+ */
+ public function getSelectedTransactionCurrency(): ?string
{
- return $this->_phoneNumber;
+ return $this->selectedTransactionCurrency;
}
- public function setPhoneNumber($phoneNumber)
+ /**
+ * Sets selected transaction currency
+ *
+ * This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+ * current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * If not yet selected, this field will not be returned.
+ *
+ * @param string $selectedTransactionCurrency the selected transaction currency
+ */
+ public function setSelectedTransactionCurrency(string $selectedTransactionCurrency): void
{
- $this->_phoneNumber = $phoneNumber;
+ $this->selectedTransactionCurrency = $selectedTransactionCurrency;
}
- public function getEmailAddress()
+ /**
+ * Gets sms
+ *
+ * SMS provided by user for communications. This is only used for instances where a buyers email
+ * (primary form of buyer communication) is can not be gathered.
+ *
+ * @return string|null the sms
+ */
+ public function getSms(): ?string
{
- return $this->_emailAddress;
+ return $this->sms;
}
- public function setEmailAddress($emailAddress)
+ /**
+ * Sets sms
+ *
+ * SMS provided by user for communications. This is only used for instances where a buyers email
+ * (primary form of buyer communication) is can not be gathered.
+ *
+ * @param string $sms the sms
+ */
+ public function setSms(string $sms): void
{
- $this->_emailAddress = $emailAddress;
+ $this->sms = $sms;
}
- public function getSelectedTransactionCurrency()
+ /**
+ * Gets verification status of SMS (ie. have they passed the challenge).
+ *
+ * @return bool|null the sms verified
+ */
+ public function getSmsVerified(): ?bool
{
- return $this->_selectedTransactionCurrency;
+ return $this->smsVerified;
}
- public function setSelectedTransactionCurrency($selectedTransactionCurrency)
+ /**
+ * Sets verification status of SMS (ie. have they passed the challenge).
+ *
+ * @param bool $smsVerified the sms verified
+ */
+ public function setSmsVerified(bool $smsVerified): void
{
- $this->_selectedTransactionCurrency = $selectedTransactionCurrency;
+ $this->smsVerified = $smsVerified;
}
- public function toArray()
+ /**
+ * Gets BuyerProvidedInfo as array
+ *
+ * @return array BuyerProvidedInfo as array
+ */
+ public function toArray(): array
{
$elements = [
'name' => $this->getName(),
'phoneNumber' => $this->getPhoneNumber(),
+ 'selectedWallet' => $this->getSelectedWallet(),
'emailAddress' => $this->getEmailAddress(),
'selectedTransactionCurrency' => $this->getSelectedTransactionCurrency(),
+ 'sms' => $this->getSms(),
+ 'smsVerified' => $this->getSmsVerified(),
];
foreach ($elements as $key => $value) {
@@ -72,4 +227,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/Invoice.php b/src/BitPaySDK/Model/Invoice/Invoice.php
index 7d3fa3c1..96fe7c65 100644
--- a/src/BitPaySDK/Model/Invoice/Invoice.php
+++ b/src/BitPaySDK/Model/Invoice/Invoice.php
@@ -1,627 +1,1873 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
*/
class Invoice
{
- protected $_currency;
-
- protected $_guid = "";
- protected $_token = "";
-
- protected $_price;
- protected $_posData = "";
- protected $_notificationURL = "";
- protected $_transactionSpeed = "";
- protected $_fullNotifications = false;
- protected $_notificationEmail = "";
- protected $_redirectURL = "";
- protected $_orderId = "";
- protected $_itemDesc = "";
- protected $_itemCode = "";
- protected $_physical = false;
- protected $_paymentCurrencies;
- protected $_acceptanceWindow;
- protected $_buyer;
- protected $_refundAddresses;
-
- protected $_id;
- protected $_url;
- protected $_status;
- protected $_lowFeeDetected;
- protected $_invoiceTime;
- protected $_expirationTime;
- protected $_currentTime;
- protected $_transactions;
- protected $_exceptionStatus;
- protected $_targetConfirmations;
- protected $_refundAddressRequestPending;
- protected $_buyerProvidedEmail;
- protected $_buyerProvidedInfo;
- protected $_supportedTransactionCurrencies;
- protected $_minerFees;
- protected $_shopper;
- protected $_billId;
- protected $_refundInfo;
-
- /**
- * PaymentCodes will be deprecated TODO on version 4.0
- *
- * @var array
- * @deprecated
- */
- protected $_paymentCodes;
- protected $_extendedNotifications = false;
-
- protected $_transactionCurrency;
- protected $_amountPaid;
- protected $_exchangeRates;
- protected $_paymentTotals;
- protected $_paymentSubtotals;
- protected $_paymentDisplayTotals;
- protected $_paymentDisplaySubTotals;
+ protected ?string $currency = null;
+ protected ?string $guid = null;
+ protected ?string $token = null;
+ protected ?float $price = null;
+ protected ?string $posData = null;
+ protected ?string $notificationURL = null;
+ protected ?string $transactionSpeed = null;
+ protected bool $fullNotifications = false;
+ protected ?string $notificationEmail = null;
+ protected ?string $redirectURL = null;
+ protected ?string $orderId = null;
+ protected ?string $itemDesc = null;
+ protected ?string $itemCode = null;
+ protected bool $physical = false;
+ protected ?array $paymentCurrencies = null;
+ protected ?array $paymentSubtotals = null;
+ protected ?array $paymentTotals = null;
+ protected ?array $paymentCodes = null;
+ protected ?float $acceptanceWindow = null;
+ protected ?Buyer $buyer = null;
+ protected ?array $refundAddresses = null;
+ protected ?string $closeURL = null;
+ protected bool $autoRedirect = false;
+ protected ?bool $jsonPayProRequired = null;
+ protected ?string $buyerEmail = null;
+ protected ?string $buyerSms = null;
+ protected ?string $merchantName = null;
+ protected ?string $selectedTransactionCurrency = null;
+ protected ?string $forcedBuyerSelectedWallet = null;
+ protected ?string $forcedBuyerSelectedTransactionCurrency = null;
+ /**
+ * @var ItemizedDetails[]
+ */
+ protected array $itemizedDetails = [];
+ protected ?string $id = null;
+ protected ?string $url = null;
+ protected ?string $status = null;
+ protected ?bool $lowFeeDetected = null;
+ protected ?int $invoiceTime = null;
+ protected ?string $expirationTime = null;
+ protected ?string $currentTime = null;
+ protected ?array $transactions = null;
+ protected ?bool $exceptionStatus = null;
+ protected ?int $targetConfirmations = null;
+ protected ?bool $refundAddressRequestPending = null;
+ protected ?string $buyerProvidedEmail = null;
+ protected ?BuyerProvidedInfo $buyerProvidedInfo = null;
+ protected ?UniversalCodes $universalCodes = null;
+ protected ?SupportedTransactionCurrencies $supportedTransactionCurrencies = null;
+ protected ?MinerFees $minerFees = null;
+ protected ?bool $nonPayProPaymentReceived = null;
+ protected ?Shopper $shopper = null;
+ protected ?string $billId = null;
+ protected ?RefundInfo $refundInfo = null;
+ protected bool $extendedNotifications = false;
+ protected ?bool $isCancelled = null;
+ protected ?string $transactionCurrency = null;
+ protected ?int $underpaidAmount = null;
+ protected ?int $overpaidAmount = null;
+ protected ?int $amountPaid = null;
+ protected ?string $displayAmountPaid = null;
+ protected ?array $exchangeRates = null;
+ protected ?bool $bitpayIdRequired = null;
+ protected ?array $paymentDisplayTotals = null;
+ protected ?array $paymentDisplaySubTotals = null;
/**
* Constructor, create a minimal request Invoice object.
*
- * @param $price float The amount for which the invoice will be created.
- * @param $currency string three digit currency type used to compute the invoice bitcoin amount.
+ * @param float|null $price float The amount for which the invoice will be created.
+ * @param string|null $currency string three digit currency type used to compute the invoice bitcoin amount.
*/
public function __construct(float $price = null, string $currency = null)
{
- $this->_price = $price;
- $this->_currency = $currency;
- $this->_buyer = new Buyer();
- $this->_buyerProvidedInfo = new BuyerProvidedInfo();
- $this->_supportedTransactionCurrencies = new SupportedTransactionCurrencies();
- $this->_minerFees = new MinerFees();
- $this->_shopper = new Shopper();
- $this->_refundInfo = new RefundInfo();
- $this->_paymentCodes = null;
- $this->_paymentTotals = new PaymentTotal();
- $this->_paymentSubtotals = new PaymentTotal();
- $this->_paymentDisplayTotals = new PaymentTotal();
- $this->_paymentDisplaySubTotals = new PaymentTotal();
+ $this->price = $price;
+ $this->currency = $currency;
+ $this->buyer = new Buyer();
+ $this->buyerProvidedInfo = new BuyerProvidedInfo();
+ $this->universalCodes = new UniversalCodes();
+ $this->supportedTransactionCurrencies = new SupportedTransactionCurrencies();
+ $this->minerFees = new MinerFees();
+ $this->shopper = new Shopper();
+ $this->refundInfo = new RefundInfo();
+ $this->itemizedDetails = [];
}
// API fields
//
- public function getCurrency()
+ /**
+ * Gets currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the price field,
+ * supported currencies are available via the
+ * Currencies resource
+ *
+ * @return string|null The currency
+ */
+ public function getCurrency(): ?string
{
- return $this->_currency;
+ return $this->currency;
}
// Required fields
//
- public function setCurrency(string $currency)
+ /**
+ * Sets currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the price field,
+ * supported currencies are available via the
+ * Currencies resource
+ *
+ * @param string $currency 3-character currency code
+ *
+ * @throws BitPayException
+ */
+ public function setCurrency(string $currency): void
{
if (!Currency::isValid($currency)) {
throw new BitPayException("currency code must be a type of Model.Currency");
}
- $this->_currency = $currency;
+ $this->currency = $currency;
}
- public function getGuid()
+ /**
+ * Gets guid
+ *
+ * A passthru variable provided by the merchant and designed to be used by the merchant
+ * to correlate the invoice with an order ID in their system,
+ * which can be used as a lookup variable in Retrieve Invoice by GUID.
+ *
+ * @return string|null The guid
+ */
+ public function getGuid(): ?string
{
- return $this->_guid;
+ return $this->guid;
}
- public function setGuid(string $guid)
+ /**
+ * Sets guid
+ *
+ * A passthru variable provided by the merchant and designed to be used by the merchant
+ * to correlate the invoice with an order ID in their system,
+ * which can be used as a lookup variable in Retrieve Invoice by GUID.
+ *
+ * @param string $guid The guid of the refund request being retrieved
+ */
+ public function setGuid(string $guid): void
{
- $this->_guid = $guid;
+ $this->guid = $guid;
}
- public function getToken()
+ /**
+ * Gets token
+ *
+ * Invoice resource token. This token is derived from the API token initially used
+ * to create the invoice and is tied to the specific resource id created.
+ *
+ * @return string|null - Invoice resource token.
+ */
+ public function getToken(): ?string
{
- return $this->_token;
+ return $this->token;
}
// Optional fields
//
-
- public function setToken(string $token)
+ /**
+ * Sets token
+ *
+ * Invoice resource token.
+ * This token is derived from the API token initially used to create the
+ * invoice and is tied to the specific resource id created.
+ *
+ * @param string $token Invoice resource token
+ */
+ public function setToken(string $token): void
{
- $this->_token = $token;
+ $this->token = $token;
}
- public function getPrice()
+ /**
+ * Gets price
+ *
+ * Fixed price amount for the checkout, in the "currency" of the invoice object.
+ *
+ * @return float|null The price
+ */
+ public function getPrice(): ?float
{
- return $this->_price;
+ return $this->price;
}
- public function setPrice(float $price)
+ /**
+ * Sets price
+ *
+ * Fixed price amount for the checkout, in the "currency" of the invoice object.
+ *
+ * @param float $price Fixed price amount for the checkout, in the "currency" of the invoice object.
+ *
+ */
+ public function setPrice(float $price): void
{
- $this->_price = $price;
+ $this->price = $price;
}
- public function getPosData()
+ /**
+ * Gets posData
+ *
+ * A passthru variable provided by the merchant during invoice creation and designed to be
+ * used by the merchant to correlate the invoice with an order or other object in their system.
+ * This passthru variable can be a serialized object.
+ *
+ * @return string|null The pos data
+ */
+ public function getPosData(): ?string
{
- return $this->_posData;
+ return $this->posData;
}
- public function setPosData(string $posData)
+ /**
+ * Sets posData
+ *
+ * A passthru variable provided by the merchant during invoice creation and designed to be
+ * used by the merchant to correlate the invoice with an order or other object in their system.
+ * This passthru variable can be a serialized object.
+ *
+ * @param string $posData the pos data
+ */
+ public function setPosData(string $posData): void
{
- $this->_posData = $posData;
+ $this->posData = $posData;
}
- public function getNotificationURL()
+ /**
+ * Gets notificationURL
+ *
+ * @return string|null - URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ */
+ public function getNotificationURL(): ?string
{
- return $this->_notificationURL;
+ return $this->notificationURL;
}
- public function setNotificationURL(string $notificationURL)
+ /**
+ * Sets notificationURL
+ *
+ * @param string $notificationURL - URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ */
+ public function setNotificationURL(string $notificationURL): void
{
- $this->_notificationURL = $notificationURL;
+ $this->notificationURL = $notificationURL;
}
- public function getTransactionSpeed()
+ /**
+ * Gets transactionSpeed.
+ *
+ * This is a risk mitigation parameter for the merchant to configure how they want
+ * to fulfill orders depending on the number of block confirmations for the transaction
+ * made by the consumer on the selected cryptocurrency.
+ * If not set on the invoice, transactionSpeed will default to the account-level Order Settings.
+ * Note : orders are only credited to your BitPay Account Summary for settlement after
+ * the invoice reaches the status "complete" (regardless of this setting).
+ *
+ * @return string|null the transaction speed
+ */
+ public function getTransactionSpeed(): ?string
{
- return $this->_transactionSpeed;
+ return $this->transactionSpeed;
}
- public function setTransactionSpeed(string $transactionSpeed)
+ /**
+ * Sets transactionSpeed.
+ *
+ * This is a risk mitigation parameter for the merchant to configure how they want
+ * to fulfill orders depending on the number of block confirmations for the transaction
+ * made by the consumer on the selected cryptocurrency.
+ * If not set on the invoice, transactionSpeed will default to the account-level Order Settings.
+ * Note : orders are only credited to your BitPay Account Summary for settlement after
+ * the invoice reaches the status "complete" (regardless of this setting).
+ *
+ * @param string $transactionSpeed the transaction speed
+ */
+ public function setTransactionSpeed(string $transactionSpeed): void
{
- $this->_transactionSpeed = $transactionSpeed;
+ $this->transactionSpeed = $transactionSpeed;
}
- public function getFullNotifications()
+ /**
+ * Gets fullNotifications
+ *
+ * This parameter is set to true by default, meaning all standard notifications
+ * are being sent for a payment made to an invoice.
+ * If you decide to set it to false instead, only 1 webhook will be sent for each
+ * invoice paid by the consumer.
+ * This webhook will be for the "confirmed" or "complete" invoice status,
+ * depending on the transactionSpeed selected.
+ *
+ * @return bool|null the full notification
+ */
+ public function getFullNotifications(): ?bool
{
- return $this->_fullNotifications;
+ return $this->fullNotifications;
}
- public function setFullNotifications(bool $fullNotifications)
+ /**
+ * Sets fullNotifications
+ *
+ * This parameter is set to true by default, meaning all standard notifications
+ * are being sent for a payment made to an invoice.
+ * If you decide to set it to false instead, only 1 webhook will be sent for each
+ * invoice paid by the consumer.
+ * This webhook will be for the "confirmed" or "complete" invoice status,
+ * depending on the transactionSpeed selected.
+ *
+ * @param bool $fullNotifications the full notification
+ */
+ public function setFullNotifications(bool $fullNotifications): void
{
- $this->_fullNotifications = $fullNotifications;
+ $this->fullNotifications = $fullNotifications;
}
- public function getNotificationEmail()
+ /**
+ * Gets NotificationEmail
+ *
+ * Merchant email address for notification of payout status change.
+ *
+ * @return string|null the notification email
+ */
+ public function getNotificationEmail(): ?string
{
- return $this->_notificationEmail;
+ return $this->notificationEmail;
}
- public function setNotificationEmail(string $notificationEmail)
+ /**
+ * Sets NotificationEmail
+ *
+ * Merchant email address for notification of payout status change.
+ *
+ * @param string $notificationEmail Merchant email address for notification of payout status change
+ */
+ public function setNotificationEmail(string $notificationEmail): void
{
- $this->_notificationEmail = $notificationEmail;
+ $this->notificationEmail = $notificationEmail;
}
- public function getRedirectURL()
+ /**
+ * Gets RedirectURL
+ *
+ * The shopper will be redirected to this URL when clicking on the Return button
+ * after a successful payment or when clicking on the Close button if a separate closeURL is not specified.
+ *
+ * @return string|null the redirect url
+ */
+ public function getRedirectURL(): ?string
{
- return $this->_redirectURL;
+ return $this->redirectURL;
}
- public function setRedirectURL(string $redirectURL)
+ /**
+ * Sets RedirectURL
+ *
+ * The shopper will be redirected to this URL when clicking on the Return button
+ * after a successful payment or when clicking on the Close button if a separate closeURL is not specified.
+ * Be sure to include "http://" or "https://" in the url.
+ *
+ * @param string $redirectURL The shopper will be redirected to this URL
+ */
+ public function setRedirectURL(string $redirectURL): void
{
- $this->_redirectURL = $redirectURL;
+ $this->redirectURL = $redirectURL;
}
- public function getOrderId()
+ /**
+ * Gets orderId
+ *
+ * Can be used by the merchant to assign their own internal Id to an invoice.
+ * If used, there should be a direct match between an orderId and an invoice id.
+ *
+ * @return string|null
+ */
+ public function getOrderId(): ?string
{
- return $this->_orderId;
+ return $this->orderId;
}
- public function setOrderId(string $orderId)
+ /**
+ * Sets orderId
+ *
+ * Can be used by the merchant to assign their own internal Id to an invoice.
+ * If used, there should be a direct match between an orderId and an invoice id.
+ *
+ * @param string $orderId Invoice order id
+ */
+ public function setOrderId(string $orderId): void
{
- $this->_orderId = $orderId;
+ $this->orderId = $orderId;
}
- public function getItemDesc()
- {
- return $this->_itemDesc;
- }
- public function setItemDesc(string $itemDesc)
+ /**
+ * Gets itemDesc
+ *
+ * Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.
+ *
+ * @return string|null the item desc
+ */
+ public function getItemDesc(): ?string
{
- $this->_itemDesc = $itemDesc;
+ return $this->itemDesc;
}
- public function getItemCode()
+
+ /**
+ * Sets itemDesc
+ *
+ * Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.
+ *
+ * @param string $itemDesc Invoice description
+ */
+ public function setItemDesc(string $itemDesc): void
{
- return $this->_itemCode;
+ $this->itemDesc = $itemDesc;
}
- public function setItemCode(string $itemCode)
+ /**
+ * Gets itemCode
+ *
+ * "bitcoindonation" for donations, otherwise do not include the field in the request.
+ *
+ * @return string|null the item code
+ */
+ public function getItemCode(): ?string
{
- $this->_itemCode = $itemCode;
+ return $this->itemCode;
}
- public function getPhysical()
+ /**
+ * Sets itemCode
+ *
+ * "bitcoindonation" for donations, otherwise do not include the field in the request.
+ *
+ * @param string $itemCode "bitcoindonation" for donations, otherwise do not include the field in the request.
+ */
+ public function setItemCode(string $itemCode): void
{
- return $this->_physical;
+ $this->itemCode = $itemCode;
}
- public function setPhysical(bool $physical)
+ /**
+ * Gets physical.
+ *
+ * Indicates whether items are physical goods. Alternatives include digital goods and services.
+ *
+ * @return bool|null the physical
+ */
+ public function getPhysical(): ?bool
{
- $this->_physical = $physical;
+ return $this->physical;
}
- public function getPaymentCurrencies()
+ /**
+ * Sets physical.
+ *
+ * Indicates whether items are physical goods. Alternatives include digital goods and services.
+ *
+ * @param bool $physical the physical
+ */
+ public function setPhysical(bool $physical): void
{
- return $this->_paymentCurrencies;
+ $this->physical = $physical;
}
- public function setPaymentCurrencies(array $paymentCurrencies)
+ /**
+ * Gets paymentCurrencies
+ *
+ * Allow the merchant to select the cryptocurrencies available as payment option on the BitPay invoice.
+ * Possible values are currently "BTC", "BCH", "ETH", "GUSD",
+ * "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * For instance "paymentCurrencies": ["BTC"] will create an invoice with only XRP available as transaction currency,
+ * thus bypassing the currency selection step on the invoice.
+ *
+ * @return array|null the payment currencies
+ */
+ public function getPaymentCurrencies(): ?array
{
- $this->_paymentCurrencies = $paymentCurrencies;
+ return $this->paymentCurrencies;
}
- public function getAcceptanceWindow()
+ /**
+ * Sets paymentCurrencies
+ *
+ * Allow the merchant to select the cryptocurrencies available as payment option on the BitPay invoice.
+ * Possible values are currently "BTC", "BCH", "ETH", "GUSD",
+ * "PAX", "BUSD", "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * For instance "paymentCurrencies": ["BTC"] will create an invoice with only XRP available as transaction currency,
+ * thus bypassing the currency selection step on the invoice.
+ *
+ * @param array $paymentCurrencies the payment currencies
+ */
+ public function setPaymentCurrencies(array $paymentCurrencies): void
{
- return $this->_acceptanceWindow;
+ $this->paymentCurrencies = $paymentCurrencies;
}
- // Buyer data
- //
-
- public function setAcceptanceWindow(float $acceptanceWindow)
+ /**
+ * Gets closeURL
+ *
+ * URL to redirect if the shopper does not pay the invoice and click on the Close button instead.
+ *
+ * @return string|null the close url
+ */
+ public function getCloseURL(): ?string
{
- $this->_acceptanceWindow = $acceptanceWindow;
+ return $this->closeURL;
}
- public function getBuyer()
+ /**
+ * Gets closeURL
+ *
+ * URL to redirect if the shopper does not pay the invoice and click on the Close button instead.
+ * Be sure to include "http://" or "https://" in the url.
+ *
+ * @param string $closeURL URL to redirect if the shopper does not pay the invoice
+ */
+ public function setCloseURL(string $closeURL): void
{
- return $this->_buyer;
+ $this->closeURL = $closeURL;
}
- public function setBuyer(Buyer $buyer)
+ /**
+ * Gets autoRedirect
+ *
+ * Set to false by default,
+ * merchant can setup automatic redirect to their website by setting this parameter to true.
+ *
+ * @return bool|null the auto redirect
+ */
+ public function getAutoRedirect(): ?bool
{
- $this->_buyer = $buyer;
+ return $this->autoRedirect;
}
- // Response fields
- //
-
- public function getRefundAddresses()
+ /**
+ * Sets autoRedirect
+ *
+ * Set to false by default,
+ * merchant can setup automatic redirect to their website by setting this parameter to true.
+ *
+ * @param bool $autoRedirect the auto redirect
+ */
+ public function setAutoRedirect(bool $autoRedirect): void
{
- return $this->_refundAddresses;
+ $this->autoRedirect = $autoRedirect;
}
- public function setRefundAddresses(array $refundAddresses)
+ /**
+ * Gets jsonPayProRequired
+ *
+ * Boolean set to false by default.
+ * If set to true, this means that the invoice will only accept payments
+ * from wallets which have implemented the
+ * BitPay JSON Payment Protocol
+ *
+ * @return bool|null the json pay pro required
+ */
+ public function getJsonPayProRequired(): ?bool
{
- $this->_refundAddresses = $refundAddresses;
+ return $this->jsonPayProRequired;
}
- public function getId()
+ /**
+ * Sets jsonPayProRequired
+ *
+ * Boolean set to false by default.
+ * If set to true, this means that the invoice will only accept payments
+ * from wallets which have implemented the
+ * BitPay JSON Payment Protocol
+ *
+ * @param bool $jsonPayProRequired the json pay pro required
+ */
+ public function setJsonPayProRequired(bool $jsonPayProRequired): void
{
- return $this->_id;
+ $this->jsonPayProRequired = $jsonPayProRequired;
}
- public function setId($id)
+ /**
+ * Gets bitpayIdRequired
+ *
+ * BitPay ID is a verification process that is required when a user is making payments
+ * or receiving a refund over a given threshold, which may vary by region.
+ * This Boolean forces the invoice to require BitPay ID regardless of the price.
+ *
+ * @return bool|null the Bitpay id required
+ */
+ public function getBitpayIdRequired(): ?bool
{
- $this->_id = $id;
+ return $this->bitpayIdRequired;
}
- public function getUrl()
+ /**
+ * Sets bitpayIdRequired
+ *
+ * BitPay ID is a verification process that is required when a user is making payments
+ * or receiving a refund over a given threshold, which may vary by region.
+ * This Boolean forces the invoice to require BitPay ID regardless of the price.
+ *
+ * @param bool $bitpayIdRequired the bitpay id required
+ */
+ public function setBitpayIdRequired(bool $bitpayIdRequired): void
{
- return $this->_url;
+ $this->bitpayIdRequired = $bitpayIdRequired;
}
- public function setUrl($url)
+ /**
+ * Gets merchantName
+ *
+ * A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).
+ *
+ * @return string|null the merchant name
+ */
+ public function getMerchantName(): ?string
{
- $this->_url = $url;
+ return $this->merchantName;
}
- public function getStatus()
+ /**
+ * Sets merchantName
+ *
+ * A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).
+ *
+ * @param string $merchantName A display string for merchant identification
+ */
+ public function setMerchantName(string $merchantName): void
{
- return $this->_status;
+ $this->merchantName = $merchantName;
}
- public function setStatus($status)
+ /**
+ * Gets selectedTransactionCurrency
+ *
+ * This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+ * current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+ * "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * If not yet selected, this field will not be returned.
+ *
+ * @return string|null the selected transaction currency
+ */
+ public function getSelectedTransactionCurrency(): ?string
{
- $this->_status = $status;
+ return $this->selectedTransactionCurrency;
}
- public function getLowFeeDetected()
+ /**
+ * Sets selectedTransactionCurrency
+ *
+ * This field will be populated with the cryptocurrency selected to pay the BitPay invoice,
+ * current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+ * "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ * If not yet selected, this field will not be returned.
+ *
+ * @param string $selectedTransactionCurrency This field will be populated with the cryptocurrency selected
+ * to pay the BitPay invoice
+ */
+ public function setSelectedTransactionCurrency(string $selectedTransactionCurrency): void
{
- return $this->_lowFeeDetected;
+ $this->selectedTransactionCurrency = $selectedTransactionCurrency;
}
- public function setLowFeeDetected($lowFeeDetected)
+ /**
+ * Gets forcedBuyerSelectedWallet
+ *
+ * Merchant pre-selects transaction currency on behalf of buyer.
+ *
+ * @return string|null the forced buyer selected wallet
+ */
+ public function getForcedBuyerSelectedWallet(): ?string
{
- $this->_lowFeeDetected = $lowFeeDetected;
+ return $this->forcedBuyerSelectedWallet;
}
- public function getInvoiceTime()
+ /**
+ * Sets forcedBuyerSelectedWallet
+ *
+ * Merchant pre-selects transaction currency on behalf of buyer.
+ *
+ * @param string $forcedBuyerSelectedWallet Merchant pre-selects wallet on behalf of buyer
+ */
+ public function setForcedBuyerSelectedWallet(string $forcedBuyerSelectedWallet)
{
- return $this->_invoiceTime;
+ $this->forcedBuyerSelectedWallet = $forcedBuyerSelectedWallet;
}
- public function setInvoiceTime($invoiceTime)
+ /**
+ * Gets forcedBuyerSelectedWallet
+ *
+ * Merchant pre-selects transaction currency on behalf of buyer.
+ *
+ * @return string|null Merchant pre-selects transaction currency
+ */
+ public function getForcedBuyerSelectedTransactionCurrency(): ?string
{
- $this->_invoiceTime = $invoiceTime;
+ return $this->forcedBuyerSelectedTransactionCurrency;
}
- public function getExpirationTime()
+ /**
+ * Sets forcedBuyerSelectedWallet
+ *
+ * Merchant pre-selects transaction currency on behalf of buyer.
+ *
+ * @param string $forcedBuyerSelectedTransactionCurrency Merchant pre-selects transaction currency
+ */
+ public function setForcedBuyerSelectedTransactionCurrency(string $forcedBuyerSelectedTransactionCurrency)
{
- return $this->_expirationTime;
+ $this->forcedBuyerSelectedTransactionCurrency = $forcedBuyerSelectedTransactionCurrency;
}
- public function setExpirationTime($expirationTime)
+ /**
+ * Gets itemizedDetails
+ *
+ * Object containing line item details for display.
+ *
+ * @return ItemizedDetails[]
+ */
+ public function getItemizedDetails(): array
{
- $this->_expirationTime = $expirationTime;
+ return $this->itemizedDetails;
}
- public function getCurrentTime()
+ /**
+ * Sets itemizedDetails
+ *
+ * Object containing line item details for display.
+ *
+ * @param ItemizedDetails[] $itemizedDetails
+ * @throws BitPayException
+ */
+ public function setItemizedDetails(array $itemizedDetails): void
{
- return $this->_currentTime;
+ foreach ($itemizedDetails as $item) {
+ if (!$item instanceof ItemizedDetails) {
+ throw new BitPayException('Wrong format for itemized details');
+ }
+ }
+
+ $this->itemizedDetails = $itemizedDetails;
}
- public function setCurrentTime($currentTime)
+ /**
+ * Gets acceptanceWindow
+ *
+ * Number of milliseconds that a user has to pay an invoice before it expires (0-900000).
+ * If not set, invoice will default to the account acceptanceWindow.
+ * If account acceptanceWindow is not set, invoice will default to 15 minutes (900,000 milliseconds).
+ *
+ * @return float|null the acceptance window
+ */
+ public function getAcceptanceWindow(): ?float
{
- $this->_currentTime = $currentTime;
+ return $this->acceptanceWindow;
}
- public function getTransactions()
+ /**
+ * Sets acceptanceWindow
+ *
+ * Number of milliseconds that a user has to pay an invoice before it expires (0-900000).
+ * If not set, invoice will default to the account acceptanceWindow.
+ * If account acceptanceWindow is not set, invoice will default to 15 minutes (900,000 milliseconds).
+ *
+ * @param float $acceptanceWindow Number of milliseconds that a user has to pay an invoice before it expire
+ */
+ public function setAcceptanceWindow(float $acceptanceWindow): void
{
- return $this->_transactions;
+ $this->acceptanceWindow = $acceptanceWindow;
}
- public function setTransactions($transactions)
+ /**
+ * Gets buyer
+ *
+ * Allows merchant to pass buyer related information in the invoice object
+ *
+ * @return Buyer|null the buyer
+ */
+ public function getBuyer(): ?Buyer
{
- $this->_transactions = $transactions;
+ return $this->buyer;
}
- public function getExceptionStatus()
+ /**
+ * Sets buyer
+ *
+ * Allows merchant to pass buyer related information in the invoice object
+ *
+ * @param Buyer $buyer the buyer
+ */
+ public function setBuyer(Buyer $buyer): void
{
- return $this->_exceptionStatus;
+ $this->buyer = $buyer;
}
- public function setExceptionStatus($exceptionStatus)
+ /**
+ * Gets buyerEmail
+ *
+ * Buyer's email address.
+ * If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+ *
+ * @return string|null the buyer email
+ */
+ public function getBuyerEmail(): ?string
{
- $this->_exceptionStatus = $exceptionStatus;
+ return $this->buyerEmail;
}
- public function getTargetConfirmations()
+ /**
+ * Sets buyerEmail
+ *
+ * Buyer's email address.
+ * If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
+ *
+ * @param string $buyerEmail Buyer's email address
+ */
+ public function setBuyerEmail(string $buyerEmail): void
{
- return $this->_targetConfirmations;
+ $this->buyerEmail = $buyerEmail;
}
- public function setTargetConfirmations($targetConfirmations)
+ /**
+ * Gets buyerSms
+ *
+ * SMS provided by user for communications.
+ * This is only used for instances where a buyers email
+ * (primary form of buyer communication) is can not be gathered.
+ *
+ * @return string|null the buyer sms
+ */
+ public function getBuyerSms(): ?string
{
- $this->_targetConfirmations = $targetConfirmations;
+ return $this->buyerSms;
}
- public function getRefundAddressRequestPending()
+ /**
+ * Sets buyerSms
+ *
+ * SMS provided by user for communications.
+ * This is only used for instances where a buyers email
+ * (primary form of buyer communication) is can not be gathered.
+ *
+ * @param string $buyerSms SMS provided by user for communication
+ */
+ public function setBuyerSms(string $buyerSms): void
{
- return $this->_refundAddressRequestPending;
+ $this->buyerSms = $buyerSms;
}
- public function setRefundAddressRequestPending($refundAddressRequestPending)
+ // Response fields
+ //
+
+ /**
+ * Gets refundAddresses
+ *
+ * Initially empty when the invoice is created.
+ * This field will be populated with the refund address
+ * provided by the customer if you request a refund of the specific invoice.
+ *
+ * @return array|null Refund address provided by the customer
+ */
+ public function getRefundAddresses(): ?array
{
- $this->_refundAddressRequestPending = $refundAddressRequestPending;
+ return $this->refundAddresses;
}
- public function getBuyerProvidedEmail()
+ /**
+ * Sets refundAddresses
+ *
+ * Initially empty when the invoice is created.
+ * This field will be populated with the refund address
+ * provided by the customer if you request a refund of the specific invoice.
+ *
+ * @param array $refundAddresses Refund address provided by the customer
+ */
+ public function setRefundAddresses(array $refundAddresses): void
{
- return $this->_buyerProvidedEmail;
+ $this->refundAddresses = $refundAddresses;
}
- public function setBuyerProvidedEmail($buyerProvidedEmail)
+ /**
+ * Gets invoice resource id
+ *
+ * @return string|null Invoice resource id
+ */
+ public function getId(): ?string
{
- $this->_buyerProvidedEmail = $buyerProvidedEmail;
+ return $this->id;
}
- public function getBuyerProvidedInfo()
+ /**
+ * Sets invoice resource id
+ *
+ * @param string $id Invoice resource id
+ */
+ public function setId(string $id): void
+ {
+ $this->id = $id;
+ }
+
+ /**
+ * Gets url
+ *
+ * Web address of invoice, expires at expirationTime
+ *
+ * @return string|null Web address of invoice
+ */
+ public function getUrl(): ?string
+ {
+ return $this->url;
+ }
+
+ /**
+ * Sets url
+ *
+ * Web address of invoice, expires at expirationTime
+ *
+ * @param string $url Web address of invoice
+ */
+ public function setUrl(string $url): void
+ {
+ $this->url = $url;
+ }
+
+ /**
+ * Gets status
+ *
+ * Detailed information about invoice status notifications can be found under the
+ *
+ * Instant Payment Notification (IPN) section.
+ *
+ *
+ * @return string|null Invoice status
+ */
+ public function getStatus(): ?string
+ {
+ return $this->status;
+ }
+
+ /**
+ * Sets status
+ *
+ * Detailed information about invoice status notifications can be found under the
+ *
+ * Instant Payment Notification (IPN) section.
+ *
+ *
+ * @param string $status Invoice status
+ */
+ public function setStatus(string $status): void
+ {
+ $this->status = $status;
+ }
+
+ /**
+ * Gets lowFeeDetected
+ *
+ * Flag to indicate if the miner fee used by the buyer is too low.
+ * Initially set to false when the invoice is created.
+ *
+ * @return bool|null Flag to indicate if the miner fee used by the buyer is too low
+ */
+ public function getLowFeeDetected(): ?bool
+ {
+ return $this->lowFeeDetected;
+ }
+
+ /**
+ * Sets lowFeeDetected
+ *
+ * Flag to indicate if the miner fee used by the buyer is too low.
+ * Initially set to false when the invoice is created.
+ *
+ * @param boolean $lowFeeDetected Flag to indicate if the miner fee used by the buyer is too low
+ */
+ public function setLowFeeDetected(bool $lowFeeDetected)
+ {
+ $this->lowFeeDetected = $lowFeeDetected;
+ }
+
+ /**
+ * Gets invoiceTime - UNIX time of invoice creation, in milliseconds
+ *
+ * @return int|null UNIX time of invoice creation, in milliseconds
+ */
+ public function getInvoiceTime(): ?int
+ {
+ return $this->invoiceTime;
+ }
+
+ /**
+ * Sets invoiceTime - UNIX time of invoice creation, in milliseconds
+ *
+ * @param int $invoiceTime UNIX time of invoice creation, in milliseconds
+ */
+ public function setInvoiceTime(int $invoiceTime)
+ {
+ $this->invoiceTime = $invoiceTime;
+ }
+
+ /**
+ * Gets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+ *
+ * @return string|null the UNIX time
+ */
+ public function getExpirationTime(): ?string
+ {
+ return $this->expirationTime;
+ }
+
+ /**
+ * Sets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
+ *
+ * @param string $expirationTime UNIX time when invoice is last available to be paid, in milliseconds
+ */
+ public function setExpirationTime(string $expirationTime): void
+ {
+ $this->expirationTime = $expirationTime;
+ }
+
+ /**
+ * Gets currentTime - UNIX time of API call, in milliseconds
+ *
+ * @return string|null UNIX time
+ */
+ public function getCurrentTime(): ?string
+ {
+ return $this->currentTime;
+ }
+
+ /**
+ * Sets currentTime - UNIX time of API call, in milliseconds
+ *
+ * @param string $currentTime UNIX time of API call, in milliseconds
+ */
+ public function setCurrentTime(string $currentTime): void
+ {
+ $this->currentTime = $currentTime;
+ }
+
+ /**
+ * Gets transactions
+ *
+ * Contains the cryptocurrency transaction details for the executed payout.
+ *
+ * @return array|null the transactions
+ */
+ public function getTransactions(): ?array
{
- return $this->_buyerProvidedInfo;
+ return $this->transactions;
}
+ /**
+ * Sets transactions
+ *
+ * Contains the cryptocurrency transaction details for the executed payout.
+ *
+ * @param array $transactions array with the crypto currency transaction hashes linked to the invoice
+ */
+ public function setTransactions(array $transactions): void
+ {
+ $this->transactions = $transactions;
+ }
+
+ /**
+ * Gets exceptionStatus
+ *
+ * Initially a boolean false, this parameter will indicate if the purchaser sent too much ("paidOver")
+ * or not enough funds ("paidPartial") in the transaction to pay the BitPay invoice. Possible values are:
+ * false: default value (boolean) unless an exception is triggered.
+ * "paidPartial": (string) if the consumer did not send enough funds when paying the invoice.
+ * "paidOver": (string) if the consumer sent to much funds when paying the invoice.
+ *
+ * @return bool|null the exception status
+ */
+ public function getExceptionStatus(): ?bool
+ {
+ return $this->exceptionStatus;
+ }
+
+ /**
+ * Sets exceptionStatus
+ *
+ * Initially a boolean false, this parameter will indicate if the purchaser sent too much ("paidOver")
+ * or not enough funds ("paidPartial") in the transaction to pay the BitPay invoice. Possible values are:
+ * false: default value (boolean) unless an exception is triggered.
+ * "paidPartial": (string) if the consumer did not send enough funds when paying the invoice.
+ * "paidOver": (string) if the consumer sent to much funds when paying the invoice.
+ *
+ * @param boolean $exceptionStatus this parameter will indicate if the purchaser sent too much or not enough funds
+ */
+ public function setExceptionStatus(bool $exceptionStatus): void
+ {
+ $this->exceptionStatus = $exceptionStatus;
+ }
+
+ /**
+ * Gets targetConfirmations
+ *
+ * Indicates the number of block confirmation of the crypto currency
+ * transaction which are required to credit a paid invoice to the merchant account.
+ * Currently, the value set is set to 6 by default for BTC/BCH/XRP,
+ * 40 for DOGE and 50 for ETH/GUSD/PAX/USDC/BUSD/DAI/WBTC
+ *
+ * @return int|null the target confirmations
+ */
+ public function getTargetConfirmations(): ?int
+ {
+ return $this->targetConfirmations;
+ }
+
+ /**
+ * Sets targetConfirmations
+ *
+ * Indicates the number of block confirmation of the crypto currency
+ * transaction which are required to credit a paid invoice to the merchant account.
+ * Currently, the value set is set to 6 by default for BTC/BCH/XRP,
+ * 40 for DOGE and 50 for ETH/GUSD/PAX/USDC/BUSD/DAI/WBTC
+ *c
+ * @param int $targetConfirmations Indicates the number of block confirmation of the crypto currency transaction
+ * which are required to credit a paid invoice to the merchant account
+ */
+ public function setTargetConfirmations(int $targetConfirmations): void
+ {
+ $this->targetConfirmations = $targetConfirmations;
+ }
+
+ /**
+ * Gets refundAddressRequestPending
+ *
+ * Initially set to false when the invoice is created,
+ * this field will be set to true once a refund request has been issued by the merchant.
+ * This flag is here to indicate that the refund request is pending action
+ * from the buyer to provide an address for the refund,
+ * via the secure link which has been automatically emailed to him.
+ *
+ * @return bool|null the refund address request pending
+ */
+ public function getRefundAddressRequestPending(): ?bool
+ {
+ return $this->refundAddressRequestPending;
+ }
+
+ /**
+ * Sets refundAddressRequestPending
+ *
+ * Initially set to false when the invoice is created,
+ * this field will be set to true once a refund request has been issued by the merchant.
+ * This flag is here to indicate that the refund request is pending action
+ * from the buyer to provide an address for the refund,
+ * via the secure link which has been automatically emailed to him.
+ *
+ * @param boolean $refundAddressRequestPending This flag is here to indicate that the refund
+ * request is pending action
+ */
+ public function setRefundAddressRequestPending(bool $refundAddressRequestPending): void
+ {
+ $this->refundAddressRequestPending = $refundAddressRequestPending;
+ }
+
+ /**
+ * Gets buyerProvidedEmail
+ *
+ * Populated with the buyer's email address if passed in the buyer object by the merchant,
+ * otherwise this field is not returned for newly created invoices.
+ * If the merchant does not pass the buyer email in the invoice request,
+ * the bitpay invoice UI will prompt the user to enter his
+ * email address and this field will be populated with the email submitted.
+ *
+ * @return string|null the buyer provided email
+ */
+ public function getBuyerProvidedEmail(): ?string
+ {
+ return $this->buyerProvidedEmail;
+ }
+
+ /**
+ * Sets buyerProvidedEmail
+ *
+ * Populated with the buyer's email address if passed in the buyer object by the merchant,
+ * otherwise this field is not returned for newly created invoices.
+ * If the merchant does not pass the buyer email in the invoice request,
+ * the bitpay invoice UI will prompt the user to enter his
+ * email address and this field will be populated with the email submitted.
+ *
+ * @param string $buyerProvidedEmail Populated with the buyer's email address if passed in the buyer object
+ * by the merchant
+ */
+ public function setBuyerProvidedEmail(string $buyerProvidedEmail): void
+ {
+ $this->buyerProvidedEmail = $buyerProvidedEmail;
+ }
+
+ /**
+ * Gets buyerProvidedEmail
+ *
+ * Information collected from the buyer during the process of paying an invoice.
+ * Initially this object is empty.
+ *
+ * @return BuyerProvidedInfo|null Information collected from the buyer
+ */
+ public function getBuyerProvidedInfo(): ?BuyerProvidedInfo
+ {
+ return $this->buyerProvidedInfo;
+ }
+
+ /**
+ * Sets buyerProvidedEmail
+ *
+ * Information collected from the buyer during the process of paying an invoice.
+ * Initially this object is empty.
+ *
+ * @param BuyerProvidedInfo $buyerProvidedInfo Information collected from the buyer
+ * during the process of paying an invoice
+ */
public function setBuyerProvidedInfo(BuyerProvidedInfo $buyerProvidedInfo)
{
- $this->_buyerProvidedInfo = $buyerProvidedInfo;
+ $this->buyerProvidedInfo = $buyerProvidedInfo;
+ }
+
+ /**
+ * Gets universalCodes
+ *
+ * Object containing wallet-specific URLs for payment protocol.
+ *
+ * @return UniversalCodes|null UniversalCodes
+ */
+ public function getUniversalCodes(): ?UniversalCodes
+ {
+ return $this->universalCodes;
+ }
+
+ /**
+ * Sets universalCodes
+ *
+ * @param UniversalCodes $universalCodes Object containing wallet-specific URLs for payment protocol.
+ */
+ public function setUniversalCodes(UniversalCodes $universalCodes)
+ {
+ $this->universalCodes = $universalCodes;
+ }
+
+ /**
+ * Gets supportedTransactionCurrencies
+ *
+ * The currencies that may be used to pay this invoice.
+ * The object is keyed by currency code.
+ * The values are objects with an "enabled" boolean and option.
+ * An extra "reason" parameter is added in the object if a cryptocurrency is disabled on a specific invoice.
+ * If you disable a currency via the invoice parameter "paymentCurrencies",
+ * this parameter will be set to "merchantDisabledByParam"
+ *
+ * @return SupportedTransactionCurrencies|null The currencies that may be used to pay this invoice
+ */
+ public function getSupportedTransactionCurrencies(): ?SupportedTransactionCurrencies
+ {
+ return $this->supportedTransactionCurrencies;
+ }
+
+ /**
+ * Sets supportedTransactionCurrencies
+ *
+ * The currencies that may be used to pay this invoice.
+ * The object is keyed by currency code.
+ * The values are objects with an "enabled" boolean and option.
+ * An extra "reason" parameter is added in the object if a cryptocurrency is disabled on a specific invoice.
+ * If you disable a currency via the invoice parameter "paymentCurrencies",
+ * this parameter will be set to "merchantDisabledByParam"
+ *
+ * @param SupportedTransactionCurrencies $supportedTransactionCurrencies The currencies that may be used
+ * to pay this invoice
+ */
+ public function setSupportedTransactionCurrencies(
+ SupportedTransactionCurrencies $supportedTransactionCurrencies
+ ): void {
+ $this->supportedTransactionCurrencies = $supportedTransactionCurrencies;
+ }
+
+ /**
+ * Gets paymentTotals
+ *
+ * For internal use - This field can be ignored in merchant implementations.
+ *
+ * @return array|null the payment totals
+ */
+ public function getPaymentTotals(): ?array
+ {
+ return $this->paymentTotals;
}
- public function getSupportedTransactionCurrencies()
+ /**
+ * Sets paymentTotals
+ *
+ * For internal use - This field can be ignored in merchant implementations.
+ *
+ * @param array|null $paymentTotals the payment totals
+ */
+ public function setPaymentTotals(?array $paymentTotals)
{
- return $this->_supportedTransactionCurrencies;
+ $this->paymentTotals = $paymentTotals;
}
- public function setSupportedTransactionCurrencies(SupportedTransactionCurrencies $supportedTransactionCurrencies)
+ /**
+ * Gets paymentSubtotals
+ *
+ * For internal use. This field can be ignored in merchant implementations.
+ *
+ * @return array|null the payment subtotals
+ */
+ public function getPaymentSubtotals(): ?array
{
- $this->_supportedTransactionCurrencies = $supportedTransactionCurrencies;
+ return $this->paymentSubtotals;
}
- public function getMinerFees()
+ /**
+ * Sets paymentSubtotals
+ *
+ * For internal use. This field can be ignored in merchant implementations.
+ *
+ * @param array|null $paymentSubtotals the payment subtotals
+ */
+ public function setPaymentSubtotals(?array $paymentSubtotals)
{
- return $this->_minerFees;
+ $this->paymentSubtotals = $paymentSubtotals;
}
- public function setMinerFees(MinerFees $minerFees)
+ /**
+ * Gets paymentDisplaySubtotals
+ *
+ * Equivalent to price for each supported transactionCurrency, excluding minerFees.
+ * The key is the currency and the value is an amount indicated in the base unit
+ * for each supported transactionCurrency.
+ *
+ * @return array|null Equivalent to price for each supported transactionCurrency
+ */
+ public function getPaymentDisplaySubTotals(): ?array
{
- $this->_minerFees = $minerFees;
+ return $this->paymentDisplaySubTotals;
}
- public function getShopper()
+ /**
+ * Sets paymentDisplaySubtotals
+ *
+ * Equivalent to price for each supported transactionCurrency, excluding minerFees.
+ * The key is the currency and the value is an amount indicated in the base unit
+ * for each supported transactionCurrency.
+ *
+ * @param array|null $paymentDisplaySubTotals Equivalent to price for each supported transactionCurrency
+ */
+ public function setPaymentDisplaySubTotals(?array $paymentDisplaySubTotals)
{
- return $this->_shopper;
+ $this->paymentDisplaySubTotals = $paymentDisplaySubTotals;
}
- public function setShopper(Shopper $shopper)
+ /**
+ * Gets paymentDisplayTotals
+ *
+ * The total amount that the purchaser should pay as displayed on the invoice UI.
+ * This is like paymentDisplaySubTotals but with the minerFees included.
+ * The key is the currency and the value is an amount
+ * indicated in the base unit for each supported transactionCurrency.
+ *
+ * @return array|null The total amount that the purchaser should pay
+ */
+ public function getPaymentDisplayTotals(): ?array
+ {
+ return $this->paymentDisplayTotals;
+ }
+
+ /**
+ * Sets paymentDisplayTotals
+ *
+ * The total amount that the purchaser should pay as displayed on the invoice UI.
+ * This is like paymentDisplaySubTotals but with the minerFees included.
+ * The key is the currency and the value is an amount
+ * indicated in the base unit for each supported transactionCurrency.
+ *
+ * @param array|null $paymentDisplayTotals The total amount that the purchaser should pay
+ */
+ public function setPaymentDisplayTotals(?array $paymentDisplayTotals)
+ {
+ $this->paymentDisplayTotals = $paymentDisplayTotals;
+ }
+
+ /**
+ * Gets paymentCodes
+ *
+ * The URIs for sending a transaction to the invoice. The first key is the transaction currency.
+ * The transaction currency maps to an object containing the payment URIs.
+ * The key of this object is the BIP number and the value is the payment URI.
+ * For "BTC", "BCH" and "DOGE" - BIP72b and BIP73 are supported.
+ * For "ETH", "GUSD", "PAX", "BUSD", "USDC", "DAI" and "WBTC"- EIP681 is supported
+ * For "XRP" - RIP681, BIP72b and BIP73 is supported
+ *
+ * @return array|null
+ */
+ public function getPaymentCodes(): ?array
+ {
+ return $this->paymentCodes;
+ }
+
+ /**
+ * Sets paymentCodes
+ *
+ * The URIs for sending a transaction to the invoice. The first key is the transaction currency.
+ * The transaction currency maps to an object containing the payment URIs.
+ * The key of this object is the BIP number and the value is the payment URI.
+ * For "BTC", "BCH" and "DOGE" - BIP72b and BIP73 are supported.
+ * For "ETH", "GUSD", "PAX", "BUSD", "USDC", "DAI" and "WBTC"- EIP681 is supported
+ * For "XRP" - RIP681, BIP72b and BIP73 is supported
+ *
+ * @param array|null $paymentCodes
+ */
+ public function setPaymentCodes(?array $paymentCodes)
+ {
+ $this->paymentCodes = $paymentCodes;
+ }
+
+ /**
+ * Gets underpaidAmount
+ *
+ * This parameter will be returned on the invoice object
+ * if the invoice was underpaid ("exceptionStatus": "paidPartial").
+ * It equals to the absolute difference between amountPaid
+ * and paymentTotals for the corresponding transactionCurrency used.
+ *
+ * @return int|null
+ */
+ public function getUnderpaidAmount(): ?int
+ {
+ return $this->underpaidAmount;
+ }
+
+ /**
+ * Sets underpaidAmount
+ *
+ * This parameter will be returned on the invoice object
+ * if the invoice was underpaid ("exceptionStatus": "paidPartial").
+ * It equals to the absolute difference between amountPaid
+ * and paymentTotals for the corresponding transactionCurrency used.
+ *
+ * @param int $underpaidAmount the underpaid amount
+ */
+ public function setUnderpaidAmount(int $underpaidAmount): void
{
- $this->_shopper = $shopper;
+ $this->underpaidAmount = $underpaidAmount;
}
- public function getBillId()
+ /**
+ * Gets overpaidAmount
+ *
+ * This parameter will be returned on the invoice object
+ * if the invoice was overpaid ("exceptionStatus": "paidOver").
+ * It equals to the absolute difference between amountPaid
+ * and paymentTotals for the corresponding transactionCurrency used.
+ *
+ * @return int|null
+ */
+ public function getOverpaidAmount(): ?int
{
- return $this->_billId;
+ return $this->overpaidAmount;
}
- public function setBillId($billId)
+ /**
+ * Sets overpaidAmount
+ *
+ * This parameter will be returned on the invoice object
+ * if the invoice was overpaid ("exceptionStatus": "paidOver").
+ * It equals to the absolute difference between amountPaid
+ * and paymentTotals for the corresponding transactionCurrency used.
+ *
+ * @param int $overpaidAmount the overpaid amount
+ */
+ public function setOverpaidAmount(int $overpaidAmount): void
{
- $this->_billId = $billId;
+ $this->overpaidAmount = $overpaidAmount;
}
- public function getRefundInfo()
+ /**
+ * Gets minerFees
+ *
+ * The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+ * The key is the currency and the value is an object containing
+ * the satoshis per byte, the total fee, and the fiat amount.
+ * This is referenced as "Network Cost" on an invoice, see
+ *
+ * this support article
+ * for more information
+ *
+ * @return MinerFees|null
+ */
+ public function getMinerFees(): ?MinerFees
{
- return $this->_refundInfo;
+ return $this->minerFees;
}
- public function setRefundInfo(RefundInfo $refundInfo)
+ /**
+ * Sets minerFees
+ *
+ * The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
+ * The key is the currency and the value is an object containing
+ * the satoshis per byte, the total fee, and the fiat amount.
+ * This is referenced as "Network Cost" on an invoice, see
+ *
+ * this support article
+ * for more information
+ *
+ * @param MinerFees $minerFees The total amount of fees that the purchaser will pay
+ * to cover BitPay's UTXO sweep cost for an invoice
+ */
+ public function setMinerFees(MinerFees $minerFees): void
{
- $this->_refundInfo = $refundInfo;
+ $this->minerFees = $minerFees;
}
+ /**
+ * Gets nonPayProPaymentReceived
+ *
+ * This boolean will be available on an invoice object once an invoice is paid
+ * and indicate if the transaction was made with a wallet using the payment protocol (true) or peer to peer (false).
+ *
+ * @return bool|null
+ */
+ public function getNonPayProPaymentReceived(): ?bool
+ {
+ return $this->nonPayProPaymentReceived;
+ }
/**
- * PaymentCodes will be deprecated TODO on version 4.0
+ * Sets nonPayProPaymentReceived
+ *
+ * This boolean will be available on an invoice object once an invoice is paid
+ * and indicate if the transaction was made with a wallet using the payment protocol (true) or peer to peer (false).
*
- * @deprecated
+ * @param boolean $nonPayProPaymentReceived transaction was made with a wallet using the payment protocol
*/
- public function getPaymentCodes()
+ public function setNonPayProPaymentReceived(bool $nonPayProPaymentReceived): void
{
- return $this->_paymentCodes;
+ $this->nonPayProPaymentReceived = $nonPayProPaymentReceived;
}
+ /**
+ * Gets shopper
+ *
+ * This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+ * @see https://blog.bitpay.com/bitpay-dashboard-id for more information.
+ *
+ * @return Shopper|null the shopper
+ */
+ public function getShopper(): ?Shopper
+ {
+ return $this->shopper;
+ }
/**
- * PaymentCodes will be deprecated TODO on version 4.0
+ * Sets shopper
+ *
+ * This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
+ * @see https://blog.bitpay.com/bitpay-dashboard-id for more information.
*
- * @var array
- * @deprecated
+ * @param Shopper $shopper the shopper
*/
- public function setPaymentCodes(PaymentCodes $paymentCodes = null)
+ public function setShopper(Shopper $shopper)
{
- $this->_paymentCodes = null;
+ $this->shopper = $shopper;
}
- public function getExtendedNotifications()
+ /**
+ * Gets billId
+ *
+ * This field will be in the invoice object only if the invoice was generated from a bill,
+ * @see https://bitpay.com/api/#rest-api-resources-bills resource for more information
+ *
+ * @return string|null
+ */
+ public function getBillId(): ?string
{
- return $this->_extendedNotifications;
+ return $this->billId;
}
- public function setExtendedNotifications(bool $extendedNotifications)
+ /**
+ * Sets billId
+ *
+ * This field will be in the invoice object only if the invoice was generated from a bill,
+ * @see https://bitpay.com/api/#rest-api-resources-bills resource for more information
+ *
+ * @param string $billId the bill id
+ */
+ public function setBillId(string $billId): void
{
- $this->_extendedNotifications = $extendedNotifications;
+ $this->billId = $billId;
}
- public function getTransactionCurrency()
+ /**
+ * Gets refundInfo
+ *
+ * For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+ *
+ * @return RefundInfo|null
+ */
+ public function getRefundInfo(): ?RefundInfo
{
- return $this->_transactionCurrency;
+ return $this->refundInfo;
}
- public function setTransactionCurrency($transactionCurrency)
+ /**
+ * Sets refundInfo
+ *
+ * For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
+ *
+ * @param RefundInfo object which contain the details of executed refunds for the corresponding invoice.
+ */
+ public function setRefundInfo(RefundInfo $refundInfo): void
{
- $this->_transactionCurrency = $transactionCurrency;
+ $this->refundInfo = $refundInfo;
}
- public function getAmountPaid()
+ /**
+ * Gets extendedNotifications
+ *
+ * Allows merchants to get access to additional webhooks.
+ * For instance when an invoice expires without receiving a payment or when it is refunded.
+ * If set to true, then fullNotifications is automatically set to true.
+ * When using the extendedNotifications parameter,
+ * the webhook also have a payload slightly different from the standard webhooks.
+ *
+ * @return bool|null
+ */
+ public function getExtendedNotifications(): ?bool
{
- return $this->_amountPaid;
+ return $this->extendedNotifications;
}
- public function setAmountPaid($amountPaid)
+ /**
+ * Sets extendedNotifications
+ *
+ * Allows merchants to get access to additional webhooks.
+ * For instance when an invoice expires without receiving a payment or when it is refunded.
+ * If set to true, then fullNotifications is automatically set to true.
+ * When using the extendedNotifications parameter,
+ * the webhook also have a payload slightly different from the standard webhooks.
+ *
+ * @param bool $extendedNotifications Allows merchants to get access to additional webhooks
+ */
+ public function setExtendedNotifications(bool $extendedNotifications): void
{
- $this->_amountPaid = $amountPaid;
+ $this->extendedNotifications = $extendedNotifications;
}
- public function getExchangeRates()
+ /**
+ * Gets transactionCurrency
+ *
+ * The cryptocurrency used to pay the invoice.
+ * This field will only be available after a transaction is applied to the invoice.
+ * Possible values are currently "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+ * "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ *
+ * @return string|null
+ */
+ public function getTransactionCurrency(): ?string
{
- return $this->_exchangeRates;
+ return $this->transactionCurrency;
}
- public function setExchangeRates($exchangeRates)
+ /**
+ * Sets transactionCurrency
+ *
+ * The cryptocurrency used to pay the invoice.
+ * This field will only be available after a transaction is applied to the invoice.
+ * Possible values are currently "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD",
+ * "USDC", "XRP", "DOGE", "DAI" and "WBTC".
+ *
+ * @param string $transactionCurrency The currency used for the invoice transaction.
+ */
+ public function setTransactionCurrency(string $transactionCurrency): void
{
- $this->_exchangeRates = $exchangeRates;
+ $this->transactionCurrency = $transactionCurrency;
}
- public function getPaymentTotals()
+ /**
+ * Gets amountPaid
+ *
+ * The total amount paid to the invoice in terms of the invoice transactionCurrency indicated
+ * in the smallest possible unit for the corresponding transactionCurrency (e.g satoshis for BTC and BCH)
+ *
+ * @return int|null
+ */
+ public function getAmountPaid(): ?int
{
- return $this->_paymentTotals;
+ return $this->amountPaid;
}
- public function setPaymentTotals($paymentTotals)
+ /**
+ * Sets amountPaid
+ *
+ * The total amount paid to the invoice in terms of the invoice transactionCurrency indicated
+ * in the smallest possible unit for the corresponding transactionCurrency (e.g satoshis for BTC and BCH)
+ *
+ * @param int $amountPaid The total amount paid to the invoice
+ */
+ public function setAmountPaid(int $amountPaid): void
{
- $this->_paymentTotals = $paymentTotals;
+ $this->amountPaid = $amountPaid;
}
- public function getPaymentSubtotals()
+ /**
+ * Gets displayAmountPaid
+ *
+ * Initially set to "0" when creating the invoice.
+ * It will be updated with the total amount paid to the invoice
+ * indicated in the base unit for the corresponding transactionCurrency
+ *
+ * @return string|null
+ */
+ public function getDisplayAmountPaid(): ?string
{
- return $this->_paymentSubtotals;
+ return $this->displayAmountPaid;
}
- public function setPaymentSubtotals($paymentSubtotals)
+ /**
+ * Sets displayAmountPaid
+ *
+ * Initially set to "0" when creating the invoice.
+ * It will be updated with the total amount paid to the invoice
+ * indicated in the base unit for the corresponding transactionCurrency
+ *
+ * @param string $displayAmountPaid display amount paid
+ */
+ public function setDisplayAmountPaid(string $displayAmountPaid): void
{
- $this->_paymentSubtotals = $paymentSubtotals;
+ $this->displayAmountPaid = $displayAmountPaid;
}
- public function getPaymentDisplaySubTotals()
+ /**
+ * Gets exchangeRates
+ *
+ * Exchange rates keyed by source and target currencies.
+ *
+ * @return array|null
+ */
+ public function getExchangeRates(): ?array
{
- return $this->_paymentDisplaySubTotals;
+ return $this->exchangeRates;
}
- public function setPaymentDisplaySubTotals($paymentDisplaySubTotals)
+ /**
+ * Sets exchangeRates
+ *
+ * Exchange rates keyed by source and target currencies.
+ *
+ * @param array|null $exchangeRates Exchange rates keyed by source and target currencies.
+ */
+ public function setExchangeRates(?array $exchangeRates): void
{
- $this->_paymentDisplaySubTotals = $paymentDisplaySubTotals;
+ $this->exchangeRates = $exchangeRates;
}
- public function getPaymentDisplayTotals()
+ /**
+ * Gets isCancelled
+ *
+ * Indicates whether or not the invoice was cancelled.
+ *
+ * @return bool|null
+ */
+ public function getIsCancelled(): ?bool
{
- return $this->_paymentDisplayTotals;
+ return $this->isCancelled;
}
- public function setPaymentDisplayTotals($paymentDisplayTotals)
+ /**
+ * Sets isCancelled
+ *
+ * Indicates whether or not the invoice was cancelled.
+ *
+ * @param boolean $isCancelled Indicates whether or not the invoice was cancelled.
+ */
+ public function setIsCancelled(bool $isCancelled): void
{
- $this->_paymentDisplayTotals = $paymentDisplayTotals;
+ $this->isCancelled = $isCancelled;
}
- public function toArray()
+ /**
+ * Returns the Invoice object as array
+ *
+ * @return array
+ */
+ public function toArray(): array
{
$elements = [
- 'currency' => $this->getCurrency(),
- 'guid' => $this->getGuid(),
- 'token' => $this->getToken(),
- 'price' => $this->getPrice(),
- 'posData' => $this->getPosData(),
- 'notificationURL' => $this->getNotificationURL(),
- 'transactionSpeed' => $this->getTransactionSpeed(),
- 'fullNotifications' => $this->getFullNotifications(),
- 'notificationEmail' => $this->getNotificationEmail(),
- 'redirectURL' => $this->getRedirectURL(),
- 'orderId' => $this->getOrderId(),
- 'itemDesc' => $this->getItemDesc(),
- 'itemCode' => $this->getItemCode(),
- 'physical' => $this->getPhysical(),
- 'paymentCurrencies' => $this->getPaymentCurrencies(),
- 'acceptanceWindow' => $this->getAcceptanceWindow(),
- 'buyer' => $this->getBuyer()->toArray(),
- 'refundAddresses' => $this->getRefundAddresses(),
- 'id' => $this->getId(),
- 'url' => $this->getUrl(),
- 'status' => $this->getStatus(),
- 'lowFeeDetected' => $this->getLowFeeDetected(),
- 'invoiceTime' => $this->getInvoiceTime(),
- 'expirationTime' => $this->getExpirationTime(),
- 'currentTime' => $this->getCurrentTime(),
- 'transactions' => $this->getTransactions(),
- 'exceptionStatus' => $this->getExceptionStatus(),
- 'targetConfirmations' => $this->getTargetConfirmations(),
- 'refundAddressRequestPending' => $this->getRefundAddressRequestPending(),
- 'buyerProvidedEmail' => $this->getBuyerProvidedEmail(),
- 'buyerProvidedInfo' => $this->getBuyerProvidedInfo()->toArray(),
- 'supportedTransactionCurrencies' => $this->getSupportedTransactionCurrencies()->toArray(),
- 'minerFees' => $this->getMinerFees()->toArray(),
- 'shopper' => $this->getShopper()->toArray(),
- 'billId' => $this->getBillId(),
- 'refundInfo' => $this->getRefundInfo()->toArray(),
- 'paymentCodes' => [],
- 'extendedNotifications' => $this->getExtendedNotifications(),
- 'transactionCurrency' => $this->getTransactionCurrency(),
- 'amountPaid' => $this->getAmountPaid(),
- 'exchangeRates' => $this->getExchangeRates(),
- 'paymentTotals' => $this->getPaymentTotals()->toArray(),
- 'paymentSubtotals' => $this->getPaymentSubtotals()->toArray(),
- 'paymentDisplayTotals' => $this->getPaymentDisplaySubTotals()->toArray(),
- 'paymentDisplaySubTotals' => $this->getPaymentDisplaySubTotals()->toArray(),
+ 'currency' => $this->getCurrency(),
+ 'guid' => $this->getGuid(),
+ 'token' => $this->getToken(),
+ 'price' => $this->getPrice(),
+ 'posData' => $this->getPosData(),
+ 'notificationURL' => $this->getNotificationURL(),
+ 'transactionSpeed' => $this->getTransactionSpeed(),
+ 'fullNotifications' => $this->getFullNotifications(),
+ 'notificationEmail' => $this->getNotificationEmail(),
+ 'redirectURL' => $this->getRedirectURL(),
+ 'orderId' => $this->getOrderId(),
+ 'itemDesc' => $this->getItemDesc(),
+ 'itemCode' => $this->getItemCode(),
+ 'physical' => $this->getPhysical(),
+ 'paymentCurrencies' => $this->getPaymentCurrencies(),
+ 'acceptanceWindow' => $this->getAcceptanceWindow(),
+ 'closeURL' => $this->getCloseURL(),
+ 'autoRedirect' => $this->getAutoRedirect(),
+ 'buyer' => $this->getBuyer() ? $this->getBuyer()->toArray() : null,
+ 'refundAddresses' => $this->getRefundAddresses(),
+ 'id' => $this->getId(),
+ 'url' => $this->getUrl(),
+ 'status' => $this->getStatus(),
+ 'lowFeeDetected' => $this->getLowFeeDetected(),
+ 'invoiceTime' => $this->getInvoiceTime(),
+ 'expirationTime' => $this->getExpirationTime(),
+ 'currentTime' => $this->getCurrentTime(),
+ 'transactions' => $this->getTransactions(),
+ 'exceptionStatus' => $this->getExceptionStatus(),
+ 'targetConfirmations' => $this->getTargetConfirmations(),
+ 'refundAddressRequestPending' => $this->getRefundAddressRequestPending(),
+ 'buyerProvidedEmail' => $this->getBuyerProvidedEmail(),
+ 'buyerProvidedInfo' => $this->getBuyerProvidedInfo() ? $this->getBuyerProvidedInfo()->toArray() : null,
+ 'universalCodes' => $this->getUniversalCodes() ? $this->getUniversalCodes()->toArray() : null,
+ 'supportedTransactionCurrencies' => $this->getSupportedTransactionCurrencies()
+ ? $this->getSupportedTransactionCurrencies()->toArray() : null,
+ 'minerFees' => $this->getMinerFees() ? $this->getMinerFees()->toArray() : null,
+ 'shopper' => $this->getShopper() ? $this->getShopper()->toArray() : null,
+ 'billId' => $this->getBillId(),
+ 'refundInfo' => $this->getRefundInfo() ? $this->getRefundInfo()->toArray() : null,
+ 'extendedNotifications' => $this->getExtendedNotifications(),
+ 'transactionCurrency' => $this->getTransactionCurrency(),
+ 'amountPaid' => $this->getAmountPaid(),
+ 'exchangeRates' => $this->getExchangeRates(),
+ 'merchantName' => $this->getMerchantName(),
+ 'selectedTransactionCurrency' => $this->getSelectedTransactionCurrency(),
+ 'bitpayIdRequired' => $this->getBitpayIdRequired(),
+ 'forcedBuyerSelectedWallet' => $this->getForcedBuyerSelectedWallet(),
+ 'isCancelled' => $this->getIsCancelled(),
+ 'buyerEmail' => $this->getBuyerEmail(),
+ 'buyerSms' => $this->getBuyerSms(),
+ 'itemizedDetails' => $this->getItemizedDetails(),
+ 'forcedBuyerSelectedTransactionCurrency' => $this->getForcedBuyerSelectedTransactionCurrency()
];
foreach ($elements as $key => $value) {
diff --git a/src/BitPaySDK/Model/Invoice/InvoiceStatus.php b/src/BitPaySDK/Model/Invoice/InvoiceStatus.php
index 48ac2688..1c6ad734 100644
--- a/src/BitPaySDK/Model/Invoice/InvoiceStatus.php
+++ b/src/BitPaySDK/Model/Invoice/InvoiceStatus.php
@@ -1,15 +1,66 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
interface InvoiceStatus
{
- const New = "new";
- const Paid = "paid";
- const Confirmed = "confirmed";
- const Complete = "complete";
- const Expired = "expired";
- const Invalid = "invalid";
-}
\ No newline at end of file
+ /**
+ * An invoice starts in this state. When in this state and only in this state, payments broadcasted by purchasers
+ * be applied to the invoice (there is a 15 minute window for the purchaser to send a payment from
+ * their crypto wallet). If an invoice has received a partial payment,
+ * it will still reflect a status of new to the merchant. From a merchant system perspective,
+ * an invoice is either paid or not paid, partial payments are automatically refunded by BitPay to the consumer.
+ */
+ public const NEW = "new";
+
+ /**
+ * As soon as payment is received it is evaluated against the invoice requested amount.
+ * If the amount paid is equal to or greater than the amount expected then the invoice is marked as being paid.
+ * To detect whether the invoice has been overpaid consult the invoice exception status (exceptionStatus parameter).
+ * The overpaid amount on an invoice is automatically refunded by BitPay to the consumer.
+ */
+ public const PAID = "paid";
+
+ /**
+ * This status can be used by merchants in order to fulfill orders placed by the consumer.
+ * Merchants can configure the timing at which BitPay sets this specific invoice status,
+ * depending on the number of confirmation achieved by the consumer's transaction in the selected cryptocurrency.
+ * This can be configured during invoice creation using the "transactionSpeed" parameter
+ * (section Create an invoice), or at account level via a dashboard setting.
+ */
+ public const CONFIRMED = "confirmed";
+
+ /**
+ * When an invoice has the status complete, it means that BitPay has credited the merchant account,
+ * in the currency indicated in the settlement settings. For instance, with invoices paid in Bitcoin (BTC),
+ * 6 confirmation blocks on the bitcoin network are required for an invoice to be complete,
+ * this takes on average 1 hour.
+ */
+ public const COMPLETE = "complete";
+
+ /**
+ * An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.
+ */
+ public const EXPIRED = "expired";
+
+ /**
+ * An invoice is considered invalid when it was paid,
+ * but the corresponding cryptocurrency transaction was not confirmed within 1 hour on the corresponding blockchain.
+ * It is possible that some transactions can take longer than 1 hour to be included in a block.
+ * If the transaction confirms after 1 hour, BitPay will update the invoice state from "invalid" to "complete"
+ * (6 confirmations for transactions on the bitcoin network for instance).
+ */
+ public const INVALID = "invalid";
+}
diff --git a/src/BitPaySDK/Model/Invoice/ItemizedDetails.php b/src/BitPaySDK/Model/Invoice/ItemizedDetails.php
new file mode 100644
index 00000000..31ff4b67
--- /dev/null
+++ b/src/BitPaySDK/Model/Invoice/ItemizedDetails.php
@@ -0,0 +1,116 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
+class ItemizedDetails
+{
+ protected ?float $amount = null;
+ protected ?string $description = null;
+ protected ?bool $isFee = null;
+
+ public function __construct()
+ {
+ }
+
+ /**
+ * Gets The amount of currency.
+ *
+ * @return float|null the amount
+ */
+ public function getAmount(): ?float
+ {
+ return $this->amount;
+ }
+
+ /**
+ * Sets The amount of currency.
+ *
+ * @param float|null $amount the amount
+ */
+ public function setAmount(?float $amount): void
+ {
+ $this->amount = $amount;
+ }
+
+ /**
+ * Gets description
+ *
+ * Display string for the item.
+ *
+ * @return string|null the description
+ */
+ public function getDescription(): ?string
+ {
+ return $this->description;
+ }
+
+ /**
+ * Sets string for the item.
+ *
+ * @param string|null $description the description
+ */
+ public function setDescription(?string $description): void
+ {
+ $this->description = $description;
+ }
+
+ /**
+ * Gets is fee
+ *
+ * Indicates whether or not the item is considered a fee/tax or part of the main purchase.
+ *
+ * @return bool|null is fee
+ */
+ public function getIsFee(): ?bool
+ {
+ return $this->isFee;
+ }
+
+ /**
+ * Sets is fee
+ *
+ * Gets Indicates whether or not the item is considered a fee/tax or part of the main purchase.
+ *
+ * @param bool|null $isFee is fee
+ */
+ public function setIsFee(?bool $isFee): void
+ {
+ $this->isFee = $isFee;
+ }
+
+ /**
+ * Gets Item details data as array
+ *
+ * @return array item details data as array
+ */
+ public function toArray(): array
+ {
+ $elements = [
+ 'amount' => $this->getAmount(),
+ 'description' => $this->getDescription(),
+ 'isFee' => $this->getIsFee()
+ ];
+
+ foreach ($elements as $key => $value) {
+ if (empty($value)) {
+ unset($elements[$key]);
+ }
+ }
+
+ return $elements;
+ }
+}
diff --git a/src/BitPaySDK/Model/Invoice/MinerFees.php b/src/BitPaySDK/Model/Invoice/MinerFees.php
index b9329379..ff693db8 100644
--- a/src/BitPaySDK/Model/Invoice/MinerFees.php
+++ b/src/BitPaySDK/Model/Invoice/MinerFees.php
@@ -1,97 +1,318 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class MinerFees
{
- protected $_btc;
- protected $_bch;
- protected $_eth;
- protected $_usdc;
- protected $_gusd;
- protected $_pax;
+ protected MinerFeesItem $btc;
+ protected MinerFeesItem $bch;
+ protected MinerFeesItem $eth;
+ protected MinerFeesItem $usdc;
+ protected MinerFeesItem $gusd;
+ protected MinerFeesItem $pax;
+ protected MinerFeesItem $busd;
+ protected MinerFeesItem $xrp;
+ protected MinerFeesItem $doge;
+ protected MinerFeesItem $ltc;
+ protected MinerFeesItem $dai;
+ protected MinerFeesItem $wbtc;
+ /**
+ * MinerFees constructor.
+ */
public function __construct()
{
- $this->_btc = new MinerFeesItem();
- $this->_bch = new MinerFeesItem();
- $this->_eth = new MinerFeesItem();
- $this->_usdc = new MinerFeesItem();
- $this->_gusd = new MinerFeesItem();
- $this->_pax = new MinerFeesItem();
+ $this->btc = new MinerFeesItem();
+ $this->bch = new MinerFeesItem();
+ $this->eth = new MinerFeesItem();
+ $this->usdc = new MinerFeesItem();
+ $this->gusd = new MinerFeesItem();
+ $this->pax = new MinerFeesItem();
+ $this->busd = new MinerFeesItem();
+ $this->xrp = new MinerFeesItem();
+ $this->doge = new MinerFeesItem();
+ $this->ltc = new MinerFeesItem();
+ $this->dai = new MinerFeesItem();
+ $this->wbtc = new MinerFeesItem();
+ }
+
+ /**
+ * Gets BTC.
+ *
+ * @return MinerFeesItem
+ */
+ public function getBTC(): MinerFeesItem
+ {
+ return $this->btc;
+ }
+
+ /**
+ * Sets BTC.
+ *
+ * @param MinerFeesItem $btc the BTC
+ */
+ public function setBTC(MinerFeesItem $btc): void
+ {
+ $this->btc = $btc;
+ }
+
+ /**
+ * Gets BCH.
+ *
+ * @return MinerFeesItem
+ */
+ public function getBCH(): MinerFeesItem
+ {
+ return $this->bch;
+ }
+
+ /**
+ * Sets BCH.
+ *
+ * @param MinerFeesItem $bch the BCH
+ */
+ public function setBCH(MinerFeesItem $bch): void
+ {
+ $this->bch = $bch;
+ }
+
+ /**
+ * Gets ETH.
+ *
+ * @return MinerFeesItem
+ */
+ public function getETH(): MinerFeesItem
+ {
+ return $this->eth;
+ }
+
+ /**
+ * Sets ETH.
+ *
+ * @param MinerFeesItem $eth the ETH
+ */
+ public function setETH(MinerFeesItem $eth): void
+ {
+ $this->eth = $eth;
+ }
+
+ /**
+ * Gets USDC.
+ *
+ * @return MinerFeesItem
+ */
+ public function getUSDC(): MinerFeesItem
+ {
+ return $this->usdc;
+ }
+
+ /**
+ * Sets USDC.
+ *
+ * @param MinerFeesItem $usdc the USDC
+ */
+ public function setUSDC(MinerFeesItem $usdc): void
+ {
+ $this->usdc = $usdc;
+ }
+
+ /**
+ * Gets GUSD.
+ *
+ * @return MinerFeesItem
+ */
+ public function getGUSD(): MinerFeesItem
+ {
+ return $this->gusd;
+ }
+
+ /**
+ * Sets GUSD.
+ *
+ * @param MinerFeesItem $gusd the GUSD
+ */
+ public function setGUSD(MinerFeesItem $gusd): void
+ {
+ $this->gusd = $gusd;
+ }
+
+ /**
+ * Gets PAX.
+ *
+ * @return MinerFeesItem
+ */
+ public function getPAX(): MinerFeesItem
+ {
+ return $this->pax;
+ }
+
+ /**
+ * Sets PAX.
+ *
+ * @param MinerFeesItem $pax the PAX
+ */
+ public function setPAX(MinerFeesItem $pax): void
+ {
+ $this->pax = $pax;
}
- public function getBTH()
+ /**
+ * Gets BUSD.
+ *
+ * @return MinerFeesItem
+ */
+ public function getBUSD(): MinerFeesItem
{
- return $this->_btc;
+ return $this->busd;
}
- public function setBTH(MinerFeesItem $btc)
+ /**
+ * Sets BUSD.
+ *
+ * @param MinerFeesItem $busd the BUSD
+ */
+ public function setBUSD(MinerFeesItem $busd): void
{
- $this->_btc = $btc;
+ $this->busd = $busd;
}
- public function getBCH()
+ /**
+ * Gets XRP.
+ *
+ * @return MinerFeesItem
+ */
+ public function getXRP(): MinerFeesItem
{
- return $this->_bch;
+ return $this->xrp;
}
- public function setBCH(MinerFeesItem $bch)
+ /**
+ * Sets XRP.
+ *
+ * @param MinerFeesItem $xrp the XRP
+ */
+ public function setXRP(MinerFeesItem $xrp): void
{
- $this->_bch = $bch;
+ $this->xrp = $xrp;
}
- public function getETH()
+ /**
+ * Gets DOGE.
+ *
+ * @return MinerFeesItem
+ */
+ public function getDOGE(): MinerFeesItem
{
- return $this->_bch;
+ return $this->doge;
}
- public function setETH(MinerFeesItem $eth)
+ /**
+ * Sets DOGE.
+ *
+ * @param MinerFeesItem $doge the DOGE
+ */
+ public function setDOGE(MinerFeesItem $doge): void
{
- $this->_eth = $eth;
+ $this->doge = $doge;
}
- public function getUSDC()
+ /**
+ * Gets LTC.
+ *
+ * @return MinerFeesItem
+ */
+ public function getLTC(): MinerFeesItem
{
- return $this->_usdc;
+ return $this->ltc;
}
- public function setUSDC(MinerFeesItem $usdc)
+ /**
+ * Sets LTC.
+ *
+ * @param MinerFeesItem $ltc the LTC
+ */
+ public function setLTC(MinerFeesItem $ltc): void
{
- $this->_usdc = $usdc;
+ $this->ltc = $ltc;
}
- public function getGUSD()
+ /**
+ * Gets DAI.
+ *
+ * @return MinerFeesItem
+ */
+ public function getDAI(): MinerFeesItem
{
- return $this->_gusd;
+ return $this->dai;
}
- public function setGUSD(MinerFeesItem $gusd)
+ /**
+ * Sets DAI.
+ *
+ * @param MinerFeesItem $dai
+ */
+ public function setDAI(MinerFeesItem $dai): void
{
- $this->_gusd = $gusd;
+ $this->dai = $dai;
}
- public function getPAX()
+ /**
+ * Gets WBTC.
+ *
+ * @return MinerFeesItem
+ */
+ public function getWBTC(): MinerFeesItem
{
- return $this->_pax;
+ return $this->wbtc;
}
- public function setPAX(MinerFeesItem $pax)
+ /**
+ * Sets WBTC.
+ *
+ * @param MinerFeesItem $wbtc
+ */
+ public function setWBTC(MinerFeesItem $wbtc): void
{
- $this->_pax = $pax;
+ $this->wbtc = $wbtc;
}
- public function toArray()
+ /**
+ * Return array with details for currencies.
+ *
+ * @return array
+ */
+ public function toArray(): array
{
$elements = [
- 'btc' => $this->getBTH()->toArray(),
+ 'btc' => $this->getBTC()->toArray(),
'bch' => $this->getBCH()->toArray(),
'eth' => $this->getETH()->toArray(),
'usdc' => $this->getUSDC()->toArray(),
'gusd' => $this->getGUSD()->toArray(),
'pax' => $this->getPAX()->toArray(),
+ 'busd' => $this->getBUSD()->toArray(),
+ 'xrp' => $this->getXRP()->toArray(),
+ 'doge' => $this->getDOGE()->toArray(),
+ 'ltc' => $this->getLTC()->toArray(),
+ 'dai' => $this->getDAI()->toArray(),
+ 'wbtc' => $this->getWBTC()->toArray(),
];
foreach ($elements as $key => $value) {
@@ -102,4 +323,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/MinerFeesItem.php b/src/BitPaySDK/Model/Invoice/MinerFeesItem.php
index 316e9b09..2c187d31 100644
--- a/src/BitPaySDK/Model/Invoice/MinerFeesItem.php
+++ b/src/BitPaySDK/Model/Invoice/MinerFeesItem.php
@@ -1,43 +1,67 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class MinerFeesItem
{
- protected $_satoshisPerByte;
- protected $_totalFee;
+ protected ?float $satoshisPerByte = null;
+ protected ?float $totalFee = null;
+ protected ?float $fiatAmount = null;
public function __construct()
{
}
- public function getSatoshisPerByte()
+ public function getSatoshisPerByte(): ?float
+ {
+ return $this->satoshisPerByte;
+ }
+
+ public function setSatoshisPerByte(float $satoshisPerByte): void
+ {
+ $this->satoshisPerByte = $satoshisPerByte;
+ }
+
+ public function getTotalFee(): ?float
{
- return $this->_satoshisPerByte;
+ return $this->totalFee;
}
- public function setSatoshisPerByte(float $satoshisPerByte)
+ public function setTotalFee(float $totalFee): void
{
- $this->_satoshisPerByte = $satoshisPerByte;
+ $this->totalFee = $totalFee;
}
- public function getTotalFee()
+ public function getFiatAmount(): ?float
{
- return $this->_totalFee;
+ return $this->fiatAmount;
}
- public function setTotalFee(float $totalFee)
+ public function setFiatAmount(?float $fiatAmount): void
{
- $this->_totalFee = $totalFee;
+ $this->fiatAmount = $fiatAmount;
}
- public function toArray()
+ public function toArray(): array
{
$elements = [
'satoshisPerByte' => $this->getSatoshisPerByte(),
'totalFee' => $this->getTotalFee(),
+ 'fiatAmount' => $this->getFiatAmount()
];
foreach ($elements as $key => $value) {
@@ -48,4 +72,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/PaymentCode.php b/src/BitPaySDK/Model/Invoice/PaymentCode.php
deleted file mode 100644
index 393766bc..00000000
--- a/src/BitPaySDK/Model/Invoice/PaymentCode.php
+++ /dev/null
@@ -1,80 +0,0 @@
- $this->getBip72b(),
- 'bip73' => $this->getBip73(),
- 'eip681' => $this->getEip681(),
- 'eip681b' => $this->getEip681b(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-
- public function getBip72b()
- {
- return $this->_bip72b;
- }
-
- public function setBip72b(string $bip72b)
- {
- $this->_bip72b = $bip72b;
- }
-
- public function getBip73()
- {
- return $this->_bip73;
- }
-
- public function setBip73(string $bip73)
- {
- $this->_bip73 = $bip73;
- }
-
- public function getEip681()
- {
- return $this->_eip681;
- }
-
- public function setEip681(string $eip681)
- {
- $this->_eip681 = $eip681;
- }
-
- public function getEip681b()
- {
- return $this->_eip681b;
- }
-
- public function setEip681b(string $eip681b)
- {
- $this->_eip681b = $eip681b;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Invoice/PaymentCodes.php b/src/BitPaySDK/Model/Invoice/PaymentCodes.php
deleted file mode 100644
index d53e99f9..00000000
--- a/src/BitPaySDK/Model/Invoice/PaymentCodes.php
+++ /dev/null
@@ -1,110 +0,0 @@
-_btc = new PaymentCode();
- $this->_bch = new PaymentCode();
- $this->_eth = new PaymentCode();
- $this->_usdc = new PaymentCode();
- $this->_gusd = new PaymentCode();
- $this->_pax = new PaymentCode();
- }
-
- public function getBTC()
- {
- return $this->_btc;
- }
-
- public function setBTC(PaymentCode $btc)
- {
- $this->_btc = $btc;
- }
-
- public function getBCH()
- {
- return $this->_bch;
- }
-
- public function setBCH(PaymentCode $bch)
- {
- $this->_bch = $bch;
- }
-
- public function getETH()
- {
- return $this->_eth;
- }
-
- public function setETH(PaymentCode $eth)
- {
- $this->_eth = $eth;
- }
-
- public function getUSDC()
- {
- return $this->_usdc;
- }
-
- public function setUSDC(PaymentCode $usdc)
- {
- $this->_usdc = $usdc;
- }
-
- public function getGUSD()
- {
- return $this->_gusd;
- }
-
- public function setGUSD(PaymentCode $gusd)
- {
- $this->_gusd = $gusd;
- }
-
- public function getPAX()
- {
- return $this->_pax;
- }
-
- public function setPAX(PaymentCode $pax)
- {
- $this->_pax = $pax;
- }
-
- public function toArray()
- {
- $elements = [
- 'BTC' => $this->getBTC()->toArray(),
- 'BCH' => $this->getBCH()->toArray(),
- 'ETH' => $this->getETH()->toArray(),
- 'USDC' => $this->getUSDC()->toArray(),
- 'GUSD' => $this->getGUSD()->toArray(),
- 'PAX' => $this->getPAX()->toArray(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Invoice/PaymentTotal.php b/src/BitPaySDK/Model/Invoice/PaymentTotal.php
deleted file mode 100644
index db800b96..00000000
--- a/src/BitPaySDK/Model/Invoice/PaymentTotal.php
+++ /dev/null
@@ -1,99 +0,0 @@
-_btc;
- }
-
- public function setBTC(float $btc)
- {
- $this->_btc = $btc;
- }
-
- public function getBCH()
- {
- return $this->_bch;
- }
-
- public function setBCH(float $bch)
- {
- $this->_bch = $bch;
- }
-
- public function getETH()
- {
- return $this->_eth;
- }
-
- public function setETH(float $eth)
- {
- $this->_eth = $eth;
- }
-
- public function getUSDC()
- {
- return $this->_usdc;
- }
-
- public function setUSDC(float $usdc)
- {
- $this->_usdc = $usdc;
- }
-
- public function getGUSD()
- {
- return $this->_gusd;
- }
-
- public function setGUSD(float $gusd)
- {
- $this->_gusd = $gusd;
- }
-
- public function getPAX()
- {
- return $this->_pax;
- }
-
- public function setPAX(float $pax)
- {
- $this->_pax = $pax;
- }
-
- public function toArray()
- {
- $elements = [
- 'BTC' => $this->getBTC(),
- 'BCH' => $this->getBCH(),
- 'ETH' => $this->getETH(),
- 'USDC' => $this->getUSDC(),
- 'GUSD' => $this->getGUSD(),
- 'PAX' => $this->getPAX(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Invoice/Refund.php b/src/BitPaySDK/Model/Invoice/Refund.php
index ab752eb6..575aa05a 100644
--- a/src/BitPaySDK/Model/Invoice/Refund.php
+++ b/src/BitPaySDK/Model/Invoice/Refund.php
@@ -1,144 +1,586 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class Refund
{
- protected $_guid;
- protected $_refundEmail;
- protected $_amount;
- protected $_currency;
- protected $_token;
- protected $_id;
- protected $_requestDate;
- protected $_status;
- protected $_params;
+ protected ?string $guid = null;
+ protected float $amount;
+ protected string $currency;
+ protected string $token;
+ protected ?string $id = null;
+ protected ?string $requestDate = null;
+ protected ?string $status = null;
+ protected ?string $invoiceId = null;
+ protected ?bool $preview = null;
+ protected ?bool $immediate = null;
+ protected ?bool $buyerPaysRefundFee = null;
+ protected ?float $refundFee = null;
+ protected ?string $reference = null;
+ protected ?string $lastRefundNotification = null;
+ protected ?string $invoice = null;
+ protected ?string $notificationURL = null;
+ protected ?string $refundAddress = null;
+ protected ?string $supportRequest = null;
+ protected ?float $transactionAmount = null;
+ protected ?string $transactionCurrency = null;
+ protected ?float $transactionRefundFee = null;
+ protected ?string $txid = null;
+ protected ?string $type = null;
+ /**
+ * Constructor, create Refund object
+ *
+ * @param float $amount
+ * @param string $currency
+ * @param string $token
+ */
public function __construct(
- string $refundEmail = "",
float $amount = 0.0,
string $currency = "",
string $token = ""
) {
- $this->_refundEmail = $refundEmail;
- $this->_amount = $amount;
- $this->_currency = $currency;
- $this->_token = $token;
- $this->_params = new RefundParams();
+ $this->amount = $amount;
+ $this->currency = $currency;
+ $this->token = $token;
}
// Request fields
//
- public function getGuid()
+ /**
+ * Gets a passthru variable provided by the merchant and designed to be used by the merchant to correlate
+ * the invoice with an order ID in their system
+ *
+ * @return string|null
+ */
+ public function getGuid(): ?string
+ {
+ return $this->guid;
+ }
+
+ /**
+ * Sets guid
+ *
+ * @param string $guid
+ */
+ public function setGuid(string $guid): void
+ {
+ $this->guid = $guid;
+ }
+
+ /**
+ * Present only if specified in the request to create the refund. This is your reference label for this refund.
+ * It will be passed-through on each response for you to identify the refund in your system.
+ * Maximum string length is 100 characters
+ *
+ * @return string|null
+ */
+ public function getReference(): ?string
+ {
+ return $this->reference;
+ }
+
+ /**
+ * Sets reference label for refund
+ *
+ * @param string $reference: void
+ */
+ public function setReference(string $reference): void
{
- return $this->_guid;
+ $this->reference = $reference;
}
- public function setGuid(string $guid)
+ /**
+ * Gets amount to be refunded in the invoice currency
+ *
+ * @return float
+ */
+ public function getAmount(): float
{
- $this->_guid = $guid;
+ return $this->amount;
}
- public function getRefundEmail()
+ /**
+ * Sets amount to be refunded
+ *
+ * @param float $amount
+ */
+ public function setAmount(float $amount): void
{
- return $this->_refundEmail;
+ $this->amount = $amount;
}
- public function setRefundEmail(string $refundEmail)
+ /**
+ * Gets API token
+ *
+ * @return string
+ */
+ public function getToken(): string
{
- $this->_refundEmail = $refundEmail;
+ return $this->token;
}
- public function getAmount()
+ /**
+ * Sets API token
+ *
+ * @param string $token
+ */
+ public function setToken(string $token): void
{
- return $this->_amount;
+ $this->token = $token;
}
- public function setAmount(float $amount)
+ /**
+ * Gets reference currency used for the refund, the same as the currency used to create the invoice
+ *
+ * @return string
+ */
+ public function getCurrency(): string
{
- $this->_amount = $amount;
+ return $this->currency;
}
- public function getToken()
+ /**
+ * Sets currency used for the refund
+ *
+ * @param string $currency
+ */
+ public function setCurrency(string $currency): void
{
- return $this->_token;
+ $this->currency = $currency;
}
- public function setToken(string $token)
+ /**
+ * Whether to create the refund request as a preview
+ *
+ * @return bool|null
+ */
+ public function getPreview(): ?bool
{
- $this->_token = $token;
+ return $this->preview;
}
- public function getCurrency()
+ /**
+ * Sets preview
+ *
+ * @param bool $preview
+ */
+ public function setPreview(bool $preview): void
{
- return $this->_currency;
+ $this->preview = $preview;
}
- public function setCurrency(string $currency)
+ /**
+ * Gets the ID of the invoice to refund
+ *
+ * @return string|null
+ */
+ public function getInvoiceId(): ?string
{
- $this->_currency = $currency;
+ return $this->invoiceId;
+ }
+
+ /**
+ * Sets invoice id
+ *
+ * @param string $invoiceId
+ */
+ public function setInvoiceId(string $invoiceId): void
+ {
+ $this->invoiceId = $invoiceId;
}
// Response fields
//
- public function getId()
+ /**
+ * Gets the ID of the refund
+ *
+ * @return string|null
+ */
+ public function getId(): ?string
+ {
+ return $this->id;
+ }
+
+ /**
+ * Sets id of the refund
+ *
+ * @param string $id
+ */
+ public function setId(string $id): void
+ {
+ $this->id = $id;
+ }
+
+ /**
+ * Gets the date the refund was requested
+ *
+ * @return string|null
+ */
+ public function getRequestDate(): ?string
+ {
+ return $this->requestDate;
+ }
+
+ /**
+ * Sets request date
+ *
+ * @param string $requestDate
+ */
+ public function setRequestDate(string $requestDate): void
+ {
+ $this->requestDate = $requestDate;
+ }
+
+ /**
+ * Gets the refund lifecycle status of the request
+ *
+ * @return string|null
+ */
+ public function getStatus(): ?string
+ {
+ return $this->status;
+ }
+
+ /**
+ * Sets refund status
+ *
+ * @param string $status
+ */
+ public function setStatus(string $status): void
+ {
+ $this->status = $status;
+ }
+
+ /**
+ * Gets whether the funds should be removed from merchant ledger immediately
+ * on submission or at the time of processing
+ *
+ * @return bool|null
+ */
+ public function getImmediate(): ?bool
+ {
+ return $this->immediate;
+ }
+
+ /**
+ * Sets immediate value
+ *
+ * @param bool $immediate
+ */
+ public function setImmediate(bool $immediate): void
+ {
+ $this->immediate = $immediate;
+ }
+
+ /**
+ * Gets the amount of refund fee expressed in terms of pricing currency
+ *
+ * @return float|null
+ */
+ public function getRefundFee(): ?float
+ {
+ return $this->refundFee;
+ }
+
+ /**
+ * Sets amount of the refund fee
+ *
+ * @param float $refundFee
+ */
+ public function setRefundFee(float $refundFee): void
+ {
+ $this->refundFee = $refundFee;
+ }
+
+ /**
+ * Gets the last time notification of buyer was attempted
+ *
+ * @return string|null
+ */
+ public function getLastRefundNotification(): ?string
{
- return $this->_id;
+ return $this->lastRefundNotification;
}
- public function setId(string $id)
+ /**
+ * Sets last refund notification
+ *
+ * @param string $lastRefundNotification
+ */
+ public function setLastRefundNotification(string $lastRefundNotification): void
{
- $this->_id = $id;
+ $this->lastRefundNotification = $lastRefundNotification;
}
- public function getRequestDate()
+ /**
+ * Gets the ID of the invoice being refunded
+ *
+ * @return string|null
+ */
+ public function getInvoice(): ?string
{
- return $this->_requestDate;
+ return $this->invoice;
}
- public function setRequestDate(string $requestDate)
+ /**
+ * Sets the id of the invoice being refunded
+ *
+ * @param string $invoice
+ */
+ public function setInvoice(string $invoice): void
{
- $this->_requestDate = $requestDate;
+ $this->invoice = $invoice;
}
- public function getStatus()
+ /**
+ * Gets whether the buyer should pay the refund fee rather
+ * than the merchant
+ *
+ * @return bool|null
+ */
+ public function getBuyerPaysRefundFee(): ?bool
{
- return $this->_status;
+ return $this->buyerPaysRefundFee;
}
- public function setStatus(string $status)
+ /**
+ * Sets whether the buyer should pay the refund fee rather
+ *
+ * @param bool $buyerPaysRefundFee
+ */
+ public function setBuyerPaysRefundFee(bool $buyerPaysRefundFee): void
{
- $this->_status = $status;
+ $this->buyerPaysRefundFee = $buyerPaysRefundFee;
}
- public function getParams()
+ /**
+ * Gets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ *
+ * @return string|null
+ */
+ public function getNotificationURL(): ?string
{
- return $this->_params;
+ return $this->notificationURL;
}
- public function setParams(RefundParams $params)
+ /**
+ * Sets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ *
+ * @param string|null $notificationURL
+ */
+ public function setNotificationURL(?string $notificationURL): void
{
- $this->_params = $params;
+ $this->notificationURL = $notificationURL;
}
- public function toArray()
+ /**
+ * Gets the wallet address that the refund will return the funds to, added by the customer.
+ *
+ * @return string|null
+ */
+ public function getRefundAddress(): ?string
{
- $elements = [
- 'guid' => $this->getGuid(),
- 'refundEmail' => $this->getRefundEmail(),
- 'amount' => $this->getAmount(),
- 'currency' => $this->getCurrency(),
- 'token' => $this->getToken(),
- 'id' => $this->getId(),
+ return $this->refundAddress;
+ }
+
+ /**
+ * Sets the wallet address that the refund will return the funds to, added by the customer.
+ *
+ * @param string|null $refundAddress
+ */
+ public function setRefundAddress(?string $refundAddress): void
+ {
+ $this->refundAddress = $refundAddress;
+ }
+
+ /**
+ * Gets the ID of the associated support request for the refund.
+ *
+ * @return string|null
+ */
+ public function getSupportRequest(): ?string
+ {
+ return $this->supportRequest;
+ }
+
+ /**
+ * Sets the ID of the associated support request for the refund.
+ *
+ * @param string|null $supportRequest
+ */
+ public function setSupportRequest(?string $supportRequest): void
+ {
+ $this->supportRequest = $supportRequest;
+ }
+
+ /**
+ * Gets amount to be refunded in terms of the transaction currency.
+ *
+ * @return float|null
+ */
+ public function getTransactionAmount(): ?float
+ {
+ return $this->transactionAmount;
+ }
+
+ /**
+ * Sets amount to be refunded in terms of the transaction currency.
+ *
+ * @param float|null $transactionAmount
+ */
+ public function setTransactionAmount(?float $transactionAmount): void
+ {
+ $this->transactionAmount = $transactionAmount;
+ }
+
+ /**
+ * Gets the currency used for the invoice transaction.
+ *
+ * @return string|null
+ */
+ public function getTransactionCurrency(): ?string
+ {
+ return $this->transactionCurrency;
+ }
+
+ /**
+ * Sets the currency used for the invoice transaction.
+ *
+ * @param string|null $transactionCurrency
+ */
+ public function setTransactionCurrency(?string $transactionCurrency): void
+ {
+ $this->transactionCurrency = $transactionCurrency;
+ }
+
+ /**
+ * Gets the refund fee expressed in terms of transaction currency.
+ *
+ * @return float|null
+ */
+ public function getTransactionRefundFee(): ?float
+ {
+ return $this->transactionRefundFee;
+ }
+
+ /**
+ * Sets the refund fee expressed in terms of transaction currency.
+ *
+ * @param float|null $transactionRefundFee
+ */
+ public function setTransactionRefundFee(?float $transactionRefundFee): void
+ {
+ $this->transactionRefundFee = $transactionRefundFee;
+ }
+
+ /**
+ * Gets the transaction ID of the refund once executed.
+ *
+ * @return string|null
+ */
+ public function getTxid(): ?string
+ {
+ return $this->txid;
+ }
+
+ /**
+ * Sets the transaction ID of the refund once executed.
+ *
+ * @param string|null $txid
+ */
+ public function setTxid(?string $txid): void
+ {
+ $this->txid = $txid;
+ }
+
+ /**
+ * Gets the type of refund.
+ *
+ * full (current rate): A full refund of the amount paid at the current rate.
+ * full (fixed rate): A full refund of the amount paid at the fixed rate.
+ * Note: deprecated refund implementation only.
+ * partial: Part of the invoice is being refunded, rather than the full invoie amount.
+ * underpayment: The payment was underpaid, a refund in the amount paid will be executed.
+ * overpayment: The payment was overpaid, a refund in the amount that was overpaid from the invoice price
+ * will be executed.
+ * declined: The payment was declined, a refund in the full amount paid will be excuted.
+ *
+ *
+ * @return string|null
+ */
+ public function getType(): ?string
+ {
+ return $this->type;
+ }
+
+ /**
+ * Sets the type of refund.
+ *
+ * full (current rate): A full refund of the amount paid at the current rate.
+ * full (fixed rate): A full refund of the amount paid at the fixed rate.
+ * Note: deprecated refund implementation only.
+ * partial: Part of the invoice is being refunded, rather than the full invoie amount.
+ * underpayment: The payment was underpaid, a refund in the amount paid will be executed.
+ * overpayment: The payment was overpaid, a refund in the amount that was overpaid from the invoice price
+ * will be executed.
+ * declined: The payment was declined, a refund in the full amount paid will be excuted.
+ *
+ *
+ * @param string|null $type
+ */
+ public function setType(?string $type): void
+ {
+ $this->type = $type;
+ }
+
+ /**
+ * Return Refund values as array
+ *
+ * @return array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'guid' => $this->getGuid(),
+ 'amount' => $this->getAmount(),
+ 'currency' => $this->getCurrency(),
+ 'token' => $this->getToken(),
+ 'id' => $this->getId(),
'requestDate' => $this->getRequestDate(),
- 'status' => $this->getStatus(),
- 'params' => $this->getParams()->toArray(),
+ 'status' => $this->getStatus(),
+ 'invoiceId' => $this->getInvoiceId(),
+ 'preview' => $this->getPreview(),
+ 'immediate' => $this->getImmediate(),
+ 'refundFee' => $this->getRefundFee(),
+ 'invoice' => $this->getInvoice(),
+ 'buyerPaysRefundFee' => $this->getBuyerPaysRefundFee(),
+ 'reference' => $this->getReference(),
+ 'lastRefundNotification' => $this->getLastRefundNotification(),
+ 'notificationURL' => $this->getNotificationURL(),
+ 'refundAddress' => $this->getRefundAddress(),
+ 'supportRequest' => $this->getSupportRequest(),
+ 'transactionAmount' => $this->getTransactionAmount(),
+ 'transactionCurrency' => $this->getTransactionCurrency(),
+ 'transactionRefundFee' => $this->getTransactionRefundFee(),
+ 'txid' => $this->getTxid(),
+ 'type' => $this->getType()
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/RefundInfo.php b/src/BitPaySDK/Model/Invoice/RefundInfo.php
index 5d79c0db..bc53f4db 100644
--- a/src/BitPaySDK/Model/Invoice/RefundInfo.php
+++ b/src/BitPaySDK/Model/Invoice/RefundInfo.php
@@ -1,50 +1,117 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class RefundInfo
{
- protected $_supportRequest;
- protected $_currency;
- protected $_amounts;
+ protected ?string $supportRequest = null;
+ protected ?string $currency = null;
+ protected ?array $amounts = null;
public function __construct()
{
}
- public function getSupportRequest()
+ /**
+ * Gets support request
+ *
+ * For a refunded invoice, this field will contain the refund requestId once executed.
+ *
+ * @return string|null the support request
+ */
+ public function getSupportRequest(): ?string
{
- return $this->_supportRequest;
+ return $this->supportRequest;
}
- public function setSupportRequest(string $supportRequest)
+ /**
+ * Sets support request
+ *
+ * For a refunded invoice, this field will contain the refund requestId once executed.
+ *
+ * @param string $supportRequest the support request
+ */
+ public function setSupportRequest(string $supportRequest): void
{
- $this->_supportRequest = $supportRequest;
+ $this->supportRequest = $supportRequest;
}
- public function getCurrency()
+ /**
+ * Gets currency
+ *
+ * For a refunded invoice, this field will contain the base currency selected for the refund.
+ * Typically the same as the invoice currency.
+ *
+ * @return string|null the currency
+ */
+ public function getCurrency(): ?string
{
- return $this->_currency;
+ return $this->currency;
}
- public function setCurrency(string $currency)
+ /**
+ * Sets currency
+ *
+ * For a refunded invoice, this field will contain the base currency selected for the refund.
+ * Typically the same as the invoice currency.
+ *
+ * @param string $currency the currency
+ */
+ public function setCurrency(string $currency): void
{
- $this->_currency = $currency;
+ $this->currency = $currency;
}
- public function getAmounts()
+ /**
+ * Gets amounts
+ *
+ * For a refunded invoice, this object will contain the crypto currency amount
+ * refunded by BitPay to the consumer (in the selected transactionCurrency)
+ * and the equivalent refunded amount from the invoice in the given currency
+ * (thus linked to the amount debited from the merchant account to cover the refund)
+ *
+ * @return array|null the amounts
+ */
+ public function getAmounts(): ?array
{
- return $this->_amounts;
+ return $this->amounts;
}
- public function setAmounts(array $amounts)
+ /**
+ * Set amounts
+ *
+ * For a refunded invoice, this object will contain the crypto currency amount
+ * refunded by BitPay to the consumer (in the selected transactionCurrency)
+ * and the equivalent refunded amount from the invoice in the given currency
+ * (thus linked to the amount debited from the merchant account to cover the refund)
+ *
+ * @param array $amounts the amounts
+ */
+ public function setAmounts(array $amounts): void
{
- $this->_amounts = $amounts;
+ $this->amounts = $amounts;
}
- public function toArray()
+ /**
+ * Gets Refund info as array
+ *
+ * @return array refund info as array
+ */
+ public function toArray(): array
{
$elements = [
'supportRequest' => $this->getSupportRequest(),
@@ -60,4 +127,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/RefundParams.php b/src/BitPaySDK/Model/Invoice/RefundParams.php
deleted file mode 100644
index 516294ba..00000000
--- a/src/BitPaySDK/Model/Invoice/RefundParams.php
+++ /dev/null
@@ -1,116 +0,0 @@
-_requesterType;
- }
-
- public function setRequesterType(string $requesterType)
- {
- $this->_requesterType = $requesterType;
- }
-
- public function getRequesterEmail()
- {
- return $this->_requesterEmail;
- }
-
- public function setRequesterEmail(string $requesterEmail)
- {
- $this->_requesterEmail = $requesterEmail;
- }
-
- public function getAmount()
- {
- return $this->_amount;
- }
-
- public function setAmount(float $amount)
- {
- $this->_amount = $amount;
- }
-
- public function getCurrency()
- {
- return $this->_currency;
- }
-
- public function setCurrency(string $currency)
- {
- $this->_currency = $currency;
- }
-
- public function getEmail()
- {
- return $this->_email;
- }
-
- public function setEmail(string $email)
- {
- $this->_email = $email;
- }
-
- public function getPurchaserNotifyEmail()
- {
- return $this->_purchaserNotifyEmail;
- }
-
- public function setPurchaserNotifyEmail(string $purchaserNotifyEmail)
- {
- $this->_purchaserNotifyEmail = $purchaserNotifyEmail;
- }
-
- public function getRefundAddress()
- {
- return $this->_refundAddress;
- }
-
- public function setRefundAddress(string $refundAddress)
- {
- $this->_refundAddress = $refundAddress;
- }
-
- public function getSupportRequestEid()
- {
- return $this->_supportRequestEid;
- }
-
- public function setSupportRequestEid(string $supportRequestEid)
- {
- $this->_supportRequestEid = $supportRequestEid;
- }
-
- public function toArray()
- {
- $elements = [
- 'requesterType' => $this->getRequesterType(),
- 'requesterEmail' => $this->getRequesterEmail(),
- 'amount' => $this->getAmount(),
- 'currency' => $this->getCurrency(),
- 'email' => $this->getEmail(),
- 'purchaserNotifyEmail' => $this->getPurchaserNotifyEmail(),
- 'refundAddress' => $this->getRefundAddress(),
- ];
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Invoice/RefundStatus.php b/src/BitPaySDK/Model/Invoice/RefundStatus.php
index 55ab5590..1484db05 100644
--- a/src/BitPaySDK/Model/Invoice/RefundStatus.php
+++ b/src/BitPaySDK/Model/Invoice/RefundStatus.php
@@ -1,12 +1,49 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
interface RefundStatus
{
- const Pending = "pending";
- const Success = "success";
- const Failure = "failure";
-}
\ No newline at end of file
+ /**
+ * No funds deducted, refund will not proceed automatically
+ */
+ public const PREVIEW = "preview";
+
+ /**
+ * Funds deducted/allocated if immediate, will proceed when transactions are confirmed
+ * and the required data is collected
+ */
+ public const CREATED = "created";
+
+ /**
+ * Refund was canceled by merchant action. Immediate refunds cannot be canceled outside of preview state
+ */
+ public const CANCELLED = "cancelled";
+
+ /**
+ * Refund is in process of being fulfilled
+ */
+ public const PENDING = "pending";
+
+ /**
+ * Refund was successfully processed
+ */
+ public const SUCCESS = "success";
+
+ /**
+ * Refund failed during processing (this is really more of an internal state)
+ */
+ public const FAILURE = "failure";
+}
diff --git a/src/BitPaySDK/Model/Invoice/RefundWebhook.php b/src/BitPaySDK/Model/Invoice/RefundWebhook.php
new file mode 100644
index 00000000..fb70d29b
--- /dev/null
+++ b/src/BitPaySDK/Model/Invoice/RefundWebhook.php
@@ -0,0 +1,163 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/refunds-1 Webhooks refunds
+ */
+class RefundWebhook
+{
+ protected string $id;
+ protected string $invoice;
+ protected string $supportRequest;
+ protected string $status;
+ protected float $amount;
+ protected string $currency;
+ protected string $lastRefundNotification;
+ protected float $refundFee;
+ protected bool $immediate;
+ protected bool $buyerPaysRefundFee;
+ protected string $requestDate;
+
+ public function __construct()
+ {
+ }
+
+ public function getId(): string
+ {
+ return $this->id;
+ }
+
+ public function setId(string $id): void
+ {
+ $this->id = $id;
+ }
+
+ public function getInvoice(): string
+ {
+ return $this->invoice;
+ }
+
+ public function setInvoice(string $invoice): void
+ {
+ $this->invoice = $invoice;
+ }
+
+ public function getSupportRequest(): string
+ {
+ return $this->supportRequest;
+ }
+
+ public function setSupportRequest(string $supportRequest): void
+ {
+ $this->supportRequest = $supportRequest;
+ }
+
+ public function getStatus(): string
+ {
+ return $this->status;
+ }
+
+ public function setStatus(string $status): void
+ {
+ $this->status = $status;
+ }
+
+ public function getAmount(): float
+ {
+ return $this->amount;
+ }
+
+ public function setAmount(float $amount): void
+ {
+ $this->amount = $amount;
+ }
+
+ public function getCurrency(): string
+ {
+ return $this->currency;
+ }
+
+ public function setCurrency(string $currency): void
+ {
+ $this->currency = $currency;
+ }
+
+ public function getLastRefundNotification(): string
+ {
+ return $this->lastRefundNotification;
+ }
+
+ public function setLastRefundNotification(string $lastRefundNotification): void
+ {
+ $this->lastRefundNotification = $lastRefundNotification;
+ }
+
+ public function getRefundFee(): float
+ {
+ return $this->refundFee;
+ }
+
+ public function setRefundFee(float $refundFee): void
+ {
+ $this->refundFee = $refundFee;
+ }
+
+ public function getImmediate(): bool
+ {
+ return $this->immediate;
+ }
+
+ public function setImmediate(bool $immediate): void
+ {
+ $this->immediate = $immediate;
+ }
+
+ public function getBuyerPaysRefundFee(): bool
+ {
+ return $this->buyerPaysRefundFee;
+ }
+
+ public function setBuyerPaysRefundFee(bool $buyerPaysRefundFee): void
+ {
+ $this->buyerPaysRefundFee = $buyerPaysRefundFee;
+ }
+
+ public function getRequestDate(): string
+ {
+ return $this->requestDate;
+ }
+
+ public function setRequestDate(string $requestDate): void
+ {
+ $this->requestDate = $requestDate;
+ }
+
+ public function toArray(): array
+ {
+ return [
+ 'id' => $this->getId(),
+ 'invoice' => $this->getInvoice(),
+ 'supportRequest' => $this->getSupportRequest(),
+ 'status' => $this->getStatus(),
+ 'amount' => $this->getAmount(),
+ 'currency' => $this->getCurrency(),
+ 'lastRefundNotification' => $this->getLastRefundNotification(),
+ 'refundFee' => $this->getRefundFee(),
+ 'immediate' => $this->getImmediate(),
+ 'buyerPaysRefundFee' => $this->getBuyerPaysRefundFee(),
+ 'requestDate' => $this->getRequestDate()
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Invoice/Shopper.php b/src/BitPaySDK/Model/Invoice/Shopper.php
index 1cca920c..874f027a 100644
--- a/src/BitPaySDK/Model/Invoice/Shopper.php
+++ b/src/BitPaySDK/Model/Invoice/Shopper.php
@@ -1,28 +1,62 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class Shopper
{
- protected $_user;
+ protected ?string $user = null;
public function __construct()
{
}
- public function getUser()
+ /**
+ * Gets user
+ *
+ * If a shopper signs in on the invoice using his BitPay ID,
+ * this field will contain the unique ID assigned by BitPay to this shopper.
+ *
+ * @return string|null the user
+ */
+ public function getUser(): ?string
{
- return $this->_user;
+ return $this->user;
}
- public function setUser(string $user)
+ /**
+ * Sets user
+ *
+ * If a shopper signs in on the invoice using his BitPay ID,
+ * this field will contain the unique ID assigned by BitPay to this shopper.
+ *
+ * @param string $user the user
+ */
+ public function setUser(string $user): void
{
- $this->_user = $user;
+ $this->user = $user;
}
- public function toArray()
+ /**
+ * Gets Shopper as array
+ *
+ * @return array shopper as array
+ */
+ public function toArray(): array
{
$elements = [
'user' => $this->getUser(),
@@ -36,4 +70,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrencies.php b/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrencies.php
index 4e5da13b..2131d57e 100644
--- a/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrencies.php
+++ b/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrencies.php
@@ -1,89 +1,279 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class SupportedTransactionCurrencies
{
- protected $_btc;
- protected $_bch;
- protected $_eth;
- protected $_usdc;
- protected $_gusd;
- protected $_pax;
+ protected SupportedTransactionCurrency $btc;
+ protected SupportedTransactionCurrency $bch;
+ protected SupportedTransactionCurrency $eth;
+ protected SupportedTransactionCurrency $usdc;
+ protected SupportedTransactionCurrency $gusd;
+ protected SupportedTransactionCurrency $pax;
+ protected SupportedTransactionCurrency $xrp;
+ protected SupportedTransactionCurrency $busd;
+ protected SupportedTransactionCurrency $doge;
+ protected SupportedTransactionCurrency $ltc;
+ protected SupportedTransactionCurrency $wbtc;
+ /**
+ * SupportedTransactionCurrencies constructor.
+ */
public function __construct()
{
- $this->_btc = new SupportedTransactionCurrency();
- $this->_bch = new SupportedTransactionCurrency();
- $this->_eth = new SupportedTransactionCurrency();
- $this->_usdc = new SupportedTransactionCurrency();
- $this->_gusd = new SupportedTransactionCurrency();
- $this->_pax = new SupportedTransactionCurrency();
+ $this->btc = new SupportedTransactionCurrency();
+ $this->bch = new SupportedTransactionCurrency();
+ $this->eth = new SupportedTransactionCurrency();
+ $this->usdc = new SupportedTransactionCurrency();
+ $this->gusd = new SupportedTransactionCurrency();
+ $this->pax = new SupportedTransactionCurrency();
+ $this->xrp = new SupportedTransactionCurrency();
+ $this->busd = new SupportedTransactionCurrency();
+ $this->doge = new SupportedTransactionCurrency();
+ $this->ltc = new SupportedTransactionCurrency();
+ $this->wbtc = new SupportedTransactionCurrency();
+ }
+
+ /**
+ * Gets BTC.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getBTC(): SupportedTransactionCurrency
+ {
+ return $this->btc;
+ }
+
+ /**
+ * Sets BTC.
+ *
+ * @param SupportedTransactionCurrency $btc the BTC
+ */
+ public function setBTC(SupportedTransactionCurrency $btc): void
+ {
+ $this->btc = $btc;
+ }
+
+ /**
+ * Gets BCH.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getBCH(): SupportedTransactionCurrency
+ {
+ return $this->bch;
+ }
+
+ /**
+ * Sets BCH.
+ *
+ * @param SupportedTransactionCurrency $bch the BCH
+ */
+ public function setBCH(SupportedTransactionCurrency $bch): void
+ {
+ $this->bch = $bch;
+ }
+
+ /**
+ * Gets ETH.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getETH(): SupportedTransactionCurrency
+ {
+ return $this->eth;
+ }
+
+ /**
+ * Sets ETH.
+ *
+ * @param SupportedTransactionCurrency $eth the ETH
+ */
+ public function setETH(SupportedTransactionCurrency $eth): void
+ {
+ $this->eth = $eth;
+ }
+
+ /**
+ * Gets USDC.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getUSDC(): SupportedTransactionCurrency
+ {
+ return $this->usdc;
+ }
+
+ /**
+ * Sets USDC.
+ *
+ * @param SupportedTransactionCurrency $usdc the USDC
+ */
+ public function setUSDC(SupportedTransactionCurrency $usdc): void
+ {
+ $this->usdc = $usdc;
+ }
+
+ /**
+ * Gets GUSD.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getGUSD(): SupportedTransactionCurrency
+ {
+ return $this->gusd;
+ }
+
+ /**
+ * Sets GUSD.
+ *
+ * @param SupportedTransactionCurrency $gusd the GUSD
+ */
+ public function setGUSD(SupportedTransactionCurrency $gusd): void
+ {
+ $this->gusd = $gusd;
}
- public function getBTC()
+ /**
+ * Gets PAX.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getPAX(): SupportedTransactionCurrency
{
- return $this->_btc;
+ return $this->pax;
}
- public function setBTC(SupportedTransactionCurrency $btc)
+ /**
+ * Sets PAX.
+ *
+ * @param SupportedTransactionCurrency $pax the PAX
+ */
+ public function setPAX(SupportedTransactionCurrency $pax): void
{
- $this->_btc = $btc;
+ $this->pax = $pax;
}
- public function getBCH()
+ /**
+ * Gets XRP.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getXRP(): SupportedTransactionCurrency
{
- return $this->_bch;
+ return $this->xrp;
}
- public function setBCH(SupportedTransactionCurrency $bch)
+ /**
+ * Sets XRP.
+ *
+ * @param SupportedTransactionCurrency $xrp the XRP
+ */
+ public function setXRP(SupportedTransactionCurrency $xrp): void
{
- $this->_bch = $bch;
+ $this->xrp = $xrp;
}
- public function getETH()
+ /**
+ * Gets BUSD.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getBUSD(): SupportedTransactionCurrency
{
- return $this->_eth;
+ return $this->busd;
}
- public function setETH(SupportedTransactionCurrency $eth)
+ /**
+ * Sets BUSD.
+ *
+ * @param SupportedTransactionCurrency $busd
+ */
+ public function setBUSD(SupportedTransactionCurrency $busd): void
{
- $this->_eth = $eth;
+ $this->busd = $busd;
}
- public function getUSDC()
+ /**
+ * Gets DOGE.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getDOGE(): SupportedTransactionCurrency
{
- return $this->_usdc;
+ return $this->doge;
}
- public function setUSDC(SupportedTransactionCurrency $usdc)
+ /**
+ * Sets DOGE.
+ *
+ * @param SupportedTransactionCurrency $doge
+ */
+ public function setDOGE(SupportedTransactionCurrency $doge): void
{
- $this->_usdc = $usdc;
+ $this->doge = $doge;
}
- public function getGUSD()
+ /**
+ * Gets LTC.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getLTC(): SupportedTransactionCurrency
{
- return $this->_gusd;
+ return $this->ltc;
}
- public function setGUSD(SupportedTransactionCurrency $gusd)
+ /**
+ * Sets LTC.
+ *
+ * @param SupportedTransactionCurrency $ltc
+ */
+ public function setLTC(SupportedTransactionCurrency $ltc): void
{
- $this->_gusd = $gusd;
+ $this->ltc = $ltc;
}
- public function getPAX()
+ /**
+ * Gets WBTC.
+ *
+ * @return SupportedTransactionCurrency
+ */
+ public function getWBTC(): SupportedTransactionCurrency
{
- return $this->_pax;
+ return $this->wbtc;
}
- public function setPAX(SupportedTransactionCurrency $pax)
+ /**
+ * Sets WBTC.
+ *
+ * @param SupportedTransactionCurrency $wbtc
+ */
+ public function setWBTC(SupportedTransactionCurrency $wbtc): void
{
- $this->_pax = $pax;
+ $this->wbtc = $wbtc;
}
- public function toArray()
+ /**
+ * Return array with details for currencies.
+ *
+ * @return array
+ */
+ public function toArray(): array
{
$elements = [
'btc' => $this->getBTC()->toArray(),
@@ -92,6 +282,11 @@ public function toArray()
'usdc' => $this->getUSDC()->toArray(),
'gusd' => $this->getGUSD()->toArray(),
'pax' => $this->getPAX()->toArray(),
+ 'xrp' => $this->getXRP()->toArray(),
+ 'busd' => $this->getBUSD()->toArray(),
+ 'doge' => $this->getDOGE()->toArray(),
+ 'ltc' => $this->getLTC()->toArray(),
+ 'wbtc' => $this->getWBTC()->toArray(),
];
foreach ($elements as $key => $value) {
@@ -102,4 +297,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrency.php b/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrency.php
index b6881233..f58abd27 100644
--- a/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrency.php
+++ b/src/BitPaySDK/Model/Invoice/SupportedTransactionCurrency.php
@@ -1,31 +1,85 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
class SupportedTransactionCurrency
{
- protected $_enabled;
+ protected ?bool $enabled = null;
+ protected ?string $reason = null;
+ /**
+ * SupportedTransactionCurrency constructor.
+ */
public function __construct()
{
}
- public function setEnabled(bool $enabled)
+ /**
+ * Gets enabled.
+ *
+ * @param bool $enabled is enabled
+ */
+ public function setEnabled(bool $enabled): void
+ {
+ $this->enabled = $enabled;
+ }
+
+ /**
+ * Sets enabled.
+ *
+ * @return bool|null
+ */
+ public function getEnabled(): ?bool
+ {
+ return $this->enabled;
+ }
+
+ /**
+ * Gets reason.
+ *
+ * @param string $reason the reason
+ */
+ public function setReason(string $reason): void
{
- $this->_enabled = $enabled;
+ $this->reason = $reason;
}
- public function getEnabled()
+ /**
+ * Sets reason.
+ *
+ * @return string|null
+ */
+ public function getReason(): ?string
{
- return $this->_enabled;
+ return $this->reason;
}
- public function toArray()
+ /**
+ * Return array with enabled and reason value.
+ *
+ * @return array
+ */
+ public function toArray(): array
{
$elements = [
'enabled' => $this->getEnabled(),
+ 'reason' => $this->getReason()
];
foreach ($elements as $key => $value) {
@@ -36,4 +90,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Invoice/UniversalCodes.php b/src/BitPaySDK/Model/Invoice/UniversalCodes.php
new file mode 100644
index 00000000..36d2dee1
--- /dev/null
+++ b/src/BitPaySDK/Model/Invoice/UniversalCodes.php
@@ -0,0 +1,88 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/invoices REST API Invoices
+ */
+class UniversalCodes
+{
+ protected ?string $paymentString = null;
+ protected ?string $verificationLink = null;
+
+ public function __construct()
+ {
+ }
+
+ /**
+ * Gets payment string
+ *
+ * Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.
+ *
+ * @return string|null the payment string
+ */
+ public function getPaymentString(): ?string
+ {
+ return $this->paymentString;
+ }
+
+ /**
+ * Sets payment string
+ *
+ * Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.
+ *
+ * @param string $paymentString the payment string
+ */
+ public function setPaymentString(string $paymentString): void
+ {
+ $this->paymentString = $paymentString;
+ }
+
+ /**
+ * Gets verification link
+ *
+ * Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.
+ *
+ * @return string|null
+ */
+ public function getVerificationLink(): ?string
+ {
+ return $this->verificationLink;
+ }
+
+ /**
+ * Sets verification link
+ *
+ * Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.
+ *
+ * @param string $verificationLink the verification link
+ */
+ public function setVerificationLink(string $verificationLink): void
+ {
+ $this->verificationLink = $verificationLink;
+ }
+
+ /**
+ * Gets Universal codes as array
+ *
+ * @return array universal codes as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'paymentString' => $this->getPaymentString(),
+ 'verificationLink' => $this->getVerificationLink(),
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Ledger/Buyer.php b/src/BitPaySDK/Model/Ledger/Buyer.php
index dfdfc6e9..d411cb19 100644
--- a/src/BitPaySDK/Model/Ledger/Buyer.php
+++ b/src/BitPaySDK/Model/Ledger/Buyer.php
@@ -1,126 +1,242 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/ledgers REST API Ledgers
+ */
class Buyer
{
- protected $_name;
- protected $_address1;
- protected $_address2;
- protected $_city;
- protected $_state;
- protected $_zip;
- protected $_country;
- protected $_phone;
- protected $_notify;
- protected $_email;
+ protected ?string $name = null;
+ protected ?string $address1 = null;
+ protected ?string $address2 = null;
+ protected ?string $city = null;
+ protected ?string $state = null;
+ protected ?string $zip = null;
+ protected ?string $country = null;
+ protected ?string $phone = null;
+ protected ?bool $notify = null;
+ protected ?string $email = null;
public function __construct()
{
}
- public function getName()
+ /**
+ * Gets name
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
{
- return $this->_name;
+ return $this->name;
}
- public function setName(string $name)
+ /**
+ * Sets name
+ *
+ * @param string $name the name
+ */
+ public function setName(string $name): void
{
- $this->_name = $name;
+ $this->name = $name;
}
- public function getAddress1()
+ /**
+ * Gets address 1
+ *
+ * @return string|null the address1
+ */
+ public function getAddress1(): ?string
{
- return $this->_address1;
+ return $this->address1;
}
- public function setAddress1(string $address1)
+ /**
+ * Sets address1
+ *
+ * @param string $address1 the address1
+ */
+ public function setAddress1(string $address1): void
{
- $this->_address1 = $address1;
+ $this->address1 = $address1;
}
- public function getAddress2()
+ /**
+ * Gets address2
+ *
+ * @return string|null the address2
+ */
+ public function getAddress2(): ?string
{
- return $this->_address2;
+ return $this->address2;
}
- public function setAddress2(string $address2)
+ /**
+ * Sets address2
+ *
+ * @param string $address2 the address2
+ */
+ public function setAddress2(string $address2): void
{
- $this->_address2 = $address2;
+ $this->address2 = $address2;
}
- public function getCity()
+ /**
+ * Gets city
+ *
+ * @return string|null the city
+ */
+ public function getCity(): ?string
{
- return $this->_city;
+ return $this->city;
}
- public function setCity(string $city)
+ /**
+ * Sets city
+ *
+ * @param string $city the city
+ */
+ public function setCity(string $city): void
{
- $this->_city = $city;
+ $this->city = $city;
}
- public function getState()
+ /**
+ * Gets state
+ *
+ * @return string|null the state
+ */
+ public function getState(): ?string
{
- return $this->_state;
+ return $this->state;
}
- public function setState(string $state)
+ /**
+ * Sets state
+ *
+ * @param string $state the state
+ */
+ public function setState(string $state): void
{
- $this->_state = $state;
+ $this->state = $state;
}
- public function getZip()
+ /**
+ * Gets zip
+ *
+ * @return string|null the zip
+ */
+ public function getZip(): ?string
{
- return $this->_zip;
+ return $this->zip;
}
- public function setZip(string $zip)
+ /**
+ * Sets zip
+ *
+ * @param string $zip the zip
+ */
+ public function setZip(string $zip): void
{
- $this->_zip = $zip;
+ $this->zip = $zip;
}
- public function getCountry()
+ /**
+ * Gets country
+ *
+ * @return string|null the country
+ */
+ public function getCountry(): ?string
{
- return $this->_country;
+ return $this->country;
}
- public function setCountry(string $country)
+ /**
+ * Sets country
+ *
+ * @param string $country the country
+ */
+ public function setCountry(string $country): void
{
- $this->_country = $country;
+ $this->country = $country;
}
- public function getEmail()
+ /**
+ * Gets email
+ *
+ * @return string|null the email
+ */
+ public function getEmail(): ?string
{
- return $this->_email;
+ return $this->email;
}
- public function setEmail(string $email)
+ /**
+ * Sets email
+ *
+ * @param string $email the email
+ */
+ public function setEmail(string $email): void
{
- $this->_email = $email;
+ $this->email = $email;
}
- public function getPhone()
+ /**
+ * Gets phone
+ *
+ * @return string|null the phone
+ */
+ public function getPhone(): ?string
{
- return $this->_phone;
+ return $this->phone;
}
- public function setPhone(string $phone)
+ /**
+ * Sets phone
+ *
+ * @param string $phone the phone
+ */
+ public function setPhone(string $phone): void
{
- $this->_phone = $phone;
+ $this->phone = $phone;
}
- public function getNotify()
+ /**
+ * Gets notify
+ *
+ * @return bool|null notify
+ */
+ public function getNotify(): ?bool
{
- return $this->_notify;
+ return $this->notify;
}
- public function setNotify(bool $notify)
+ /**
+ * Sets notify
+ *
+ * @param bool $notify notify
+ */
+ public function setNotify(bool $notify): void
{
- $this->_notify = $notify;
+ $this->notify = $notify;
}
- public function toArray()
+ /**
+ * Gets Buyer as array
+ *
+ * @return array Buyer as array
+ */
+ public function toArray(): array
{
$elements = [
'name' => $this->getName(),
diff --git a/src/BitPaySDK/Model/Ledger/Ledger.php b/src/BitPaySDK/Model/Ledger/Ledger.php
index 6d953322..bafa32ea 100644
--- a/src/BitPaySDK/Model/Ledger/Ledger.php
+++ b/src/BitPaySDK/Model/Ledger/Ledger.php
@@ -1,67 +1,78 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/ledgers REST API Ledgers
+ */
class Ledger
{
- protected $_entries;
- protected $_currency;
- protected $_balance;
+ protected ?string $currency = null;
+ protected ?float $balance = null;
public function __construct()
{
}
- public function getEntries()
+ /**
+ * Gets Ledger currency
+ *
+ * @return string|null the Ledger currency
+ */
+ public function getCurrency(): ?string
{
- $entries = [];
-
- foreach ($this->_entries as $entrie) {
- if ($entrie instanceof LedgerEntry) {
- array_push($entries, $entrie->toArray());
- } else {
- array_push($entries, $entrie);
- }
- }
-
- return $entries;
+ return $this->currency;
}
- public function setEntries(array $entries)
+ /**
+ * Sets Ledger currency
+ *
+ * @param string $currency the Ledger currency
+ */
+ public function setCurrency(string $currency): void
{
- $this->_entries = $entries;
+ $this->currency = $currency;
}
- public function getCurrency()
+ /**
+ * Gets Ledger balance in the corresponding currency
+ *
+ * @return float|null the Ledger balance
+ */
+ public function getBalance(): ?float
{
- return $this->_currency;
+ return $this->balance;
}
- public function setCurrency(string $currency)
+ /**
+ * Sets Ledger balance in the corresponding currency
+ *
+ * @param float $balance the Ledger balance
+ */
+ public function setBalance(float $balance): void
{
- $this->_currency = $currency;
+ $this->balance = $balance;
}
- public function getBalance()
+ /**
+ * Gets Ledger as array
+ *
+ * @return array Ledger as array
+ */
+ public function toArray(): array
{
- return $this->_balance;
- }
-
- public function setBalance(float $balance)
- {
- $this->_balance = $balance;
- }
-
- public function toArray()
- {
- $elements = [
- 'entries' => $this->getEntries(),
+ return [
'currency' => $this->getCurrency(),
'balance' => $this->getBalance(),
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Ledger/LedgerEntry.php b/src/BitPaySDK/Model/Ledger/LedgerEntry.php
index 944eb398..b33c9173 100644
--- a/src/BitPaySDK/Model/Ledger/LedgerEntry.php
+++ b/src/BitPaySDK/Model/Ledger/LedgerEntry.php
@@ -1,190 +1,400 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+namespace BitPaySDK\Model\Ledger;
+/**
+ * @package BitPaySDK\Model\Ledger
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/ledgers REST API Ledgers
+ */
class LedgerEntry
{
- protected $_type;
- protected $_amount;
- protected $_code;
- protected $_description;
- protected $_timestamp;
- protected $_txType;
- protected $_scale;
- protected $_invoiceId;
- /**
- * @var Buyer
- */
- protected $_buyer;
- protected $_invoiceAmount;
- protected $_invoiceCurrency;
- protected $_transactionCurrency;
- protected $_id;
- protected $_supportRequest;
+ protected ?string $type = null;
+ protected ?string $amount = null;
+ protected ?string $code = null;
+ protected ?string $timestamp = null;
+ protected ?string $currency = null;
+ protected ?string $txType = null;
+ protected ?string $scale = null;
+ protected ?string $id = null;
+ protected ?string $supportRequest = null;
+ protected ?string $description = null;
+ protected ?string $invoiceId = null;
+ protected Buyer $buyerFields;
+ protected ?float $invoiceAmount = null;
+ protected ?string $invoiceCurrency = null;
+ protected ?string $transactionCurrency = null;
public function __construct()
{
+ $this->buyerFields = new Buyer();
}
- public function getType()
+ /**
+ * Gets type
+ *
+ * Contains the Ledger entry name.
+ * See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+ *
+ * @return string|null the type
+ */
+ public function getType(): ?string
{
- return $this->_type;
+ return $this->type;
}
- public function setType(string $type)
+ /**
+ * Sets type
+ *
+ * Contains the Ledger entry name.
+ * See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+ *
+ * @param string $type the type
+ */
+ public function setType(string $type): void
{
- $this->_type = $type;
+ $this->type = $type;
}
- public function getAmount()
+ /**
+ * Gets Ledger entry amount, relative to the scale.
+ * The decimal amount can be obtained by dividing the amount field by the scale parameter.
+ *
+ * @return string|null
+ */
+ public function getAmount(): ?string
{
- return $this->_amount;
+ return $this->amount;
}
- public function setAmount(string $amount)
+ /**
+ * Sets Ledger entry amount, relative to the scale.
+ * The decimal amount can be obtained by dividing the amount field by the scale parameter.
+ *
+ * @param string $amount the amount
+ */
+ public function setAmount(string $amount): void
{
- $this->_amount = $amount;
+ $this->amount = $amount;
}
- public function getCode()
+ /**
+ * Gets code
+ *
+ * Contains the Ledger entry code.
+ * See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+ *
+ * @return string|null the code
+ */
+ public function getCode(): ?string
{
- return $this->_code;
+ return $this->code;
}
- public function setCode(string $code)
+ /**
+ * Sets code
+ *
+ * Contains the Ledger entry code.
+ * See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes
+ *
+ * @param string $code the code
+ */
+ public function setCode(string $code): void
{
- $this->_code = $code;
+ $this->code = $code;
}
- public function getDescription()
+ /**
+ * Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null the timestamp
+ */
+ public function getTimestamp(): ?string
{
- return $this->_description;
+ return $this->timestamp;
}
- public function setDescription(string $description)
+ /**
+ * Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $timestamp the timestamp
+ */
+ public function setTimestamp(string $timestamp): void
{
- $this->_description = $description;
+ $this->timestamp = $timestamp;
}
- public function getTimestamp()
+ /**
+ * Gets Ledger entry currency for the corresponding amount
+ *
+ * @return string|null the currency
+ */
+ public function getCurrency(): ?string
{
- return $this->_timestamp;
+ return $this->currency;
}
- public function setTimestamp(string $timestamp)
+ /**
+ * Sets Ledger entry currency for the corresponding amount
+ *
+ * @param string $currency the currency
+ */
+ public function setCurrency(string $currency): void
{
- $this->_timestamp = $timestamp;
+ $this->currency = $currency;
}
- public function getTxType()
+ /**
+ * Gets tx type
+ *
+ * [DEPRECRATED] see type
+ *
+ * @return string|null the txType
+ */
+ public function getTxType(): ?string
{
- return $this->_txType;
+ return $this->txType;
}
- public function setTxType(string $txType)
+ /**
+ * Sets tx type
+ *
+ * [DEPRECRATED] see type
+ *
+ * @param string $txType the txType
+ */
+ public function setTxType(string $txType): void
{
- $this->_txType = $txType;
+ $this->txType = $txType;
}
- public function getScale()
+ /**
+ * Gets scale
+ *
+ * Power of 10 used for conversion
+ *
+ * @return string|null the scale
+ */
+ public function getScale(): ?string
{
- return $this->_scale;
+ return $this->scale;
}
- public function setScale(string $scale)
+ /**
+ * Sets scale
+ *
+ * Power of 10 used for conversion
+ *
+ * @param string $scale the scale
+ */
+ public function setScale(string $scale): void
{
- $this->_scale = $scale;
+ $this->scale = $scale;
}
- public function getInvoiceId()
+ /**
+ * Gets Ledger resource Id
+ *
+ * @return string|null the id
+ */
+ public function getId(): ?string
{
- return $this->_invoiceId;
+ return $this->id;
}
- public function setInvoiceId(string $invoiceId)
+ /**
+ * Sets Ledger resource Id
+ *
+ * @param string $id the id
+ */
+ public function setId(string $id): void
{
- $this->_invoiceId = $invoiceId;
+ $this->id = $id;
}
- public function getBuyer()
+ /**
+ * Gets The refund requestId
+ *
+ * @return string|null the support request
+ */
+ public function getSupportRequest(): ?string
{
- return $this->_buyer;
+ return $this->supportRequest;
}
- public function setBuyer(Buyer $buyer)
+ /**
+ * Sets The refund requestId
+ *
+ * @param string $supportRequest the support request
+ */
+ public function setSupportRequest(string $supportRequest): void
{
- $this->_buyer = $buyer;
+ $this->supportRequest = $supportRequest;
}
- public function getInvoiceAmount()
+ /**
+ * Gets description
+ *
+ * Ledger entry description. Also contains an id depending on the type of entry
+ * (for instance payout id, settlement id, invoice orderId etc...)
+ *
+ * @return string|null the description
+ */
+ public function getDescription(): ?string
{
- return $this->_invoiceAmount;
+ return $this->description;
}
- public function setInvoiceAmount(float $invoiceAmount)
+ /**
+ * Sets description
+ *
+ * Ledger entry description. Also contains an id depending on the type of entry
+ * (for instance payout id, settlement id, invoice orderId etc...)
+ *
+ * @param string $description the description
+ */
+ public function setDescription(string $description): void
{
- $this->_invoiceAmount = $invoiceAmount;
+ $this->description = $description;
}
- public function getInvoiceCurrency()
+ /**
+ * Gets BitPay invoice Id
+ *
+ * @return string|null the invoice id
+ */
+ public function getInvoiceId(): ?string
{
- return $this->_invoiceCurrency;
+ return $this->invoiceId;
}
- public function setInvoiceCurrency(string $invoiceCurrency)
+ /**
+ * Sets BitPay invoice Id
+ *
+ * @param string $invoiceId the invoice id
+ */
+ public function setInvoiceId(string $invoiceId): void
{
- $this->_invoiceCurrency = $invoiceCurrency;
+ $this->invoiceId = $invoiceId;
}
- public function getTransactionCurrency()
+ /**
+ * Gets buyer fields
+ *
+ * If provided by the merchant in the buyer object during invoice creation
+ *
+ * @return Buyer
+ */
+ public function getBuyerFields(): Buyer
+ {
+ return $this->buyerFields;
+ }
+
+ /**
+ * Sets buyer fields
+ *
+ * @param Buyer $buyerFields the buyer
+ */
+ public function setBuyerFields(Buyer $buyerFields): void
+ {
+ $this->buyerFields = $buyerFields;
+ }
+
+ /**
+ * Gets Invoice price in the invoice original currency
+ *
+ * @return float|null the invoice amount
+ */
+ public function getInvoiceAmount(): ?float
{
- return $this->_transactionCurrency;
+ return $this->invoiceAmount;
}
- public function setTransactionCurrency(string $transactionCurrency)
+ /**
+ * Sets Invoice price in the invoice original currency
+ *
+ * @param float $invoiceAmount the invoice amount
+ */
+ public function setInvoiceAmount(float $invoiceAmount): void
{
- $this->_transactionCurrency = $transactionCurrency;
+ $this->invoiceAmount = $invoiceAmount;
}
- public function getId()
+ /**
+ * Gets Currency used for invoice creation
+ *
+ * @return string|null the invoice currency
+ */
+ public function getInvoiceCurrency(): ?string
{
- return $this->_id;
+ return $this->invoiceCurrency;
}
- public function setId(string $id)
+ /**
+ * Sets Currency used for invoice creation
+ *
+ * @param string $invoiceCurrency the invoice currency
+ */
+ public function setInvoiceCurrency(string $invoiceCurrency): void
{
- $this->_id = $id;
+ $this->invoiceCurrency = $invoiceCurrency;
}
- public function getSupportRequest()
+ /**
+ * Gets Cryptocurrency selected by the consumer when paying an invoice.
+ *
+ * @return string|null the transaction currency
+ */
+ public function getTransactionCurrency(): ?string
{
- return $this->_supportRequest;
+ return $this->transactionCurrency;
}
- public function setSupportRequest(string $supportRequest)
+ /**
+ * Sets Cryptocurrency selected by the consumer when paying an invoice.
+ *
+ * @param string $transactionCurrency the transaction currency
+ */
+ public function setTransactionCurrency(string $transactionCurrency): void
{
- $this->_supportRequest = $supportRequest;
+ $this->transactionCurrency = $transactionCurrency;
}
- public function toArray()
+ /**
+ * Gets LedgerEntry as array
+ *
+ * @return array LedgerEntry as array
+ */
+ public function toArray(): array
{
$elements = [
'type' => $this->getType(),
'amount' => $this->getAmount(),
'code' => $this->getCode(),
- 'description' => $this->getDescription(),
'timestamp' => $this->getTimestamp(),
+ 'currency' => $this->getCurrency(),
'txType' => $this->getTxType(),
'scale' => $this->getScale(),
+ 'id' => $this->getId(),
+ 'supportRequest' => $this->getSupportRequest(),
+ 'description' => $this->getDescription(),
'invoiceId' => $this->getInvoiceId(),
- 'buyerFields' => $this->getBuyer()->toArray(),
+ 'buyerFields' => $this->getBuyerFields()->toArray(),
'invoiceAmount' => $this->getInvoiceAmount(),
'invoiceCurrency' => $this->getInvoiceCurrency(),
'transactionCurrency' => $this->getTransactionCurrency(),
- 'id' => $this->getId(),
- 'supportRequest' => $this->getSupportRequest(),
];
foreach ($elements as $key => $value) {
@@ -195,4 +405,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Payout/Payout.php b/src/BitPaySDK/Model/Payout/Payout.php
new file mode 100644
index 00000000..f5191df8
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/Payout.php
@@ -0,0 +1,699 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+class Payout
+{
+ protected string $token = '';
+ protected ?float $amount = null;
+ protected ?string $currency = null;
+ protected ?string $effectiveDate = null;
+ protected ?string $ledgerCurrency = null;
+ protected string $reference = '';
+ protected string $notificationURL = '';
+ protected string $notificationEmail = '';
+ protected string $accountId = '';
+ protected string $email = '';
+ protected string $recipientId = '';
+ protected string $shopperId = '';
+ protected string $label = '';
+ protected string $message = '';
+ protected bool $ignoreEmails = false;
+ protected ?string $groupId = null;
+ protected ?int $code = null;
+ protected ?string $dateExecuted = null;
+ protected ?string $id = null;
+ protected ?string $status = null;
+ protected ?string $requestDate = null;
+ protected ?array $exchangeRates = null;
+ /**
+ * @var PayoutTransaction[]
+ */
+ protected array $transactions = [];
+
+ /**
+ * Constructor, create a request Payout object.
+ *
+ * @param float|null $amount float The amount for which the payout will be created.
+ * @param string|null $currency string The three digit currency string for the PayoutBatch to use.
+ * @param string|null $ledgerCurrency string Ledger currency code set for the payout request (ISO 4217 3-character
+ * currency code), it indicates on which ledger the payout request will be
+ * recorded. If not provided in the request, this parameter will be set by
+ * default to the active ledger currency on your account, e.g. your settlement
+ * currency.
+ */
+ public function __construct(float $amount = null, string $currency = null, string $ledgerCurrency = null)
+ {
+ $this->amount = $amount;
+ $this->currency = $currency;
+ $this->ledgerCurrency = $ledgerCurrency;
+ }
+
+ // API fields
+ //
+
+ /**
+ * Gets resource token.
+ *
+ *
+ * This token is actually derived from the API token -
+ * used to submit the payout and is tied to the specific payout resource id created.
+ *
+ *
+ * @return string
+ */
+ public function getToken(): string
+ {
+ return $this->token;
+ }
+
+ /**
+ * Sets resource token.
+ *
+ * This token is actually derived from the API token -
+ * used to submit the payout and is tied to the specific payout resource id created.
+ *
+ * @param string $token
+ */
+ public function setToken(string $token): void
+ {
+ $this->token = $token;
+ }
+
+ // Required fields
+ //
+
+ /**
+ * Gets amount of cryptocurrency sent to the requested address.
+ *
+ * @return float|null
+ */
+ public function getAmount(): ?float
+ {
+ return $this->amount;
+ }
+
+ /**
+ * Sets amount of cryptocurrency sent to the requested address.
+ *
+ * @param float $amount
+ */
+ public function setAmount(float $amount): void
+ {
+ $this->amount = $amount;
+ }
+
+ /**
+ * Change amount value based on precision rounding.
+ *
+ * @param int $precision
+ */
+ public function formatAmount(int $precision): void
+ {
+ $this->amount = round($this->amount, $precision);
+ }
+
+ /**
+ * Gets currency code set for the batch amount (ISO 4217 3-character currency code).
+ *
+ * @return string|null
+ */
+ public function getCurrency(): ?string
+ {
+ return $this->currency;
+ }
+
+ /**
+ * Sets currency code set for the batch amount (ISO 4217 3-character currency code).
+ *
+ * @param string $currency
+ * @throws BitPayException
+ */
+ public function setCurrency(string $currency)
+ {
+ if (!Currency::isValid($currency)) {
+ throw new BitPayException('currency code must be a type of Model.Currency');
+ }
+
+ $this->currency = $currency;
+ }
+
+ /**
+ * Gets Ledger currency code (ISO 4217 3-character currency code)
+ *
+ * it indicates on which ledger the payout request will be recorded. If not provided in the request,
+ * this parameter will be set by default to the active ledger currency on your account,
+ * e.g. your settlement currency.
+ *
+ * @return string|null
+ *
+ * @see https://bitpay.com/api/#rest-api-resources-payouts Supported ledger currency codes
+ */
+ public function getEffectiveDate(): ?string
+ {
+ return $this->effectiveDate;
+ }
+
+ /**
+ * Sets effective date and time (UTC) for the payout.
+ *
+ * ISO-8601 format yyyy-mm-ddThh:mm:ssZ. If not provided, defaults to date and time of creation.
+ *
+ * @param string $effectiveDate
+ */
+ public function setEffectiveDate(string $effectiveDate): void
+ {
+ $this->effectiveDate = $effectiveDate;
+ }
+
+ /**
+ * Gets Ledger currency code (ISO 4217 3-character currency code
+ *
+ * it indicates on which ledger the payout request will be recorded. If not provided in the request,
+ * this parameter will be set by default to the active ledger currency on your account,
+ * e.g. your settlement currency.
+ *
+ * @return string|null
+ * @see https://bitpay.com/api/#rest-api-resources-payouts Supported ledger currency codes
+ *
+ */
+ public function getLedgerCurrency(): ?string
+ {
+ return $this->ledgerCurrency;
+ }
+
+ /**
+ * Sets Ledger currency code (ISO 4217 3-character currency code)
+ *
+ * it indicates on which ledger the payout request will be recorded. If not provided in the request,
+ * this parameter will be set by default to the active ledger currency on your account,
+ * e.g. your settlement currency.
+ *
+ * @param string $ledgerCurrency
+ * @throws BitPayException
+ */
+ public function setLedgerCurrency(string $ledgerCurrency): void
+ {
+ if (!Currency::isValid($ledgerCurrency)) {
+ throw new BitPayException('currency code must be a type of Model.Currency');
+ }
+
+ $this->ledgerCurrency = $ledgerCurrency;
+ }
+
+ // Optional fields
+ //
+
+ /**
+ * Gets reference.
+ *
+ * Present only if specified by the merchant in the request.
+ * Merchants can pass their own unique identifier in this field for reconciliation purpose.
+ * Maximum string length is 100 characters.
+ *
+ * @return string
+ */
+ public function getReference(): string
+ {
+ return $this->reference;
+ }
+
+ /**
+ * Sets reference.
+ *
+ * Present only if specified by the merchant in the request.
+ * Merchants can pass their own unique identifier in this field for reconciliation purpose.
+ * Maximum string length is 100 characters.
+ *
+ * @param string $reference
+ */
+ public function setReference(string $reference): void
+ {
+ $this->reference = $reference;
+ }
+
+ /**
+ * Gets notification url.
+ *
+ * URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ *
+ * @return string
+ */
+ public function getNotificationURL(): string
+ {
+ return $this->notificationURL;
+ }
+
+ /**
+ * Sets notification url.
+ *
+ * URL to which BitPay sends webhook notifications. HTTPS is mandatory.
+ *
+ * @param string $notificationURL
+ */
+ public function setNotificationURL(string $notificationURL): void
+ {
+ $this->notificationURL = $notificationURL;
+ }
+
+ /**
+ * Gets notification email.
+ *
+ * Merchant email address for notification of payout status change.
+ *
+ * @return string
+ */
+ public function getNotificationEmail(): string
+ {
+ return $this->notificationEmail;
+ }
+
+ /**
+ * Sets notification email.
+ *
+ * Merchant email address for notification of payout status change.
+ *
+ * @param string $notificationEmail
+ */
+ public function setNotificationEmail(string $notificationEmail): void
+ {
+ $this->notificationEmail = $notificationEmail;
+ }
+
+ /**
+ * Gets BitPay account id that is associated to the payout,
+ * assigned by BitPay for a given account during the onboarding process.
+ *
+ * @return string
+ */
+ public function getAccountId(): string
+ {
+ return $this->accountId;
+ }
+
+ /**
+ * Sets BitPay account id that is associated to the payout,
+ * assigned by BitPay for a given account during the onboarding process.
+ *
+ * @param string $accountId
+ */
+ public function setAccountId(string $accountId): void
+ {
+ $this->accountId = $accountId;
+ }
+
+ /**
+ * Gets email.
+ *
+ * Email address of an active recipient.
+ * Note: In the future, BitPay may allow recipients to update the email address tied to their personal account.
+ * BitPay encourages the use of `recipientId` or `shopperId` when programatically creating payouts requests.
+ *
+ * @return string
+ */
+ public function getEmail(): string
+ {
+ return $this->email;
+ }
+
+ /**
+ * Sets email.
+ *
+ * Email address of an active recipient.
+ * Note: In the future, BitPay may allow recipients to update the email address tied to their personal account.
+ * BitPay encourages the use of `recipientId` or `shopperId` when programatically creating payouts requests.
+ *
+ * @param string $email
+ */
+ public function setEmail(string $email): void
+ {
+ $this->email = $email;
+ }
+
+ /**
+ * Gets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+ *
+ * @return string
+ */
+ public function getRecipientId(): string
+ {
+ return $this->recipientId;
+ }
+
+ /**
+ * Sets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
+ *
+ * @param string $recipientId
+ */
+ public function setRecipientId(string $recipientId): void
+ {
+ $this->recipientId = $recipientId;
+ }
+
+ /**
+ * Gets shopper id.
+ *
+ * This is the unique id assigned by BitPay if the shopper used his personal BitPay account to authenticate and
+ * pay an invoice. For customers signing up for a brand new BitPay personal account,
+ * this id will only be created as part of the payout onboarding.
+ * The same field would also be available on paid invoices for customers who signed in with their
+ * BitPay personal accounts before completing the payment.
+ * This can allow merchants to monitor the activity of a customer (deposits and payouts).
+ *
+ * @return string
+ */
+ public function getShopperId(): string
+ {
+ return $this->shopperId;
+ }
+
+ /**
+ * Sets shopper id.
+ *
+ * This is the unique id assigned by BitPay if the shopper used his personal BitPay account to authenticate and
+ * pay an invoice. For customers signing up for a brand new BitPay personal account,
+ * this id will only be created as part of the payout onboarding.
+ * The same field would also be available on paid invoices for customers who signed in with their
+ * BitPay personal accounts before completing the payment.
+ * This can allow merchants to monitor the activity of a customer (deposits and payouts).
+ *
+ * @param string $shopperId
+ */
+ public function setShopperId(string $shopperId): void
+ {
+ $this->shopperId = $shopperId;
+ }
+
+ /**
+ * Gets label.
+ *
+ * For merchant use, pass through - can be the customer name or unique merchant reference assigned by
+ * the merchant to the recipient.
+ *
+ * @return string
+ */
+ public function getLabel(): string
+ {
+ return $this->label;
+ }
+
+ /**
+ * Sets label.
+ *
+ * For merchant use, pass through - can be the customer name or unique merchant reference assigned by
+ * the merchant to the recipient.
+ *
+ * @param string $label
+ */
+ public function setLabel(string $label): void
+ {
+ $this->label = $label;
+ }
+
+ /**
+ * Gets message.
+ *
+ * In case of error, this field will contain a description message. Set to `null` if the request is successful.
+ *
+ * @return string
+ */
+ public function getMessage(): string
+ {
+ return $this->message;
+ }
+
+ /**
+ * Sets message.
+ *
+ * In case of error, this field will contain a description message. Set to `null` if the request is successful.
+ *
+ * @param string $message
+ */
+ public function setMessage(string $message): void
+ {
+ $this->message = $message;
+ }
+
+ /**
+ * Gets group id.
+ *
+ * @return string|null
+ */
+ public function getGroupId(): ?string
+ {
+ return $this->groupId;
+ }
+
+ /**
+ * Sets group id.
+ *
+ * @param string|null $groupId
+ */
+ public function setGroupId(?string $groupId): void
+ {
+ $this->groupId = $groupId;
+ }
+
+ /**
+ * This field will be returned in case of error and contain an error code.
+ *
+ * @return int|null
+ */
+ public function getCode(): ?int
+ {
+ return $this->code;
+ }
+
+ /**
+ * Sets error code.
+ *
+ * @param int|null $code
+ */
+ public function setCode(?int $code): void
+ {
+ $this->code = $code;
+ }
+
+ /**
+ * Gets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+ *
+ * @return string|null
+ */
+ public function getDateExecuted(): ?string
+ {
+ return $this->dateExecuted;
+ }
+
+ /**
+ * Sets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+ *
+ * @param string $dateExecuted
+ */
+ public function setDateExecuted(string $dateExecuted): void
+ {
+ $this->dateExecuted = $dateExecuted;
+ }
+
+ // Response fields
+ //
+
+ /**
+ * Gets Payout request id.
+ *
+ * @return string|null
+ */
+ public function getId(): ?string
+ {
+ return $this->id;
+ }
+
+ /**
+ * Sets Payout request id.
+ *
+ * @param string $id
+ */
+ public function setId(string $id): void
+ {
+ $this->id = $id;
+ }
+
+ /**
+ * Gets payout request status.
+ *
+ * The possible values are:
+ *
+ * new - initial status when the payout batch is created
+ * funded - if there are enough funds available on the merchant account,
+ * the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+ * e.g. 2pm and 9pm UTC
+ *
+ * processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+ * transactions are broadcasted by BitPay
+ *
+ * complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+ * the typical target confirmation for the corresponding asset. For instance,
+ * 6 confirmations for a bitcoin transaction.
+ *
+ * cancelled - when the merchant cancels a payout batch (only possible for requests in the status new
+ *
+ *
+ * @return string|null
+ */
+ public function getStatus(): ?string
+ {
+ return $this->status;
+ }
+
+ /**
+ * Sets payout request status.
+ *
+ * The possible values are:
+ *
+ * new - initial status when the payout batch is created
+ * funded - if there are enough funds available on the merchant account,
+ * the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+ * e.g. 2pm and 9pm UTC
+ *
+ * processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+ * transactions are broadcasted by BitPay
+ *
+ * complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+ * the typical target confirmation for the corresponding asset. For instance,
+ * 6 confirmations for a bitcoin transaction.
+ *
+ * cancelled - when the merchant cancels a payout batch (only possible for requests in the status new
+ *
+ *
+ * @param string $status
+ */
+ public function setStatus(string $status): void
+ {
+ $this->status = $status;
+ }
+
+ /**
+ * Gets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+ *
+ * @return string|null
+ */
+ public function getRequestDate(): ?string
+ {
+ return $this->requestDate;
+ }
+
+ /**
+ * Sets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
+ *
+ * @param string $requestDate
+ */
+ public function setRequestDate(string $requestDate): void
+ {
+ $this->requestDate = $requestDate;
+ }
+
+ /**
+ * Gets exchange rates keyed by source and target currencies.
+ *
+ * @return array|null
+ */
+ public function getExchangeRates(): ?array
+ {
+ return $this->exchangeRates;
+ }
+
+ /**
+ * Sets exchange rates keyed by source and target currencies.
+ *
+ * @param array $exchangeRates
+ */
+ public function setExchangeRates(array $exchangeRates): void
+ {
+ $this->exchangeRates = $exchangeRates;
+ }
+
+ /**
+ * Gets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+ *
+ * @return PayoutTransaction[]
+ */
+ public function getTransactions(): array
+ {
+ return $this->transactions;
+ }
+
+ /**
+ * Sets transactions. Contains the cryptocurrency transaction details for the executed payout request.
+ *
+ * @param PayoutTransaction[] $transactions
+ * @throws PayoutException
+ */
+ public function setTransactions(array $transactions): void
+ {
+ foreach ($transactions as $transaction) {
+ if (!$transaction instanceof PayoutTransaction) {
+ throw new PayoutException(
+ 'Wrong type of transactions array. They should contains only PayoutTransaction objects'
+ );
+ }
+ }
+
+ $this->transactions = $transactions;
+ }
+
+ /**
+ * Gets boolean to prevent email updates on a specific payout.
+ * Defaults to false if not provided - you will receive emails unless specified to true.
+ *
+ * @return bool
+ */
+ public function isIgnoreEmails(): bool
+ {
+ return $this->ignoreEmails;
+ }
+
+ /**
+ * Sets boolean to prevent email updates on a specific payout.
+ * Defaults to false if not provided - you will receive emails unless specified to true.
+ *
+ * @param bool $ignoreEmails
+ */
+ public function setIgnoreEmails(bool $ignoreEmails): void
+ {
+ $this->ignoreEmails = $ignoreEmails;
+ }
+
+ /**
+ * Return Payout values as array.
+ *
+ * @return array
+ */
+ public function toArray(): array
+ {
+ $result = [];
+ $fields = get_object_vars($this);
+
+ foreach ($fields as $name => $value) {
+ if (!empty($value)) {
+ $result[$name] = $value;
+ }
+ }
+
+ return $result;
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutBatch.php b/src/BitPaySDK/Model/Payout/PayoutBatch.php
deleted file mode 100644
index 97f0ae24..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutBatch.php
+++ /dev/null
@@ -1,376 +0,0 @@
-_currency = $currency;
- $this->_effectiveDate = $effectiveDate;
- $this->_instructions = $instructions;
- $this->_computeAndSetAmount();
- }
-
- // Private methods
- //
-
- private function _computeAndSetAmount()
- {
- $amount = 0.0;
- if ($this->_instructions) {
- foreach ($this->_instructions as $instruction) {
- if ($instruction instanceof PayoutInstruction) {
- $amount += $instruction->getAmount();
- } else {
- $amount += $instruction->amount;
- }
- }
- }
- $this->_amount = $amount;
- }
-
- // API fields
- //
-
- public function getGuid()
- {
- return $this->_guid;
- }
-
- public function setGuid(string $guid)
- {
- $this->_guid = $guid;
- }
-
- public function getToken()
- {
- return $this->_token;
- }
-
- public function setToken(string $token)
- {
- $this->_token = $token;
- }
-
- // Required fields
- //
-
- public function getAmount()
- {
- return $this->_amount;
- }
-
- public function setAmount(float $amount)
- {
- $this->_amount = $amount;
- }
-
- public function formatAmount(int $precision)
- {
- $this->_amount = round($this->_amount, $precision);
- }
-
- public function getCurrency()
- {
- return $this->_currency;
- }
-
- public function setCurrency(string $currency)
- {
- if (!Currency::isValid($currency)) {
- throw new BitPayException("currency code must be a type of Model.Currency");
- }
-
- $this->_currency = $currency;
- }
-
- public function getEffectiveDate()
- {
- return $this->_effectiveDate;
- }
-
- public function setEffectiveDate(string $effectiveDate)
- {
- $this->_effectiveDate = $effectiveDate;
- }
-
- public function getInstructions()
- {
- $instructions = [];
-
- foreach ($this->_instructions as $instruction) {
- if ($instruction instanceof PayoutInstruction) {
- array_push($instructions, $instruction->toArray());
- } else {
- array_push($instructions, $instruction);
- }
- }
-
- return $instructions;
- }
-
- public function setInstructions(array $instructions)
- {
- $this->_instructions = $instructions;
- $this->_computeAndSetAmount();
- }
-
- // Optional fields
- //
-
- public function getReference()
- {
- return $this->_reference;
- }
-
- public function setReference(string $reference)
- {
- $this->_reference = $reference;
- }
-
- public function getNotificationEmail()
- {
- return $this->_notificationEmail;
- }
-
- public function setNotificationEmail(string $notificationEmail)
- {
- $this->_notificationEmail = $notificationEmail;
- }
-
- public function getNotificationURL()
- {
- return $this->_notificationUrl;
- }
-
- public function setNotificationURL(string $notificationUrl)
- {
- $this->_notificationUrl = $notificationUrl;
- }
-
-//TODO remove on version 4.0
-
- /**
- * @deprecated Use setNotificationURL instead
- */
- public function setRedirectURL(string $notificationUrl)
- {
- $this->_notificationUrl = $notificationUrl;
- }
-
- public function getPricingMethod()
- {
- return $this->_pricingMethod;
- }
-
- public function setPricingMethod(string $pricingMethod)
- {
- $this->_pricingMethod = $pricingMethod;
- }
-
- // Response fields
- //
-
- public function getId()
- {
- return $this->_id;
- }
-
- public function setId(string $id)
- {
- $this->_id = $id;
- }
-
- public function getAccount()
- {
- return $this->_account;
- }
-
- public function setAccount(string $account)
- {
- $this->_account = $account;
- }
-
- public function getSupportPhone()
- {
- return $this->_supportPhone;
- }
-
- public function setSupportPhone(string $supportPhone)
- {
- $this->_supportPhone = $supportPhone;
- }
-
- public function getStatus()
- {
- return $this->_status;
- }
-
- public function setStatus(string $status)
- {
- $this->_status = $status;
- }
-
- public function getPercentFee()
- {
- return $this->_percentFee;
- }
-
- public function setPercentFee(float $percentFee)
- {
- $this->_percentFee = $percentFee;
- }
-
- public function getFee()
- {
- return $this->_fee;
- }
-
- public function setFee(float $fee)
- {
- $this->_fee = $fee;
- }
-
- public function getDepositTotal()
- {
- return $this->_depositTotal;
- }
-
- public function setDepositTotal(float $depositTotal)
- {
- $this->_depositTotal = $depositTotal;
- }
-
- public function getBtc()
- {
- return $this->_btc;
- }
-
- public function setBtc(?float $btc)
- {
- $this->_btc = $btc;
- }
-
- public function getRate()
- {
- return $this->_rate;
- }
-
- public function setRate(float $rate)
- {
- $this->_rate = $rate;
- }
-
- public function getRequestDate()
- {
- return $this->_requestDate;
- }
-
- public function setRequestDate(string $requestDate)
- {
- $this->_requestDate = $requestDate;
- }
-
- public function getDateExecuted()
- {
- return $this->_dateExecuted;
- }
-
- public function setDateExecuted(string $dateExecuted)
- {
- $this->_dateExecuted = $dateExecuted;
- }
-
- public function setCurrencyInfo(array $currencyInfo)
- {
- $this->_currnecyinfo = $currencyInfo;
- }
-
- public function getCurrencyInfo()
- {
- return $this->_currencyInfo;
- }
-
- public function toArray()
- {
- $elements = [
- 'guid' => $this->getGuid(),
- 'token' => $this->getToken(),
- 'amount' => $this->getAmount(),
- 'currency' => $this->getCurrency(),
- 'effectiveDate' => $this->getEffectiveDate(),
- 'instructions' => $this->getInstructions(),
- 'reference' => $this->getReference(),
- 'notificationEmail' => $this->getNotificationEmail(),
- 'notificationURL' => $this->getNotificationURL(),
- 'pricingMethod' => $this->getPricingMethod(),
- 'id' => $this->getId(),
- 'account' => $this->getAccount(),
- 'supportPhone' => $this->getSupportPhone(),
- 'status' => $this->getStatus(),
- 'percentFee' => $this->getPercentFee(),
- 'fee' => $this->getFee(),
- 'depositTotal' => $this->getDepositTotal(),
- 'rate' => $this->getRate(),
- 'btc' => $this->getBtc(),
- 'requestDate' => $this->getRequestDate(),
- 'dateExecuted' => $this->getDateExecuted(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
diff --git a/src/BitPaySDK/Model/Payout/PayoutGroup.php b/src/BitPaySDK/Model/Payout/PayoutGroup.php
new file mode 100644
index 00000000..e9daccf9
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/PayoutGroup.php
@@ -0,0 +1,55 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutGroup
+{
+ /**
+ * @var Payout[]
+ */
+ private array $payouts = [];
+
+ /**
+ * @var PayoutGroupFailed[]
+ */
+ private array $failed = [];
+
+ /**
+ * @return Payout[]
+ */
+ public function getPayouts(): array
+ {
+ return $this->payouts;
+ }
+
+ /**
+ * @param Payout[] $payouts
+ */
+ public function setPayouts(array $payouts): void
+ {
+ $this->payouts = $payouts;
+ }
+
+ /**
+ * @return PayoutGroupFailed[]
+ */
+ public function getFailed(): array
+ {
+ return $this->failed;
+ }
+
+ /**
+ * @param PayoutGroupFailed[] $failed
+ */
+ public function setFailed(array $failed): void
+ {
+ $this->failed = $failed;
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutGroupFailed.php b/src/BitPaySDK/Model/Payout/PayoutGroupFailed.php
new file mode 100644
index 00000000..1f620f61
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/PayoutGroupFailed.php
@@ -0,0 +1,69 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PayoutGroupFailed
+{
+ private string $errMessage = '';
+ private ?string $payoutId;
+ private ?string $payee;
+
+ /**
+ * @return string
+ */
+ public function getErrorMessage(): string
+ {
+ return $this->errMessage;
+ }
+
+ /**
+ * @param string $errMessage
+ */
+ public function setErrorMessage(string $errMessage): void
+ {
+ $this->errMessage = $errMessage;
+ }
+
+ /**
+ * @return string|null
+ */
+ public function getPayoutId(): ?string
+ {
+ return $this->payoutId;
+ }
+
+ /**
+ * @param string|null $payoutId
+ */
+ public function setPayoutId(?string $payoutId): void
+ {
+ $this->payoutId = $payoutId;
+ }
+
+ /**
+ * @return string|null
+ */
+ public function getPayee(): ?string
+ {
+ return $this->payee;
+ }
+
+ /**
+ * @param string|null $payee
+ */
+ public function setPayee(?string $payee): void
+ {
+ $this->payee = $payee;
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutInstruction.php b/src/BitPaySDK/Model/Payout/PayoutInstruction.php
deleted file mode 100644
index 3913b057..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutInstruction.php
+++ /dev/null
@@ -1,145 +0,0 @@
-_amount = $amount;
- $this->_address = $address;
- }
-
- public function getAmount()
- {
- return $this->_amount;
- }
-
- public function setAmount(float $amount)
- {
- $this->_amount = $amount;
- }
-
- public function getAddress()
- {
- return $this->_address;
- }
-
- public function setAddress(string $address)
- {
- $this->_address = $address;
- }
-
- public function getLabel()
- {
- return $this->_label;
- }
-
- public function setLabel(string $label)
- {
- $this->_label = $label;
- }
-
- public function getWalletProvider()
- {
- return $this->_walletProvider;
- }
-
- public function setWalletProvider(string $walletProvider)
- {
- $this->_walletProvider = $walletProvider;
- }
-
- // Response fields
- //
-
- public function getId()
- {
- return $this->_id;
- }
-
- public function setId(string $id)
- {
- $this->_id = $id;
- }
-
- public function getBtc()
- {
- return $this->_btc ? $this->_btc->toArray() : null;
- }
-
- public function setBtc(PayoutInstructionBtcSummary $btc)
- {
- $this->_btc = $btc;
- }
-
- public function getTransactions()
- {
- return $this->_transactions;
- }
-
- public function setTransactions(array $transactions)
- {
- $this->_transactions = $transactions;
- }
-
- public function getStatus()
- {
- return $this->_status;
- }
-
- public function setStatus(string $status)
- {
- $this->_status = $status;
- }
-
- public function toArray()
- {
- $elements = [
- 'amount' => $this->getAmount(),
- 'address' => $this->getAddress(),
- 'label' => $this->getLabel(),
- 'id' => $this->getId(),
- 'btc' => $this->getBtc(),
- 'transactions' => $this->getTransactions(),
- 'status' => $this->getStatus(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
diff --git a/src/BitPaySDK/Model/Payout/PayoutInstructionBtcSummary.php b/src/BitPaySDK/Model/Payout/PayoutInstructionBtcSummary.php
deleted file mode 100644
index ba970dc7..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutInstructionBtcSummary.php
+++ /dev/null
@@ -1,37 +0,0 @@
-_paid = $paid;
- $this->_unpaid = $unpaid;
- }
-
- public function getPaid()
- {
- return $this->_paid;
- }
-
- public function getUnpaid()
- {
- return $this->_unpaid;
- }
-
- public function toArray()
- {
- $elements = [
- 'paid' => $this->getPaid(),
- 'unpaid' => $this->getUnpaid(),
- ];
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Payout/PayoutInstructionTransaction.php b/src/BitPaySDK/Model/Payout/PayoutInstructionTransaction.php
deleted file mode 100644
index 0d5f2300..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutInstructionTransaction.php
+++ /dev/null
@@ -1,57 +0,0 @@
-_txid;
- }
-
- public function setTxid(string $txid)
- {
- $this->_txid = $txid;
- }
-
- public function getAmount()
- {
- return $this->_amount;
- }
-
- public function setAmount(float $amount)
- {
- $this->_amount = $amount;
- }
-
- public function getDate()
- {
- return $this->_date;
- }
-
- public function setDate(string $date)
- {
- $this->_date = $date;
- }
-
- public function toArray()
- {
- $elements = [
- 'txid' => $this->getTxid(),
- 'amount' => $this->getAmount(),
- 'date' => $this->getDate(),
- ];
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Payout/PayoutReceivedInfo.php b/src/BitPaySDK/Model/Payout/PayoutReceivedInfo.php
deleted file mode 100644
index b81c4e8f..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutReceivedInfo.php
+++ /dev/null
@@ -1,70 +0,0 @@
-_name;
- }
-
- public function setName(string $name)
- {
- $this->_name = $name;
- }
-
- public function getEmail()
- {
- return $this->_email;
- }
-
- public function setEmail(string $email)
- {
- $this->_email = $email;
- }
-
- public function getAddress()
- {
- return $this->_address;
- }
-
- public function setAddress(PayoutReceivedInfoAddress $address)
- {
- $this->_address = $address;
- }
-
- public function toArray()
- {
- $elements = [
- 'name' => $this->getName(),
- 'email' => $this->getEmail(),
- 'address' => $this->getAddress()->toArray(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
diff --git a/src/BitPaySDK/Model/Payout/PayoutReceivedInfoAddress.php b/src/BitPaySDK/Model/Payout/PayoutReceivedInfoAddress.php
deleted file mode 100644
index fce69853..00000000
--- a/src/BitPaySDK/Model/Payout/PayoutReceivedInfoAddress.php
+++ /dev/null
@@ -1,102 +0,0 @@
-_address1;
- }
-
- public function setAddress1(string $address1)
- {
- $this->_address1 = $address1;
- }
-
- public function getAddress2()
- {
- return $this->_address2;
- }
-
- public function setAddress2(string $address2)
- {
- $this->_address2 = $address2;
- }
-
- public function getLocality()
- {
- return $this->_locality;
- }
-
- public function setLocality(string $locality)
- {
- $this->_locality = $locality;
- }
-
- public function getRegion()
- {
- return $this->_region;
- }
-
- public function setRegion(string $region)
- {
- $this->_region = $region;
- }
-
- public function getPostalCode()
- {
- return $this->_postalCode;
- }
-
- public function setPostalCode(string $postalCode)
- {
- $this->_postalCode = $postalCode;
- }
-
- public function getCountry()
- {
- return $this->_country;
- }
-
- public function setCountry(string $country)
- {
- $this->_country = $country;
- }
-
- public function toArray()
- {
- $elements = [
- 'address1' => $this->getAddress1(),
- 'address2' => $this->getAddress2(),
- 'locality' => $this->getLocality(),
- 'region' => $this->getRegion(),
- 'postalCode' => $this->getPostalCode(),
- 'country' => $this->getCountry(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
diff --git a/src/BitPaySDK/Model/Payout/PayoutRecipient.php b/src/BitPaySDK/Model/Payout/PayoutRecipient.php
new file mode 100644
index 00000000..997d860f
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/PayoutRecipient.php
@@ -0,0 +1,238 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+class PayoutRecipient
+{
+ protected ?string $email = null;
+ protected ?string $guid = null;
+ protected ?string $label = null;
+ protected ?string $notificationURL = null;
+ protected ?string $status = null;
+ protected ?string $id = null;
+ protected ?string $shopperId = null;
+ protected ?string $token = null;
+
+ /**
+ * Constructor, create a minimal Recipient object.
+ *
+ * @param string|null $email string Recipient email address to which the invite shall be sent.
+ * @param string|null $label string Recipient nickname assigned by the merchant (Optional).
+ * @param string|null $notificationURL string URL to which BitPay sends webhook notifications to inform
+ * the merchant about the status of a given recipient. HTTPS is mandatory (Optional).
+ */
+ public function __construct(string $email = null, string $label = null, string $notificationURL = null)
+ {
+ $this->email = $email;
+ $this->label = $label;
+ $this->notificationURL = $notificationURL;
+ }
+
+ // Required fields
+ //
+
+ /**
+ * Gets email.
+ *
+ * @return string|null
+ */
+ public function getEmail(): ?string
+ {
+ return $this->email;
+ }
+
+ /**
+ * Sets email.
+ *
+ * @param string|null $email
+ */
+ public function setEmail(?string $email): void
+ {
+ $this->email = $email;
+ }
+
+ // Optional fields
+ //
+
+ /**
+ * Gets guid.
+ *
+ * @return string|null
+ */
+ public function getGuid(): ?string
+ {
+ return $this->guid;
+ }
+
+ /**
+ * Sets guid.
+ *
+ * @param string $guid
+ */
+ public function setGuid(string $guid): void
+ {
+ $this->guid = $guid;
+ }
+
+ /**
+ * Gets label.
+ *
+ * @return string|null
+ */
+ public function getLabel(): ?string
+ {
+ return $this->label;
+ }
+
+ /**
+ * Sets label.
+ *
+ * @param string|null $label
+ */
+ public function setLabel(?string $label): void
+ {
+ $this->label = $label;
+ }
+
+ /**
+ * Gets notification url.
+ *
+ * @return string|null
+ */
+ public function getNotificationURL(): ?string
+ {
+ return $this->notificationURL;
+ }
+
+ /**
+ * Sets notification url.
+ *
+ * @param string|null $notificationURL
+ */
+ public function setNotificationURL(?string $notificationURL): void
+ {
+ $this->notificationURL = $notificationURL;
+ }
+
+ // Response fields
+ //
+
+ /**
+ * Gets status.
+ *
+ * @return string|null
+ */
+ public function getStatus(): ?string
+ {
+ return $this->status;
+ }
+
+ /**
+ * Sets status.
+ *
+ * @param string $status
+ */
+ public function setStatus(string $status): void
+ {
+ $this->status = $status;
+ }
+
+ /**
+ * Gets id.
+ *
+ * @return string|null
+ */
+ public function getId(): ?string
+ {
+ return $this->id;
+ }
+
+ /**
+ * Sets id.
+ *
+ * @param string|null $id
+ */
+ public function setId(?string $id): void
+ {
+ $this->id = $id;
+ }
+
+ /**
+ * Gets Shopper ID.
+ *
+ * @return string|null
+ */
+ public function getShopperId(): ?string
+ {
+ return $this->shopperId;
+ }
+
+ /**
+ * Sets Shopper ID.
+ *
+ * @param string|null $shopperId
+ */
+ public function setShopperId(?string $shopperId): void
+ {
+ $this->shopperId = $shopperId;
+ }
+
+ /**
+ * Gets token.
+ *
+ * @return string|null
+ */
+ public function getToken(): ?string
+ {
+ return $this->token;
+ }
+
+ /**
+ * Sets token.
+ *
+ * @param string $token
+ */
+ public function setToken(string $token): void
+ {
+ $this->token = $token;
+ }
+
+ /**
+ * Return an array with values of all fields.
+ *
+ * @return array
+ */
+ public function toArray(): array
+ {
+ $elements = [
+ 'email' => $this->getEmail(),
+ 'guid' => $this->getGuid(),
+ 'label' => $this->getLabel(),
+ 'notificationURL' => $this->getNotificationURL(),
+ 'status' => $this->getStatus(),
+ 'id' => $this->getId(),
+ 'shopperId' => $this->getShopperId(),
+ 'token' => $this->getToken(),
+ ];
+
+ foreach ($elements as $key => $value) {
+ if (empty($value)) {
+ unset($elements[$key]);
+ }
+ }
+
+ return $elements;
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutRecipients.php b/src/BitPaySDK/Model/Payout/PayoutRecipients.php
new file mode 100644
index 00000000..5da7e110
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/PayoutRecipients.php
@@ -0,0 +1,139 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+
+namespace BitPaySDK\Model\Payout;
+
+use BitPaySDK\Exceptions\PayoutRecipientException;
+
+/**
+ * @package BitPaySDK\Model\Payout
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+class PayoutRecipients
+{
+ protected array $recipients = [];
+ protected string $guid = '';
+ protected string $token = '';
+
+ /**
+ * Constructor, create an recipient-full request PayoutBatch object.
+ *
+ * @param $recipients array array of JSON objects, with containing the following parameters.
+ */
+ public function __construct(array $recipients = [])
+ {
+ $this->recipients = $recipients;
+ }
+
+ // API fields
+ //
+
+ /**
+ * Gets guid.
+ *
+ * @return string
+ */
+ public function getGuid(): string
+ {
+ return $this->guid;
+ }
+
+ /**
+ * Sets guid.
+ *
+ * @param string $guid
+ */
+ public function setGuid(string $guid): void
+ {
+ $this->guid = $guid;
+ }
+
+ /**
+ * Gets token.
+ *
+ * @return string
+ */
+ public function getToken(): string
+ {
+ return $this->token;
+ }
+
+ /**
+ * Sets token.
+ *
+ * @param string $token
+ */
+ public function setToken(string $token): void
+ {
+ $this->token = $token;
+ }
+
+ // Required fields
+ //
+
+ /**
+ * Gets an array with all recipients.
+ *
+ * @return PayoutRecipient[]
+ */
+ public function getRecipients(): array
+ {
+ return $this->recipients;
+ }
+
+ /**
+ * Sets array with all recipients.
+ *
+ * @param PayoutRecipient[] $recipients
+ * @throws PayoutRecipientException
+ */
+ public function setRecipients(array $recipients): void
+ {
+ foreach ($recipients as $recipient) {
+ if (!$recipient instanceof PayoutRecipient) {
+ throw new PayoutRecipientException('Array should contains only PayoutRecipient objects');
+ }
+ }
+
+ $this->recipients = $recipients;
+ }
+
+ /**
+ * Return an array with paid and unpaid value.
+ *
+ * @return array
+ */
+ public function toArray(): array
+ {
+ $recipients = [];
+ foreach ($this->getRecipients() as $recipient) {
+ $recipients[] = $recipient->toArray();
+ }
+
+ $elements = [
+ 'guid' => $this->getGuid(),
+ 'recipients' => $recipients,
+ 'token' => $this->getToken(),
+ ];
+
+ foreach ($elements as $key => $value) {
+ if (empty($value)) {
+ unset($elements[$key]);
+ }
+ }
+
+ return $elements;
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutStatus.php b/src/BitPaySDK/Model/Payout/PayoutStatus.php
index e26e4ae7..a38b97a9 100644
--- a/src/BitPaySDK/Model/Payout/PayoutStatus.php
+++ b/src/BitPaySDK/Model/Payout/PayoutStatus.php
@@ -1,17 +1,63 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+namespace BitPaySDK\Model\Payout;
+/**
+ * Interface PayoutStatus
+ *
+ * @package BitPaySDK\Model\Payout
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
interface PayoutStatus
{
- const New = "new";
- const Funded = "funded";
- const Processing = "processing";
- const Complete = "complete";
- const Failed = "failed";
- const Cancelled = "cancelled";
- const Paid = "paid";
- const Unpaid = "unpaid";
-}
\ No newline at end of file
+ /**
+ * New status.
+ */
+ public const NEW = 'new';
+
+ /**
+ * Funded status.
+ */
+ public const FUNDED = 'funded';
+
+ /**
+ * Processing status
+ */
+ public const PROCESSING = 'processing';
+
+ /**
+ * Complete status
+ */
+ public const COMPLETE = 'complete';
+
+ /**
+ * Failed status.
+ */
+ public const FAILED = 'failed';
+
+ /**
+ * Cancelled status.
+ */
+ public const CANCELLED = 'cancelled';
+
+ /**
+ * Paid status.
+ */
+ public const PAID = 'paid';
+
+ /**
+ * Unpaid status.
+ */
+ public const UNPAID = 'unpaid';
+}
diff --git a/src/BitPaySDK/Model/Payout/PayoutTransaction.php b/src/BitPaySDK/Model/Payout/PayoutTransaction.php
new file mode 100644
index 00000000..713b6e7b
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/PayoutTransaction.php
@@ -0,0 +1,131 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+
+namespace BitPaySDK\Model\Payout;
+
+/**
+ * Contains the cryptocurrency transaction details for the executed payout.
+ *
+ * @package BitPaySDK\Model\Payout
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+class PayoutTransaction
+{
+ protected ?string $txid = null;
+ protected ?float $amount = null;
+ protected ?string $date = null;
+ protected ?string $confirmations = null;
+
+ public function __construct()
+ {
+ }
+
+ /**
+ * Gets Cryptocurrency transaction hash for the executed payout.
+ *
+ * @return string|null the tax id
+ */
+ public function getTxid(): ?string
+ {
+ return $this->txid;
+ }
+
+ /**
+ * Sets Cryptocurrency transaction hash for the executed payout.
+ *
+ * @param string|null $txid the tax id
+ */
+ public function setTxid(?string $txid): void
+ {
+ $this->txid = $txid;
+ }
+
+ /**
+ * Gets Amount of cryptocurrency sent to the requested address.
+ *
+ * @return float|null the amount
+ */
+ public function getAmount(): ?float
+ {
+ return $this->amount;
+ }
+
+ /**
+ * Sets Amount of cryptocurrency sent to the requested address.
+ *
+ * @param float|null $amount the amount
+ */
+ public function setAmount(?float $amount): void
+ {
+ $this->amount = $amount;
+ }
+
+ /**
+ * Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+ * ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+ *
+ * @return string|null the date
+ */
+ public function getDate(): ?string
+ {
+ return $this->date;
+ }
+
+ /**
+ * Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
+ * ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
+ *
+ * @param string|null $date the date
+ */
+ public function setDate(?string $date): void
+ {
+ $this->date = $date;
+ }
+
+ /**
+ * Gets the number of confirmations the transaction has received.
+ *
+ * @return string|null
+ */
+ public function getConfirmations(): ?string
+ {
+ return $this->confirmations;
+ }
+
+ /**
+ * Sets the number of confirmations the transaction has received.
+ *
+ * @param string|null $confirmations
+ */
+ public function setConfirmations(?string $confirmations): void
+ {
+ $this->confirmations = $confirmations;
+ }
+
+ /**
+ * Gets PayoutTransaction as array
+ *
+ * @return array PayoutTransaction as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'txid' => $this->getTxid(),
+ 'amount' => $this->getAmount(),
+ 'date' => $this->getDate(),
+ 'confirmations' => $this->getConfirmations()
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Payout/RecipientReferenceMethod.php b/src/BitPaySDK/Model/Payout/RecipientReferenceMethod.php
new file mode 100644
index 00000000..a23af487
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/RecipientReferenceMethod.php
@@ -0,0 +1,38 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+
+namespace BitPaySDK\Model\Payout;
+
+/**
+ * List of recipient reference methods
+ *
+ * @package BitPaySDK\Model\Payout
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+interface RecipientReferenceMethod
+{
+ /**
+ * Email method will be used to target the recipient
+ */
+ public const EMAIL = 1;
+
+ /**
+ * Recipient id will be used to target the recipient
+ */
+ public const RECIPIENT_ID = 2;
+
+ /**
+ * Shopper id will be used to target the recipient
+ */
+ public const SHOPPER_ID = 3;
+}
diff --git a/src/BitPaySDK/Model/Payout/RecipientStatus.php b/src/BitPaySDK/Model/Payout/RecipientStatus.php
new file mode 100644
index 00000000..f0bd70f5
--- /dev/null
+++ b/src/BitPaySDK/Model/Payout/RecipientStatus.php
@@ -0,0 +1,54 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+
+namespace BitPaySDK\Model\Payout;
+
+/**
+ * Interface RecipientStatus
+ *
+ * @package BitPaySDK\Model\Payout
+ * @author BitPay Integrations
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/payouts REST API Payouts
+ */
+interface RecipientStatus
+{
+ /**
+ * Invited recipient status.
+ */
+ public const INVITED = 'invited';
+
+ /**
+ * Unverified recipient status.
+ */
+ public const UNVERIFIED = 'unverified';
+
+ /**
+ * Verified recipient status.
+ */
+
+ public const VERIFIED = 'verified';
+
+ /**
+ * Active recipient status.
+ */
+ public const ACTIVE = 'active';
+
+ /**
+ * Paused recipient status.
+ */
+ public const PAUSED = 'paused';
+
+ /**
+ * Removed recipient status.
+ */
+ public const REMOVED = 'removed';
+}
diff --git a/src/BitPaySDK/Model/Rate/Rate.php b/src/BitPaySDK/Model/Rate/Rate.php
index 4977ca23..f2144196 100644
--- a/src/BitPaySDK/Model/Rate/Rate.php
+++ b/src/BitPaySDK/Model/Rate/Rate.php
@@ -1,50 +1,95 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/rates REST API Rates
+ */
class Rate
{
- protected $_name;
- protected $_code;
- protected $_rate;
+ protected ?string $name = null;
+ protected ?string $code = null;
+ protected ?float $rate = null;
public function __construct()
{
}
- public function getName()
+ /**
+ * Gets detailed currency name
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
{
- return $this->_name;
+ return $this->name;
}
- public function setName(string $name)
+ /**
+ * Sets detailed currency name
+ *
+ * @param string $name the name
+ */
+ public function setName(string $name): void
{
- $this->_name = $name;
+ $this->name = $name;
}
- public function getCode()
+ /**
+ * Gets ISO 4217 3-character currency code
+ *
+ * @return string|null the code
+ */
+ public function getCode(): ?string
{
- return $this->_code;
+ return $this->code;
}
- public function setCode(string $code)
+ /**
+ * Sets ISO 4217 3-character currency code
+ *
+ * @param string $code the code
+ */
+ public function setCode(string $code): void
{
- $this->_code = $code;
+ $this->code = $code;
}
- public function getRate()
+ /**
+ * Gets rate for the requested baseCurrency /currency pair
+ *
+ * @return float|null the rate
+ */
+ public function getRate(): ?float
{
- return $this->_rate;
+ return $this->rate;
}
- public function setRate(float $rate)
+ /**
+ * Sets rate for the requested baseCurrency /currency pair
+ *
+ * @param float $rate the rate
+ */
+ public function setRate(float $rate): void
{
- $this->_rate = $rate;
+ $this->rate = $rate;
}
- public function toArray()
+ /**
+ * Gets Rate as array
+ *
+ * @return array Rate as array
+ */
+ public function toArray(): array
{
$elements = [
'name' => $this->getName(),
@@ -60,4 +105,4 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Rate/Rates.php b/src/BitPaySDK/Model/Rate/Rates.php
index 14f9c807..40877e77 100644
--- a/src/BitPaySDK/Model/Rate/Rates.php
+++ b/src/BitPaySDK/Model/Rate/Rates.php
@@ -1,45 +1,74 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/rates REST API Rates
+ */
class Rates
{
- protected $_bp;
- protected $_rates;
-
- public function __construct(array $rates, Client $bp)
+ /**
+ * @var array Rate[]
+ */
+ protected array $rates;
+
+ /**
+ * Rates constructor.
+ *
+ * @param array $rates Rate[]
+ * @throws BitPayException
+ */
+ public function __construct(array $rates)
{
- $this->_bp = $bp;
- $this->_rates = $rates;
+ $this->validateRates($rates);
+ $this->rates = $rates;
}
- public function getRates()
+ /**
+ * Gets rates.
+ *
+ * @return array Rate[]
+ */
+ public function getRates(): array
{
- $rates = [];
-
- foreach ($this->_rates as $rate) {
- if ($rate instanceof Rate) {
- array_push($rates, $rate->toArray());
- } else {
- array_push($rates, $rate);
- }
- }
-
- return $rates;
+ return $this->rates;
}
- public function update()
+ /**
+ * Update rates.
+ *
+ * @throws BitPayException
+ */
+ public function update(Client $bp): void
{
- $this->_rates = $this->_bp->getRates()->getRates();
+ $rates = $bp->getRates()->getRates();
+ $this->validateRates($rates);
+
+ $this->rates = $rates;
}
- public function getRate(String $currencyCode)
+ /**
+ * Gets rate for the requested currency code.
+ *
+ * @param string $currencyCode 3-character currency code
+ * @return float|null
+ * @throws BitPayException
+ */
+ public function getRate(string $currencyCode): ?float
{
$val = null;
@@ -47,8 +76,8 @@ public function getRate(String $currencyCode)
throw new BitPayException("currency code must be a type of Model.Currency");
}
- foreach ($this->_rates as $rateObj) {
- if ($rateObj->getCode() == $currencyCode) {
+ foreach ($this->rates as $rateObj) {
+ if ($rateObj->getCode() === $currencyCode) {
$val = $rateObj->getRate();
break;
}
@@ -57,7 +86,12 @@ public function getRate(String $currencyCode)
return $val;
}
- public function toArray()
+ /**
+ * Return an array with rates value.
+ *
+ * @return array[]
+ */
+ public function toArray(): array
{
$elements = [
'rates' => $this->getRates(),
@@ -71,4 +105,17 @@ public function toArray()
return $elements;
}
-}
\ No newline at end of file
+
+ /**
+ * @param array $rates
+ * @throws BitPayException
+ */
+ private function validateRates(array $rates): void
+ {
+ foreach ($rates as $rate) {
+ if (!$rate instanceof Rate) {
+ throw new RateException('Array should contains only Rate objects');
+ }
+ }
+ }
+}
diff --git a/src/BitPaySDK/Model/Settlement/InvoiceData.php b/src/BitPaySDK/Model/Settlement/InvoiceData.php
index 7a19529c..43c1b821 100644
--- a/src/BitPaySDK/Model/Settlement/InvoiceData.php
+++ b/src/BitPaySDK/Model/Settlement/InvoiceData.php
@@ -1,130 +1,211 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class InvoiceData
{
- protected $_orderId;
- protected $_date;
- protected $_price;
- protected $_currency;
- protected $_transactionCurrency;
- protected $_overPaidAmount;
- protected $_payoutPercentage;
- protected $_btcPrice;
- /**
- * @var RefundInfo
- */
- protected $_refundInfo;
+ protected ?string $orderId = null;
+ protected ?string $date = null;
+ protected ?float $price = null;
+ protected ?string $currency = null;
+ protected ?string $transactionCurrency = null;
+ protected ?float $overPaidAmount = null;
+ protected ?float $payoutPercentage = null;
+ protected ?RefundInfo $refundInfo = null;
public function __construct()
{
}
- public function getOrderId()
- {
- return $this->_orderId;
- }
-
- public function setOrderId(string $orderId)
- {
- $this->_orderId = $orderId;
- }
-
- public function getDate()
+ /**
+ * Gets Invoice orderId provided during invoice creation.
+ *
+ * @return string|null the order id
+ */
+ public function getOrderId(): ?string
{
- return $this->_date;
+ return $this->orderId;
}
- public function setDate(string $date)
+ /**
+ * Sets Invoice orderId provided during invoice creation.
+ *
+ * @param string $orderId the order id
+ */
+ public function setOrderId(string $orderId): void
{
- $this->_date = $date;
+ $this->orderId = $orderId;
}
- public function getPrice()
+ /**
+ * Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null the date
+ */
+ public function getDate(): ?string
{
- return $this->_price;
+ return $this->date;
}
- public function setPrice(float $price)
+ /**
+ * Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $date the date
+ */
+ public function setDate(string $date): void
{
- $this->_price = $price;
+ $this->date = $date;
}
- public function getCurrency()
+ /**
+ * Gets Invoice price in the invoice original currency
+ *
+ * @return float|null the price
+ */
+ public function getPrice(): ?float
{
- return $this->_currency;
+ return $this->price;
}
- public function setCurrency(string $currency)
+ /**
+ * Sets Invoice price in the invoice original currency
+ *
+ * @param float $price the price
+ */
+ public function setPrice(float $price): void
{
- $this->_currency = $currency;
+ $this->price = $price;
}
- public function getTransactionCurrency()
+ /**
+ * Gets Invoice currency
+ *
+ * @return string|null the Invoice currency
+ */
+ public function getCurrency(): ?string
{
- return $this->_transactionCurrency;
+ return $this->currency;
}
- public function setTransactionCurrency(string $transactionCurrency)
+ /**
+ * Sets Invoice currency
+ *
+ * @param string $currency the Invoice currency
+ */
+ public function setCurrency(string $currency): void
{
- $this->_transactionCurrency = $transactionCurrency;
+ $this->currency = $currency;
}
- public function getOverPaidAmount()
+ /**
+ * Gets Cryptocurrency selected by the consumer when paying the invoice.
+ *
+ * @return string|null the transaction currency
+ */
+ public function getTransactionCurrency(): ?string
{
- return $this->_overPaidAmount;
+ return $this->transactionCurrency;
}
- public function setOverPaidAmount(float $overPaidAmount)
+ /**
+ * Sets Cryptocurrency selected by the consumer when paying the invoice.
+ *
+ * @param string $transactionCurrency the transaction currency
+ */
+ public function setTransactionCurrency(string $transactionCurrency): void
{
- $this->_overPaidAmount = $overPaidAmount;
+ $this->transactionCurrency = $transactionCurrency;
}
- public function getPayoutPercentage()
+ /**
+ * Gets over paid amount
+ *
+ * @return float|null the over paid amount
+ */
+ public function getOverPaidAmount(): ?float
{
- return $this->_payoutPercentage;
+ return $this->overPaidAmount;
}
- public function setPayoutPercentage(float $payoutPercentage)
+ /**
+ * Sets over paid amount
+ *
+ * @param float $overPaidAmount the over paid amount
+ */
+ public function setOverPaidAmount(float $overPaidAmount): void
{
- $this->_payoutPercentage = $payoutPercentage;
+ $this->overPaidAmount = $overPaidAmount;
}
- public function getBtcPrice()
+ /**
+ * Gets The payout percentage defined by the merchant on his BitPay account settings
+ *
+ * @return float|null the payout percentage
+ */
+ public function getPayoutPercentage(): ?float
{
- return $this->_btcPrice;
+ return $this->payoutPercentage;
}
- public function setBtcPrice(float $btcPrice)
+ /**
+ * Sets The payout percentage defined by the merchant on his BitPay account settings
+ *
+ * @param float $payoutPercentage the payout percentage
+ */
+ public function setPayoutPercentage(float $payoutPercentage): void
{
- $this->_btcPrice = $btcPrice;
+ $this->payoutPercentage = $payoutPercentage;
}
- public function getRefundInfo()
+ /**
+ * Gets Object containing information about the refund executed for the invoice
+ *
+ * @return RefundInfo|null
+ */
+ public function getRefundInfo(): ?RefundInfo
{
- return $this->_refundInfo;
+ return $this->refundInfo;
}
- public function setRefundInfo(RefundInfo $refundInfo)
+ /**
+ * Sets Object containing information about the refund executed for the invoice
+ *
+ * @param RefundInfo $refundInfo
+ */
+ public function setRefundInfo(RefundInfo $refundInfo): void
{
- $this->_refundInfo = $refundInfo;
+ $this->refundInfo = $refundInfo;
}
- public function toArray()
+ /**
+ * Gets InvoiceData as array
+ *
+ * @return array InvoiceData as array
+ */
+ public function toArray(): array
{
- $elements = [
- 'orderId' => $this->getOrderId(),
- 'date' => $this->getDate(),
- 'price' => $this->getPrice(),
- 'currency' => $this->getCurrency(),
+ return [
+ 'orderId' => $this->getOrderId(),
+ 'date' => $this->getDate(),
+ 'price' => $this->getPrice(),
+ 'currency' => $this->getCurrency(),
'transactionCurrency' => $this->getTransactionCurrency(),
- 'payoutPercentage' => $this->getPayoutPercentage(),
- 'refundInfo' => $this->getRefundInfo()->toArray(),
+ 'payoutPercentage' => $this->getPayoutPercentage(),
+ 'refundInfo' => $this->getRefundInfo() ? $this->getRefundInfo()->toArray() : null,
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Settlement/PayoutInfo.php b/src/BitPaySDK/Model/Settlement/PayoutInfo.php
index 59981686..21ecbb45 100644
--- a/src/BitPaySDK/Model/Settlement/PayoutInfo.php
+++ b/src/BitPaySDK/Model/Settlement/PayoutInfo.php
@@ -1,295 +1,591 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class PayoutInfo
{
- protected $_name;
- protected $_account;
- protected $_routing;
- protected $_merchantEin;
- protected $_label;
- protected $_bankCountry;
- protected $_bank;
- protected $_swift;
- protected $_address;
- protected $_city;
- protected $_postal;
- protected $_sort;
- protected $_wire;
- protected $_bankName;
- protected $_bankAddress;
- protected $_iban;
- protected $_additionalInformation;
- protected $_accountHolderName;
- protected $_accountHolderAddress;
- protected $_accountHolderAddress2;
- protected $_accountHolderPostalCode;
- protected $_accountHolderCity;
- protected $_accountHolderCountry;
+ protected ?string $name = null;
+ protected ?string $account = null;
+ protected ?string $routing = null;
+ protected ?string $merchantEin = null;
+ protected ?string $label = null;
+ protected ?string $bankCountry = null;
+ protected ?string $bank = null;
+ protected ?string $swift = null;
+ protected ?string $address = null;
+ protected ?string $city = null;
+ protected ?string $postal = null;
+ protected ?string $sort = null;
+ protected ?string $wire = null;
+ protected ?string $bankName = null;
+ protected ?string $bankAddress = null;
+ protected ?string $bankAddress2 = null;
+ protected ?string $iban = null;
+ protected ?string $additionalInformation = null;
+ protected ?string $accountHolderName = null;
+ protected ?string $accountHolderAddress = null;
+ protected ?string $accountHolderAddress2 = null;
+ protected ?string $accountHolderPostalCode = null;
+ protected ?string $accountHolderCity = null;
+ protected ?string $accountHolderCountry = null;
public function __construct()
{
}
- public function getAccount()
+ /**
+ * Gets Bank account number of the merchant
+ *
+ * @return string|null the bank account number
+ */
+ public function getAccount(): ?string
+ {
+ return $this->account;
+ }
+
+ /**
+ * Sets Bank account number of the merchant
+ *
+ * @param string $account the bank account number
+ */
+ public function setAccount(string $account): void
{
- return $this->_account;
+ $this->account = $account;
}
- public function setAccount(string $account)
+ /**
+ * Gets routing
+ *
+ * for merchants receiving USD settlements via local ACH, this field contains the ABA provided by the merchant
+ *
+ * @return string|null the routing
+ */
+ public function getRouting(): ?string
{
- $this->_account = $account;
+ return $this->routing;
}
- public function getRouting()
+ /**
+ * Sets routing
+ *
+ * @param string $routing the routing
+ */
+ public function setRouting(string $routing): void
{
- return $this->_routing;
+ $this->routing = $routing;
}
- public function setRouting(string $routing)
+ /**
+ * Gets merchant ein
+ *
+ * for merchants receiving USD settlements via local ACH, this field contains the merchant's EIN
+ *
+ * @return string|null the merchant ein
+ */
+ public function getMerchantEin(): ?string
{
- $this->_routing = $routing;
+ return $this->merchantEin;
}
- public function getMerchantEin()
+ /**
+ * Sets merchant ein
+ *
+ * @param string $merchantEin the merchant ein
+ */
+ public function setMerchantEin(string $merchantEin): void
{
- return $this->_merchantEin;
+ $this->merchantEin = $merchantEin;
}
- public function setMerchantEin(string $merchantEin)
+ /**
+ * Gets label
+ *
+ * As indicated by the merchant in his settlement settings
+ *
+ * @return string|null the label
+ */
+ public function getLabel(): ?string
{
- $this->_merchantEin = $merchantEin;
+ return $this->label;
}
-////////////////////////////////////////////////////////////////////////////////////////
- public function getLabel()
+ /**
+ * Sets label
+ *
+ * @param string $label the label
+ */
+ public function setLabel(string $label): void
{
- return $this->_label;
+ $this->label = $label;
}
- public function setLabel(string $label)
+ /**
+ * Gets Country where the merchant's bank account is located
+ *
+ * @return string|null the bank country
+ */
+ public function getBankCountry(): ?string
{
- $this->_label = $label;
+ return $this->bankCountry;
}
- public function getBankCountry()
+ /**
+ * Sets Country where the merchant's bank account is located
+ *
+ * @param string $bankCountry the bank country
+ */
+ public function setBankCountry(string $bankCountry): void
{
- return $this->_bankCountry;
+ $this->bankCountry = $bankCountry;
}
- public function setBankCountry(string $bankCountry)
+ /**
+ * Gets account holder name
+ *
+ * @return string|null the name
+ */
+ public function getName(): ?string
{
- $this->_bankCountry = $bankCountry;
+ return $this->name;
}
- public function getName()
+ /**
+ * Sets account holder name
+ *
+ * @param string $name the name
+ */
+ public function setName(string $name): void
{
- return $this->_name;
+ $this->name = $name;
}
- public function setName(string $name)
+ /**
+ * Gets Name of the bank used by the merchant
+ *
+ * @return string|null the bank
+ */
+ public function getBank(): ?string
{
- $this->_name = $name;
+ return $this->bank;
}
- public function getBank()
+ /**
+ * Sets Name of the bank used by the merchant
+ *
+ * @param string $bank the bank
+ */
+ public function setBank(string $bank): void
{
- return $this->_bank;
+ $this->bank = $bank;
}
- public function setBank(string $bank)
+ /**
+ * Gets SWIFT/BIC code of the merchant's bank.
+ *
+ * @return string|null the swift
+ */
+ public function getSwift(): ?string
{
- $this->_bank = $bank;
+ return $this->swift;
}
- public function getSwift()
+ /**
+ * Sets SWIFT/BIC code of the merchant's bank.
+ *
+ * @param string $swift the swift
+ */
+ public function setSwift(string $swift): void
{
- return $this->_swift;
+ $this->swift = $swift;
}
- public function setSwift(string $swift)
+ /**
+ * Gets address
+ *
+ * This field is used to indicate the wallet address used for the settlement,
+ * if the settlement currency selected by the merchant is one of the supported crypto currency:
+ * Bitcoin (BTC), Bitcoin Cash (BCH), Dogecoin (DOGE), Ether (ETH), Gemini US Dollar (GUSD),
+ * Circle USD Coin (USDC), Paxos Standard USD (PAX), Binance USD (BUSD), Dai (DAI), Wrapped Bitcoin (WBTC),
+ * and Ripple (XRP). If the settlement currency used is AUD, GBP, NZD, MXN, ZAR -
+ * this field is used to indicate the address of the merchant's bank
+ *
+ * @return string|null the address
+ */
+ public function getAddress(): ?string
{
- $this->_swift = $swift;
+ return $this->address;
}
- public function getAddress()
+ /**
+ * Sets address
+ *
+ * @param string $address the address
+ */
+ public function setAddress(string $address): void
{
- return $this->_address;
+ $this->address = $address;
}
- public function setAddress(string $address)
+ /**
+ * Gets City of the merchant bank, field return if the settlement currency is
+ *
+ * @return string|null the city
+ */
+ public function getCity(): ?string
{
- $this->_address = $address;
+ return $this->city;
}
- public function getCity()
+ /**
+ * Sets city of the merchant bank
+ *
+ * @param string $city the city
+ */
+ public function setCity(string $city): void
{
- return $this->_city;
+ $this->city = $city;
}
- public function setCity(string $city)
+ /**
+ * Gets Postal code of the merchant bank, field return if the settlement currency is
+ *
+ * @return string|null the postal
+ */
+ public function getPostal(): ?string
{
- $this->_city = $city;
+ return $this->postal;
}
- public function getPostal()
+ /**
+ * Sets Postal code of the merchant bank
+ *
+ * @param string $postal the postal
+ */
+ public function setPostal(string $postal): void
{
- return $this->_postal;
+ $this->postal = $postal;
}
- public function setPostal(string $postal)
+ /**
+ * Gets sort
+ *
+ * used to pass country specific bank fields: BSB for AUD
+ *
+ * @return string|null
+ */
+ public function getSort(): ?string
{
- $this->_postal = $postal;
+ return $this->sort;
}
- public function getSort()
+ /**
+ * Sets sort
+ *
+ * @param string $sort the sort
+ */
+ public function setSort(string $sort): void
{
- return $this->_sort;
+ $this->sort = $sort;
}
- public function setSort(string $sort)
+ /**
+ * Gets wire
+ *
+ * If set to true, this means BitPay will be settling the account using an international transfer via the SWIFT
+ * network instead of local settlement methods like ACH(United States) or SEPA (European Economic Area)
+ *
+ * @return string|null the wire
+ */
+ public function getWire(): ?string
{
- $this->_sort = $sort;
+ return $this->wire;
}
- public function getWire()
+ /**
+ * Sets wire
+ *
+ * @param string $wire the wire
+ */
+ public function setWire(string $wire): void
{
- return $this->_wire;
+ $this->wire = $wire;
}
- public function setWire(string $wire)
+ /**
+ * Gets bank name
+ *
+ * Name of the bank used by the merchant. Field returned if "wire": true in the "payoutInfo" object
+ *
+ * @return string|null the bank name
+ */
+ public function getBankName(): ?string
{
- $this->_wire = $wire;
+ return $this->bankName;
}
- public function getBankName()
+ /**
+ * Sets bank name
+ *
+ * @param string $bankName the bank name
+ */
+ public function setBankName(string $bankName): void
{
- return $this->_bankName;
+ $this->bankName = $bankName;
}
- public function setBankName(string $bankName)
+ /**
+ * Gets bank address
+ *
+ * Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object
+ *
+ * @return string|null the bank address
+ */
+ public function getBankAddress(): ?string
{
- $this->_bankName = $bankName;
+ return $this->bankAddress;
}
- public function getBankAddress()
+ /**
+ * Sets bank address
+ *
+ * @param string $bankAddress the bank address
+ */
+ public function setBankAddress(string $bankAddress): void
{
- return $this->_bankAddress;
+ $this->bankAddress = $bankAddress;
}
- public function setBankAddress(string $bankAddress)
+ /**
+ * Gets bank address 2
+ *
+ * Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object
+ *
+ * @return string|null the bank address2
+ */
+ public function getBankAddress2(): ?string
{
- $this->_bankAddress = $bankAddress;
+ return $this->bankAddress2;
}
- public function getIban()
+ /**
+ * Sets bank address2
+ *
+ * @param string $bankAddress2 the bank address2
+ */
+ public function setBankAddress2(string $bankAddress2): void
{
- return $this->_iban;
+ $this->bankAddress2 = $bankAddress2;
}
- public function setIban(string $iban)
+ /**
+ * Gets iban
+ *
+ * The merchant's bank account number, in the IBAN (International Bank Account Number) format.
+ * Field returned if "wire": true in the "payoutInfo" object
+ *
+ * @return string|null the iban
+ */
+ public function getIban(): ?string
{
- $this->_iban = $iban;
+ return $this->iban;
}
- public function getAdditionalInformation()
+ /**
+ * Sets iban
+ *
+ * @param string $iban the iban
+ * @return void
+ */
+ public function setIban(string $iban): void
{
- return $this->_additionalInformation;
+ $this->iban = $iban;
}
- public function setAdditionalInformation(string $additionalInformation)
+ /**
+ * Gets additional information
+ *
+ * When providing the settlement info via the dashboard, this field can be used by the merchant to provide
+ * additional information about the receiving bank. Field returned if "wire": true in the "payoutInfo" object
+ *
+ * @return string|null the additional information
+ */
+ public function getAdditionalInformation(): ?string
{
- $this->_additionalInformation = $additionalInformation;
+ return $this->additionalInformation;
}
- public function getAccountHolderName()
+ /**
+ * Sets additional information
+ *
+ * @param string $additionalInformation the additional information
+ */
+ public function setAdditionalInformation(string $additionalInformation): void
{
- return $this->_accountHolderName;
+ $this->additionalInformation = $additionalInformation;
}
- public function setAccountHolderName(string $accountHolderName)
+ /**
+ * Gets Bank account holder name
+ *
+ * @return string|null the bank account holder name
+ */
+ public function getAccountHolderName(): ?string
{
- $this->_accountHolderName = $accountHolderName;
+ return $this->accountHolderName;
}
- public function getAccountHolderAddress()
+ /**
+ * Sets Bank account holder name
+ *
+ * @param string $accountHolderName the bank account holder name
+ */
+ public function setAccountHolderName(string $accountHolderName): void
{
- return $this->_accountHolderAddress;
+ $this->accountHolderName = $accountHolderName;
}
- public function setAccountHolderAddress(string $accountHolderAddress)
+ /**
+ * Gets Bank account holder address
+ *
+ * @return string|null the bank account holder address
+ */
+ public function getAccountHolderAddress(): ?string
{
- $this->_accountHolderAddress = $accountHolderAddress;
+ return $this->accountHolderAddress;
}
- public function getAccountHolderAddress2()
+ /**
+ * Sets Bank account holder address2
+ *
+ * @param string $accountHolderAddress the bank account holder address
+ */
+ public function setAccountHolderAddress(string $accountHolderAddress): void
{
- return $this->_accountHolderAddress2;
+ $this->accountHolderAddress = $accountHolderAddress;
}
- public function setAccountHolderAddress2(string $accountHolderAddress2)
+ /**
+ * Gets Bank account holder address2
+ *
+ * @return string|null the bank account holder address2
+ */
+ public function getAccountHolderAddress2(): ?string
{
- $this->_accountHolderAddress2 = $accountHolderAddress2;
+ return $this->accountHolderAddress2;
}
- public function getAccountHolderPostalCode()
+ /**
+ * Sets Bank account holder address2
+ *
+ * @param string $accountHolderAddress2 the bank account holder address2
+ */
+ public function setAccountHolderAddress2(string $accountHolderAddress2): void
{
- return $this->_accountHolderPostalCode;
+ $this->accountHolderAddress2 = $accountHolderAddress2;
}
- public function setAccountHolderPostalCode(string $accountHolderPostalCode)
+ /**
+ * Gets Bank account holder postal code
+ *
+ * @return string|null the bank account holder postal code
+ */
+ public function getAccountHolderPostalCode(): ?string
{
- $this->_accountHolderPostalCode = $accountHolderPostalCode;
+ return $this->accountHolderPostalCode;
}
- public function getAccountHolderCity()
+ /**
+ * Sets Bank account holder postal code
+ *
+ * @param string $accountHolderPostalCode the bank account holder postal code
+ */
+ public function setAccountHolderPostalCode(string $accountHolderPostalCode): void
{
- return $this->_accountHolderCity;
+ $this->accountHolderPostalCode = $accountHolderPostalCode;
}
- public function setAccountHolderCity(string $accountHolderCity)
+ /**
+ * Gets Bank account holder city
+ *
+ * @return string|null the bank account holder city
+ */
+ public function getAccountHolderCity(): ?string
{
- $this->_accountHolderCity = $accountHolderCity;
+ return $this->accountHolderCity;
}
- public function getAccountHolderCountry()
+ /**
+ * Sets Bank account holder city
+ *
+ * @param string $accountHolderCity the bank account holder city
+ */
+ public function setAccountHolderCity(string $accountHolderCity): void
{
- return $this->_accountHolderCountry;
+ $this->accountHolderCity = $accountHolderCity;
}
- public function setAccountHolderCountry(string $accountHolderCountry)
+ /**
+ * Gets Bank account holder country
+ *
+ * @return string|null the bank account holder country
+ */
+ public function getAccountHolderCountry(): ?string
{
- $this->_accountHolderCountry = $accountHolderCountry;
+ return $this->accountHolderCountry;
}
- public function toArray()
+ /**
+ * Sets Bank account holder country
+ *
+ * @param string $accountHolderCountry the bank account holder country
+ */
+ public function setAccountHolderCountry(string $accountHolderCountry): void
{
- $elements = [
- 'label' => $this->getLabel(),
- 'bankCountry' => $this->getBankCountry(),
- 'name' => $this->getName(),
- 'bank' => $this->getBank(),
- 'swift' => $this->getSwift(),
- 'address' => $this->getAddress(),
- 'city' => $this->getCity(),
- 'postal' => $this->getPostal(),
- 'sort' => $this->getSort(),
- 'wire' => $this->getWire(),
- 'bankName' => $this->getBankName(),
- 'bankAddress' => $this->getBankAddress(),
- 'iban' => $this->getIban(),
- 'additionalInformation' => $this->getAdditionalInformation(),
- 'accountHolderName' => $this->getAccountHolderName(),
- 'accountHolderAddress' => $this->getAccountHolderAddress(),
- 'accountHolderAddress2' => $this->getAccountHolderAddress2(),
+ $this->accountHolderCountry = $accountHolderCountry;
+ }
+
+ /**
+ * Gets PayoutInfo as array
+ *
+ * @return array PayoutInfo as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'label' => $this->getLabel(),
+ 'bankCountry' => $this->getBankCountry(),
+ 'name' => $this->getName(),
+ 'bank' => $this->getBank(),
+ 'swift' => $this->getSwift(),
+ 'address' => $this->getAddress(),
+ 'city' => $this->getCity(),
+ 'postal' => $this->getPostal(),
+ 'sort' => $this->getSort(),
+ 'wire' => $this->getWire(),
+ 'bankName' => $this->getBankName(),
+ 'bankAddress' => $this->getBankAddress(),
+ 'iban' => $this->getIban(),
+ 'additionalInformation' => $this->getAdditionalInformation(),
+ 'accountHolderName' => $this->getAccountHolderName(),
+ 'accountHolderAddress' => $this->getAccountHolderAddress(),
+ 'accountHolderAddress2' => $this->getAccountHolderAddress2(),
'accountHolderPostalCode' => $this->getAccountHolderPostalCode(),
- 'accountHolderCity' => $this->getAccountHolderCity(),
- 'accountHolderCountry' => $this->getAccountHolderCountry(),
+ 'accountHolderCity' => $this->getAccountHolderCity(),
+ 'accountHolderCountry' => $this->getAccountHolderCountry(),
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Settlement/RefundInfo.php b/src/BitPaySDK/Model/Settlement/RefundInfo.php
index 1255ae8b..74a7e673 100644
--- a/src/BitPaySDK/Model/Settlement/RefundInfo.php
+++ b/src/BitPaySDK/Model/Settlement/RefundInfo.php
@@ -1,57 +1,136 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class RefundInfo
{
- protected $_supportRequest;
- protected $_currency;
- protected $_amounts;
+ protected ?string $supportRequest = null;
+ protected ?string $currency = null;
+ protected ?array $amounts = null;
+ protected ?string $refundRequestEid = null;
public function __construct()
{
}
- public function getSupportRequest()
+ /**
+ * Gets support request.
+ *
+ * BitPay support request ID associated to the refund
+ *
+ * @return string|null the support request
+ */
+ public function getSupportRequest(): ?string
+ {
+ return $this->supportRequest;
+ }
+
+ /**
+ * Sets support request.
+ *
+ * BitPay support request ID associated to the refund
+ *
+ * @param string $supportRequest the support request
+ */
+ public function setSupportRequest(string $supportRequest): void
{
- return $this->_supportRequest;
+ $this->supportRequest = $supportRequest;
}
- public function setSupportRequest(string $supportRequest)
+ /**
+ * Gets currency.
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the settlement.
+ * Supported settlement currencies are listed on Settlement Docs
+ *
+ * @return string|null
+ */
+ public function getCurrency(): ?string
{
- $this->_supportRequest = $supportRequest;
+ return $this->currency;
}
- public function getCurrency()
+ /**
+ * Sets currency.
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the settlement.
+ * Supported settlement currencies are listed on Settlement Docs
+ *
+ * @param string $currency the currency
+ */
+ public function setCurrency(string $currency): void
{
- return $this->_currency;
+ $this->currency = $currency;
}
- public function setCurrency(string $currency)
+ /**
+ * Gets amounts.
+ *
+ * This object will contain the crypto currency amount refunded by BitPay to the consumer
+ *
+ * @return array|null
+ */
+ public function getAmounts(): ?array
{
- $this->_currency = $currency;
+ return $this->amounts;
}
- public function getAmounts()
+ /**
+ * Sets amounts.
+ *
+ * @param array $amounts
+ */
+ public function setAmounts(array $amounts): void
{
- return $this->_amounts;
+ $this->amounts = $amounts;
}
- public function setAmounts(array $amounts)
+ /**
+ * Gets Refund Request Eid.
+ *
+ * @return string Request Eid
+ */
+ public function getRefundRequestEid(): ?string
{
- $this->_amounts = $amounts;
+ return $this->refundRequestEid;
}
- public function toArray()
+ /**
+ * Sets Refund Request Eid.
+ *
+ * @param string|null Refund Request Eid
+ */
+ public function setRefundRequestEid(?string $refundRequestEid): void
{
- $elements = [
+ $this->refundRequestEid = $refundRequestEid;
+ }
+
+ /**
+ * Gets Refund info as array
+ *
+ * @return array refund info as array
+ */
+ public function toArray(): array
+ {
+ return [
'supportRequest' => $this->getSupportRequest(),
- 'currency' => $this->getCurrency(),
- 'amounts' => $this->getAmounts(),
+ 'currency' => $this->getCurrency(),
+ 'amounts' => $this->getAmounts(),
+ 'refundRequestEid' => $this->getRefundRequestEid()
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Settlement/Settlement.php b/src/BitPaySDK/Model/Settlement/Settlement.php
index 34fd7176..efd5947a 100644
--- a/src/BitPaySDK/Model/Settlement/Settlement.php
+++ b/src/BitPaySDK/Model/Settlement/Settlement.php
@@ -1,246 +1,501 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class Settlement
{
- protected $_id;
- protected $_accountId;
- protected $_currency;
- protected $_payoutInfo;
- protected $_status;
- protected $_dateCreated;
- protected $_dateExecuted;
- protected $_dateCompleted;
- protected $_openingDate;
- protected $_closingDate;
- protected $_openingBalance;
- protected $_ledgerEntriesSum;
- protected $_withHoldings;
- protected $_withHoldingsSum;
- protected $_totalAmount;
- protected $_ledgerEntries;
- protected $_token;
+ protected ?string $id = null;
+ protected ?string $accountId = null;
+ protected ?string $currency = null;
+ protected ?PayoutInfo $payoutInfo = null;
+ protected ?string $status = null;
+ protected ?string $dateCreated = null;
+ protected ?string $dateExecuted = null;
+ protected ?string $dateCompleted = null;
+ protected ?string $openingDate = null;
+ protected ?string $closingDate = null;
+ protected ?float $openingBalance = null;
+ protected ?float $ledgerEntriesSum = null;
+ protected array $withHoldings = [];
+ protected ?float $withHoldingsSum = null;
+ protected ?float $totalAmount = null;
+ protected array $ledgerEntries = [];
+ protected ?string $token = null;
public function __construct()
{
}
- public function getId()
- {
- return $this->_id;
- }
-
- public function setId(String $id)
- {
- $this->_id = $id;
- }
-
- public function getAccountId()
- {
- return $this->_accountId;
- }
-
- public function setAccountId(String $accountId)
- {
- $this->_accountId = $accountId;
- }
-
- public function getCurrency()
- {
- return $this->_currency;
- }
-
- public function setCurrency(String $currency)
- {
- $this->_currency = $currency;
- }
-
- public function getPayoutInfo()
+ /**
+ * Gets id
+ *
+ * String identifying the settlement; this id will also be in the description of the corresponding bank settlement.
+ *
+ * @return string|null
+ */
+ public function getId(): ?string
{
- return $this->_payoutInfo;
+ return $this->id;
}
- public function setPayoutInfo(PayoutInfo $payoutInfo)
+ /**
+ * Sets id
+ *
+ * String identifying the settlement; this id will also be in the description of the corresponding bank settlement.
+ *
+ * @param string $id
+ */
+ public function setId(string $id): void
{
- $this->_payoutInfo = $payoutInfo;
+ $this->id = $id;
}
- public function getStatus()
+ /**
+ * Gets account id
+ *
+ * String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.
+ *
+ * @return string|null
+ */
+ public function getAccountId(): ?string
{
- return $this->_status;
+ return $this->accountId;
}
- public function setStatus(String $status)
+ /**
+ * Sets account id
+ *
+ * String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.
+ *
+ * @param string $accountId
+ */
+ public function setAccountId(string $accountId): void
{
- $this->_status = $status;
+ $this->accountId = $accountId;
}
- public function getDateCreated()
+ /**
+ * Gets currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the settlement.
+ * Supported settlement currencies are listed on https://bitpay.com/docs/settlement
+ *
+ * @return string|null
+ */
+ public function getCurrency(): ?string
{
- return $this->_dateCreated;
+ return $this->currency;
}
- public function setDateCreated(string $dateCreated)
+ /**
+ * Sets currency
+ *
+ * ISO 4217 3-character currency code. This is the currency associated with the settlement.
+ * Supported settlement currencies are listed on https://bitpay.com/docs/settlement
+ *
+ * @param string $currency
+ */
+ public function setCurrency(string $currency): void
{
- $this->_dateCreated = $dateCreated;
+ $this->currency = $currency;
}
- public function getDateExecuted()
+ /**
+ * Gets Object containing the settlement info provided by the Merchant in his BitPay account settings
+ *
+ * @return PayoutInfo|null
+ */
+ public function getPayoutInfo(): ?PayoutInfo
{
- return $this->_dateExecuted;
+ return $this->payoutInfo;
}
- public function setDateExecuted(string $dateExecuted)
+ /**
+ * Sets Object containing the settlement info provided by the Merchant in his BitPay account settings
+ *
+ * @param PayoutInfo $payoutInfo
+ */
+ public function setPayoutInfo(PayoutInfo $payoutInfo): void
{
- $this->_dateExecuted = $dateExecuted;
+ $this->payoutInfo = $payoutInfo;
}
- public function getDateCompleted()
+ /**
+ * Gets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+ *
+ * @return string|null
+ */
+ public function getStatus(): ?string
{
- return $this->_dateCompleted;
+ return $this->status;
}
- public function setDateCompleted(string $dateCompleted)
+ /**
+ * Sets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
+ *
+ * @param string $status
+ */
+ public function setStatus(string $status): void
{
- $this->_dateCompleted = $dateCompleted;
+ $this->status = $status;
}
- public function getOpeningDate()
+ /**
+ * Gets date created
+ *
+ * Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null
+ */
+ public function getDateCreated(): ?string
{
- return $this->_openingDate;
+ return $this->dateCreated;
}
- public function setOpeningDate(string $openingDate)
+ /**
+ * Sets date created
+ *
+ * Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $dateCreated
+ */
+ public function setDateCreated(string $dateCreated): void
{
- $this->_openingDate = $openingDate;
+ $this->dateCreated = $dateCreated;
}
- public function getClosingDate()
+ /**
+ * Gets date executed
+ *
+ * Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null
+ */
+ public function getDateExecuted(): ?string
{
- return $this->_closingDate;
+ return $this->dateExecuted;
}
- public function setClosingDate(string $closingDate)
+ /**
+ * Sets date executed
+ *
+ * Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $dateExecuted
+ */
+ public function setDateExecuted(string $dateExecuted): void
{
- $this->_closingDate = $closingDate;
+ $this->dateExecuted = $dateExecuted;
}
- public function getOpeningBalance()
+ /**
+ * Gets date completed
+ *
+ * Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null
+ */
+ public function getDateCompleted(): ?string
{
- return $this->_openingBalance;
+ return $this->dateCompleted;
}
- public function setOpeningBalance(float $openingBalance)
+ /**
+ * Sets date completed
+ *
+ * Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $dateCompleted
+ */
+ public function setDateCompleted(string $dateCompleted): void
{
- $this->_openingBalance = $openingBalance;
+ $this->dateCompleted = $dateCompleted;
}
- public function getLedgerEntriesSum()
+ /**
+ * Gets opening date
+ *
+ * corresponds to the closingDate of the previous settlement executed.
+ * For the first settlement of an account the value will be the BitPay merchant account creation date.
+ * UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null
+ */
+ public function getOpeningDate(): ?string
{
- return $this->_ledgerEntriesSum;
+ return $this->openingDate;
}
- public function setLedgerEntriesSum(float $ledgerEntriesSum)
- {
- $this->_ledgerEntriesSum = $ledgerEntriesSum;
- }
+ /**
+ * Sets opening date
+ *
+ * corresponds to the closingDate of the previous settlement executed.
+ * For the first settlement of an account the value will be the BitPay merchant account creation date.
+ * UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $openingDate
+ */
+ public function setOpeningDate(string $openingDate): void
+ {
+ $this->openingDate = $openingDate;
+ }
+
+ /**
+ * Gets closing date.
+ *
+ * Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null
+ */
+ public function getClosingDate(): ?string
+ {
+ return $this->closingDate;
+ }
+
+ /**
+ * Sets closing date.
+ *
+ * Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $closingDate
+ */
+ public function setClosingDate(string $closingDate): void
+ {
+ $this->closingDate = $closingDate;
+ }
+
+ /**
+ * Gets Balance of the ledger at the openingDate
+ *
+ * @return float|null
+ */
+ public function getOpeningBalance(): ?float
+ {
+ return $this->openingBalance;
+ }
+
+ /**
+ * Sets Balance of the ledger at the openingDate
+ *
+ * @param float $openingBalance
+ */
+ public function setOpeningBalance(float $openingBalance): void
+ {
+ $this->openingBalance = $openingBalance;
+ }
+
+ /**
+ * Gets ledger entries sum.
+ *
+ * Sum of all ledger entries in the settlement, this means all the debits & credits
+ * which happened between openingDate and closingDate
+ *
+ * @return float|null
+ */
+ public function getLedgerEntriesSum(): ?float
+ {
+ return $this->ledgerEntriesSum;
+ }
+
+ /**
+ * Sets ledger entries sum.
+ *
+ * Sum of all ledger entries in the settlement, this means all the debits & credits
+ * which happened between openingDate and closingDate
+ *
+ * @param float $ledgerEntriesSum
+ */
+ public function setLedgerEntriesSum(float $ledgerEntriesSum): void
+ {
+ $this->ledgerEntriesSum = $ledgerEntriesSum;
+ }
+
+ /**
+ * Gets with holdings
+ *
+ * Array of withholdings. Withholdings are kept on the ledger to be used later and thus withheld
+ * from this settlement. Each withholding is a JSON object containing a code, amount and description field.
+ *
+ * @return WithHoldings[]
+ */
+ public function getWithHoldings(): array
+ {
+ return $this->withHoldings;
+ }
- public function getWithHoldings()
- {
- $withHoldings = [];
-
- foreach ($this->_withHoldings as $withHolding) {
- if ($withHolding instanceof WithHoldings) {
- array_push($withHoldings, $withHolding->toArray());
- } else {
- array_push($withHoldings, $withHolding);
+ /**
+ * Sets with holdings
+ *
+ * Array of withholdings. Withholdings are kept on the ledger to be used later and thus withheld
+ * from this settlement. Each withholding is a JSON object containing a code, amount and description field.
+ *
+ * @param WithHoldings[] $withHoldings
+ * @throws SettlementException
+ */
+ public function setWithHoldings(array $withHoldings): void
+ {
+ foreach ($withHoldings as $withHolding) {
+ if (!$withHolding instanceof WithHoldings) {
+ throw new SettlementException('Array should contains only WithHoldings objects');
}
}
- return $withHoldings;
+ $this->withHoldings = $withHoldings;
}
- public function setWithHoldings(array $withHoldings)
+ /**
+ * Gets Sum of all amounts that are withheld from settlement
+ *
+ * @return float|null
+ */
+ public function getWithHoldingsSum(): ?float
{
- $this->_withHoldings = $withHoldings;
+ return $this->withHoldingsSum;
}
- public function getWithHoldingsSum()
+ /**
+ * Sets Sum of all amounts that are withheld from settlement
+ *
+ * @param float $withHoldingsSum
+ */
+ public function setWithHoldingsSum(float $withHoldingsSum): void
{
- return $this->_withHoldingsSum;
+ $this->withHoldingsSum = $withHoldingsSum;
}
- public function setWithHoldingsSum(float $withHoldingsSum)
+ /**
+ * Gets total amount sent to the merchant; 2 decimals.
+ *
+ * totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum
+ *
+ * @return float|null
+ */
+ public function getTotalAmount(): ?float
{
- $this->_withHoldingsSum = $withHoldingsSum;
+ return $this->totalAmount;
}
- public function getTotalAmount()
+ /**
+ * Sets total amount sent to the merchant; 2 decimals.
+ *
+ * totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum
+ *
+ * @param float $totalAmount
+ */
+ public function setTotalAmount(float $totalAmount): void
{
- return $this->_totalAmount;
+ $this->totalAmount = $totalAmount;
}
- public function setTotalAmount(float $totalAmount)
+ /**
+ * Gets Array of ledger entries listing the various debits and credits which are settled in the report.
+ *
+ * The total sum of all ledger entries is reported in the field ledgerEntriesSum.
+ * A description of all ledger codes can be found
+ *
+ * @return SettlementLedgerEntry[]
+ */
+ public function getLedgerEntries(): array
{
- $this->_totalAmount = $totalAmount;
+ return $this->ledgerEntries;
}
- public function getLedgerEntries()
+ /**
+ * Sets Array of ledger entries listing the various debits and credits which are settled in the report.
+ *
+ * The total sum of all ledger entries is reported in the field ledgerEntriesSum.
+ * A description of all ledger codes can be found
+ *
+ * @param SettlementLedgerEntry[] $ledgerEntries
+ * @throws SettlementException
+ */
+ public function setLedgerEntries(array $ledgerEntries): void
{
- $ledgerEntries = [];
-
- foreach ($this->_ledgerEntries as $ledgerEntrie) {
- if ($ledgerEntrie instanceof SettlementLedgerEntry) {
- array_push($ledgerEntries, $ledgerEntrie->toArray());
- } else {
- array_push($ledgerEntries, $ledgerEntrie);
+ foreach ($ledgerEntries as $ledgerEntry) {
+ if (!$ledgerEntry instanceof SettlementLedgerEntry) {
+ throw new SettlementException('Array should contains only SettlementLedgerEntry objects');
}
}
-
- return $ledgerEntries;
+ $this->ledgerEntries = $ledgerEntries;
}
- public function setLedgerEntries(array $ledgerEntries)
+ /**
+ * Gets API token for the corresponding settlement resource.
+ *
+ * This token is actually derived from the merchant facade token used during the query.
+ * This token is required to fetch the reconciliation report
+ *
+ * @return string|null
+ */
+ public function getToken(): ?string
{
- $this->_ledgerEntries = $ledgerEntries;
+ return $this->token;
}
- public function getToken()
+ /**
+ * Sets API token for the corresponding settlement resource.
+ *
+ * This token is actually derived from the merchant facade token used during the query.
+ * This token is required to fetch the reconciliation report
+ *
+ * @param string $token
+ */
+ public function setToken(string $token): void
{
- return $this->_token;
+ $this->token = $token;
}
- public function setToken(String $token)
+ /**
+ * Returns the Settlement object as array
+ *
+ * @return array
+ */
+ public function toArray(): array
{
- $this->_token = $token;
- }
+ $ledgerEntries = [];
+ foreach ($this->getLedgerEntries() as $item) {
+ $ledgerEntries[] = $item->toArray();
+ }
- public function toArray()
- {
- $elements =
- [
- 'id' => $this->getId(),
- 'accountId' => $this->getAccountId(),
- 'currency' => $this->getCurrency(),
- 'payoutInfo' => $this->getPayoutInfo(),
- 'status' => $this->getStatus(),
- 'dateCreated' => $this->getDateCreated(),
- 'dateExecuted' => $this->getDateExecuted(),
- 'dateCompleted' => $this->getDateCompleted(),
- 'openingDate' => $this->getOpeningDate(),
- 'closingDate' => $this->getClosingDate(),
- 'openingBalance' => $this->getOpeningBalance(),
- 'ledgerEntriesSum' => $this->getLedgerEntriesSum(),
- 'withHoldings' => $this->getWithHoldings(),
- 'withHoldingsSum' => $this->getWithHoldingsSum(),
- 'totalAmount' => $this->getTotalAmount(),
- 'ledgerEntries' => $this->getLedgerEntries(),
- 'token' => $this->getToken(),
- ];
+ $withHoldings = [];
+ foreach ($this->getWithHoldings() as $withHolding) {
+ $withHoldings[] = $withHolding->toArray();
+ }
- return $elements;
- }
-}
\ No newline at end of file
+ return [
+ 'id' => $this->getId(),
+ 'accountId' => $this->getAccountId(),
+ 'currency' => $this->getCurrency(),
+ 'payoutInfo' => $this->getPayoutInfo(),
+ 'status' => $this->getStatus(),
+ 'dateCreated' => $this->getDateCreated(),
+ 'dateExecuted' => $this->getDateExecuted(),
+ 'dateCompleted' => $this->getDateCompleted(),
+ 'openingDate' => $this->getOpeningDate(),
+ 'closingDate' => $this->getClosingDate(),
+ 'openingBalance' => $this->getOpeningBalance(),
+ 'ledgerEntriesSum' => $this->getLedgerEntriesSum(),
+ 'withHoldings' => $withHoldings,
+ 'withHoldingsSum' => $this->getWithHoldingsSum(),
+ 'totalAmount' => $this->getTotalAmount(),
+ 'ledgerEntries' => $ledgerEntries,
+ 'token' => $this->getToken(),
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Settlement/SettlementLedgerEntry.php b/src/BitPaySDK/Model/Settlement/SettlementLedgerEntry.php
index e20afc39..94d137a1 100644
--- a/src/BitPaySDK/Model/Settlement/SettlementLedgerEntry.php
+++ b/src/BitPaySDK/Model/Settlement/SettlementLedgerEntry.php
@@ -1,106 +1,207 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class SettlementLedgerEntry
{
- protected $_code;
- protected $_invoiceId;
- protected $_amount;
- protected $_timestamp;
- protected $_description;
- protected $_reference;
- protected $_invoiceData;
+ protected ?int $code = null;
+ protected ?string $invoiceId = null;
+ protected ?float $amount = null;
+ protected ?string $timestamp = null;
+ protected ?string $description = null;
+ protected ?string $reference = null;
+ protected InvoiceData $invoiceData;
public function __construct()
{
- $this->_invoiceData = new InvoiceData();
+ $this->invoiceData = new InvoiceData();
}
- public function getCode()
+ /**
+ * Gets code
+ *
+ * Contains the Ledger entry code
+ *
+ * @return int|null the code
+ */
+ public function getCode(): ?int
{
- return $this->_code;
+ return $this->code;
}
- public function setCode(int $code)
+ /**
+ * Sets code
+ *
+ * Contains the Ledger entry code
+ *
+ * @param int $code the code
+ */
+ public function setCode(int $code): void
{
- $this->_code = $code;
+ $this->code = $code;
}
- public function getInvoiceId()
+ /**
+ * Gets BitPay invoice Id
+ *
+ * @return string|null BitPay invoice Id
+ */
+ public function getInvoiceId(): ?string
{
- return $this->_invoiceId;
+ return $this->invoiceId;
}
- public function setInvoiceId(string $invoiceId)
+ /**
+ * Sets BitPay invoice Id
+ *
+ * @param string $invoiceId BitPay invoice Id
+ */
+ public function setInvoiceId(string $invoiceId): void
{
- $this->_invoiceId = $invoiceId;
+ $this->invoiceId = $invoiceId;
}
- public function getAmount()
+ /**
+ * Gets amount
+ *
+ * Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
+ *
+ * @return float|null the amount
+ */
+ public function getAmount(): ?float
{
- return $this->_amount;
+ return $this->amount;
}
- public function setAmount(float $amount)
+ /**
+ * Sets amount
+ *
+ * Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
+ *
+ * @param float $amount the amount
+ */
+ public function setAmount(float $amount): void
{
- $this->_amount = $amount;
+ $this->amount = $amount;
}
- public function getTimestamp()
+ /**
+ * Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @return string|null the timestamp
+ */
+ public function getTimestamp(): ?string
{
- return $this->_timestamp;
+ return $this->timestamp;
}
- public function setTimestamp(string $timestamp)
+ /**
+ * Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
+ *
+ * @param string $timestamp the timestamp
+ */
+ public function setTimestamp(string $timestamp): void
{
- $this->_timestamp = $timestamp;
+ $this->timestamp = $timestamp;
}
- public function getDescription()
+ /**
+ * Gets Ledger entry description.
+ *
+ * This field often contains an id depending on the type of entry
+ * (for instance payout id, settlement id, invoice orderId etc...)
+ *
+ * @return string|null the description
+ */
+ public function getDescription(): ?string
{
- return $this->_description;
+ return $this->description;
}
- public function setDescription(string $description)
+ /**
+ * Sets Ledger entry description.
+ *
+ * This field often contains an id depending on the type of entry
+ * (for instance payout id, settlement id, invoice orderId etc...)
+ *
+ * @param string $description the description
+ */
+ public function setDescription(string $description): void
{
- $this->_description = $description;
+ $this->description = $description;
}
- public function getReference()
+ /**
+ * Gets reference
+ *
+ * @return string|null the reference
+ */
+ public function getReference(): ?string
{
- return $this->_reference;
+ return $this->reference;
}
- public function setReference(string $reference)
+ /**
+ * Sets reference
+ *
+ * @param string $reference the reference
+ */
+ public function setReference(string $reference): void
{
- $this->_reference = $reference;
+ $this->reference = $reference;
}
- public function getInvoiceData()
+ /**
+ * Gets Invoice Data
+ *
+ * Object containing relevant information from the paid invoice
+ *
+ * @return InvoiceData
+ */
+ public function getInvoiceData(): InvoiceData
{
- return $this->_invoiceData;
+ return $this->invoiceData;
}
- public function setInvoiceData(InvoiceData $invoiceData)
+ /**
+ * Sets Invoice Data
+ *
+ * Object containing relevant information from the paid invoice
+ *
+ * @param InvoiceData $invoiceData information from the paid invoice
+ */
+ public function setInvoiceData(InvoiceData $invoiceData): void
{
- $this->_invoiceData = $invoiceData;
+ $this->invoiceData = $invoiceData;
}
- public function toArray()
+ /**
+ * Gets SettlementLedgerEntry as array
+ *
+ * @return array SettlementLedgerEntry as array
+ */
+ public function toArray(): array
{
- $elements = [
- 'code' => $this->getCode(),
- 'invoiceId' => $this->getInvoiceId(),
- 'amount' => $this->getAmount(),
- 'timestamp' => $this->getTimestamp(),
+ return [
+ 'code' => $this->getCode(),
+ 'invoiceId' => $this->getInvoiceId(),
+ 'amount' => $this->getAmount(),
+ 'timestamp' => $this->getTimestamp(),
'description' => $this->getDescription(),
- 'reference' => $this->getReference(),
- 'invoiceData' => $this->getInvoiceData()->toArray(),
+ 'reference' => $this->getReference(),
+ 'invoiceData' => $this->getInvoiceData() ? $this->getInvoiceData()->toArray() : null,
];
-
- return $elements;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Settlement/WithHoldings.php b/src/BitPaySDK/Model/Settlement/WithHoldings.php
index 4a2322ba..643ffe64 100644
--- a/src/BitPaySDK/Model/Settlement/WithHoldings.php
+++ b/src/BitPaySDK/Model/Settlement/WithHoldings.php
@@ -1,94 +1,169 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/settlements Settlements
+ */
class WithHoldings
{
- protected $_amount;
- protected $_code;
- protected $_description;
- protected $_notes;
- protected $_label;
- protected $_bankCountry;
-
+ protected ?float $amount = null;
+ protected ?string $code = null;
+ protected ?string $description = null;
+ protected ?string $notes = null;
+ protected ?string $label = null;
+ protected ?string $bankCountry = null;
+
+ /**
+ * WithHoldings constructor.
+ */
public function __construct()
{
}
- public function getAmount()
+ /**
+ * Gets amount.
+ *
+ * @return float|null
+ */
+ public function getAmount(): ?float
{
- return $this->_amount;
+ return $this->amount;
}
- public function setAmount(float $amount)
+ /**
+ * Sets amount.
+ *
+ * @param float $amount the amount
+ */
+ public function setAmount(float $amount): void
{
- $this->_amount = $amount;
+ $this->amount = $amount;
}
- public function getCode()
+ /**
+ * Gets code.
+ *
+ * @return string|null
+ */
+ public function getCode(): ?string
{
- return $this->_code;
+ return $this->code;
}
- public function setCode(string $code)
+ /**
+ * Sets code.
+ *
+ * @param string $code the code
+ */
+ public function setCode(string $code): void
{
- $this->_code = $code;
+ $this->code = $code;
}
- public function getDescription()
+ /**
+ * Gets description.
+ *
+ * @return string|null
+ */
+ public function getDescription(): ?string
{
- return $this->_description;
+ return $this->description;
}
- public function setDescription(string $description)
+ /**
+ * Sets description.
+ *
+ * @param string $description the description
+ */
+ public function setDescription(string $description): void
{
- $this->_description = $description;
+ $this->description = $description;
}
- public function getNotes()
+ /**
+ * Gets notes.
+ *
+ * @return string|null
+ */
+ public function getNotes(): ?string
{
- return $this->_notes;
+ return $this->notes;
}
- public function setNotes(string $notes)
+ /**
+ * Sets notes.
+ *
+ * @param string $notes the notes
+ */
+ public function setNotes(string $notes): void
{
- $this->_notes = $notes;
+ $this->notes = $notes;
}
- public function getLabel()
+ /**
+ * Gets label.
+ *
+ * @return string|null
+ */
+ public function getLabel(): ?string
{
- return $this->_label;
+ return $this->label;
}
- public function setLabel(string $label)
+ /**
+ * Sets label.
+ *
+ * @param string $label the label
+ */
+ public function setLabel(string $label): void
{
- $this->_label = $label;
+ $this->label = $label;
}
- public function getBankCountry()
+ /**
+ * Gets bank country.
+ *
+ * @return string|null
+ */
+ public function getBankCountry(): ?string
{
- return $this->_bankCountry;
+ return $this->bankCountry;
}
- public function setBankCountry(string $bankCountry)
+ /**
+ * Sets bank country.
+ *
+ * @param string $bankCountry the bank country
+ */
+ public function setBankCountry(string $bankCountry): void
{
- $this->_bankCountry = $bankCountry;
+ $this->bankCountry = $bankCountry;
}
- public function toArray()
+ /**
+ * Return an array with class values.
+ *
+ * @return array
+ */
+ public function toArray(): array
{
- $elements =
- [
- 'amount' => $this->getAmount(),
- 'code' => $this->getCode(),
- 'description' => $this->getDescription(),
- 'notes' => $this->getNotes(),
- 'label' => $this->getLabel(),
- 'bankCountry' => $this->getBankCountry(),
- ];
-
- return $elements;
+ return [
+ 'amount' => $this->getAmount(),
+ 'code' => $this->getCode(),
+ 'description' => $this->getDescription(),
+ 'notes' => $this->getNotes(),
+ 'label' => $this->getLabel(),
+ 'bankCountry' => $this->getBankCountry(),
+ ];
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Model/Subscription/BillData.php b/src/BitPaySDK/Model/Subscription/BillData.php
deleted file mode 100644
index 9bd2831a..00000000
--- a/src/BitPaySDK/Model/Subscription/BillData.php
+++ /dev/null
@@ -1,266 +0,0 @@
-_currency = $currency;
- $this->_email = $email;
- $this->_dueDate = $dueDate;
- $this->_items = $items;
- }
-
- public function getEmailBill()
- {
- return $this->_emailBill;
- }
-
- public function setEmailBill(bool $emailBill)
- {
- $this->_emailBill = $emailBill;
- }
-
- public function getCc()
- {
- return $this->_cc;
- }
-
- public function setCc(array $cc)
- {
- $this->_cc = $cc;
- }
-
- public function getNumber()
- {
- return $this->_number;
- }
-
- public function setNumber(string $number)
- {
- $this->_number = $number;
- }
-
- public function getCurrency()
- {
- return $this->_currency;
- }
-
- public function setCurrency(string $currency)
- {
- if (!Currency::isValid($currency)) {
- throw new BitPayException("currency code must be a type of Model.Currency");
- }
-
- $this->_currency = $currency;
- }
-
- public function getName()
- {
- return $this->_name;
- }
-
- public function setName(string $name)
- {
- $this->_name = $name;
- }
-
- public function getAddress1()
- {
- return $this->_address1;
- }
-
- public function setAddress1(string $address1)
- {
- $this->_address1 = $address1;
- }
-
- public function getAddress2()
- {
- return $this->_address2;
- }
-
- public function setAddress2(string $address2)
- {
- $this->_address2 = $address2;
- }
-
- public function getCity()
- {
- return $this->_city;
- }
-
- public function setCity(string $city)
- {
- $this->_city = $city;
- }
-
- public function getState()
- {
- return $this->_state;
- }
-
- public function setState(string $state)
- {
- $this->_state = $state;
- }
-
- public function getZip()
- {
- return $this->_zip;
- }
-
- public function setZip(string $zip)
- {
- $this->_zip = $zip;
- }
-
- public function getCountry()
- {
- return $this->_country;
- }
-
- public function setCountry(string $country)
- {
- $this->_country = $country;
- }
-
- public function getEmail()
- {
- return $this->_email;
- }
-
- public function setEmail(string $email)
- {
- $this->_email = $email;
- }
-
- public function getPhone()
- {
- return $this->_phone;
- }
-
- public function setPhone(string $phone)
- {
- $this->_phone = $phone;
- }
-
- public function getDueDate()
- {
- return $this->_dueDate;
- }
-
- public function setDueDate(string $dueDate)
- {
- $this->_dueDate = $dueDate;
- }
-
- public function getPassProcessingFee()
- {
- return $this->_passProcessingFee;
- }
-
- public function setPassProcessingFee(bool $passProcessingFee)
- {
- $this->_passProcessingFee = $passProcessingFee;
- }
-
- public function getMerchant()
- {
- return $this->_merchant;
- }
-
- public function setMerchant(string $merchant)
- {
- $this->_merchant = $merchant;
- }
-
- public function getItems()
- {
- return $this->_items;
- }
-
- public function getItemsAsArray()
- {
- $items = [];
-
- foreach ($this->_items as $item) {
- if ($item instanceof Item) {
- array_push($items, $item->toArray());
- } else {
- array_push($items, $item);
- }
- }
-
- return $items;
- }
-
- public function setItems(array $items)
- {
- $itemsArray = [];
-
- foreach ($items as $item) {
- if ($item instanceof Item) {
- array_push($itemsArray, $item);
- } else {
- array_push($itemsArray, Item::createFromArray((array)$item));
- }
- }
- $this->_items = $itemsArray;
- }
-
- public function toArray()
- {
- $elements = [
- 'emailBill' => $this->getEmailBill(),
- 'cc' => $this->getCc(),
- 'number' => $this->getNumber(),
- 'currency' => $this->getCurrency(),
- 'name' => $this->getName(),
- 'address1' => $this->getAddress1(),
- 'address2' => $this->getAddress2(),
- 'city' => $this->getCity(),
- 'state' => $this->getState(),
- 'zip' => $this->getZip(),
- 'country' => $this->getCountry(),
- 'email' => $this->getEmail(),
- 'phone' => $this->getPhone(),
- 'dueDate' => $this->getDueDate(),
- 'passProcessingFee' => $this->getPassProcessingFee(),
- 'items' => $this->getItemsAsArray(),
- 'merchant' => $this->getMerchant(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Subscription/Item.php b/src/BitPaySDK/Model/Subscription/Item.php
deleted file mode 100644
index 3ff124dc..00000000
--- a/src/BitPaySDK/Model/Subscription/Item.php
+++ /dev/null
@@ -1,77 +0,0 @@
-_price = $price;
- $this->_quantity = $quantity;
- $this->_description = $description;
- }
-
- public function getDescription()
- {
- return $this->_description;
- }
-
- public function setDescription(string $description)
- {
- $this->_description = $description;
- }
-
- public function getPrice()
- {
- return $this->_price;
- }
-
- public function setPrice(float $price)
- {
- $this->_price = $price;
- }
-
- public function getQuantity()
- {
- return $this->_quantity;
- }
-
- public function setQuantity(int $quantity)
- {
- $this->_quantity = $quantity;
- }
-
- public static function createFromArray(array $item)
- {
- $instance = new self();
-
- foreach ($item as $key => $value) {
- $instance->{'_'.$key} = $value;
- }
-
- return $instance;
- }
-
- public function toArray()
- {
- $elements = [
- 'description' => $this->getDescription(),
- 'price' => $this->getPrice(),
- 'quantity' => $this->getQuantity(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Subscription/Subscription.php b/src/BitPaySDK/Model/Subscription/Subscription.php
deleted file mode 100644
index 69738c43..00000000
--- a/src/BitPaySDK/Model/Subscription/Subscription.php
+++ /dev/null
@@ -1,115 +0,0 @@
-_billData = new BillData('', '', '', []);
- }
-
- public function getId()
- {
- return $this->_id;
- }
-
- public function setId(string $id)
- {
- $this->_id = $id;
- }
-
- public function getStatus()
- {
- return $this->_status;
- }
-
- public function setStatus(string $status)
- {
- $this->_status = $status;
- }
-
- public function getBillData()
- {
- return $this->_billData;
- }
-
- public function setBillData(BillData $billData)
- {
- $this->_billData = $billData;
- }
-
- public function getSchedule()
- {
- return $this->_schedule;
- }
-
- public function setSchedule(string $schedule)
- {
- $this->_schedule = $schedule;
- }
-
- public function getNextDelivery()
- {
- return $this->_nextDelivery;
- }
-
- public function setNextDelivery(string $nextDelivery)
- {
- $this->_nextDelivery = $nextDelivery;
- }
-
- public function getCreatedDate()
- {
- return $this->_createdDate;
- }
-
- public function setCreatedDate(string $createdDate)
- {
- $this->_createdDate = $createdDate;
- }
-
- public function getToken()
- {
- return $this->_token;
- }
-
- public function setToken(string $token)
- {
- $this->_token = $token;
- }
-
- public function toArray()
- {
- $elements = [
- 'id' => $this->getId(),
- 'status' => $this->getStatus(),
- 'billData' => $this->getBillData()->toArray(),
- 'schedule' => $this->getSchedule(),
- 'nextDelivery' => $this->getNextDelivery(),
- 'createdDate' => $this->getCreatedDate(),
- 'token' => $this->getToken(),
- ];
-
- foreach ($elements as $key => $value) {
- if (empty($value)) {
- unset($elements[$key]);
- }
- }
-
- return $elements;
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Model/Subscription/SubscriptionStatus.php b/src/BitPaySDK/Model/Subscription/SubscriptionStatus.php
deleted file mode 100644
index 23e05f0c..00000000
--- a/src/BitPaySDK/Model/Subscription/SubscriptionStatus.php
+++ /dev/null
@@ -1,12 +0,0 @@
-
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/wallets Wallets
+ */
+class Currencies
+{
+ protected ?string $code = null;
+ protected ?bool $p2p = null;
+ protected ?bool $dappBrowser = null;
+ protected ?string $image = null;
+ protected ?bool $payPro = null;
+ protected ?CurrencyQr $qr = null;
+ protected ?string $withdrawalFee = null;
+ protected ?bool $walletConnect = null;
+
+ public function __construct()
+ {
+ }
+
+ /**
+ * Gets code
+ *
+ * Identifying code for the currency
+ *
+ * @return string|null the code
+ */
+ public function getCode(): ?string
+ {
+ return $this->code;
+ }
+
+ /**
+ * Sets code
+ *
+ * Identifying code for the currency
+ *
+ * @param string $code the code
+ */
+ public function setCode(string $code): void
+ {
+ $this->code = $code;
+ }
+
+ /**
+ * Gets p2p
+ *
+ * Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)
+ *
+ * @return bool|null the p2p
+ */
+ public function getP2p(): ?bool
+ {
+ return $this->p2p;
+ }
+
+ /**
+ * Sets p2p
+ *
+ * Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)
+ *
+ * @param bool $p2p the p2p
+ */
+ public function setP2p(bool $p2p): void
+ {
+ $this->p2p = $p2p;
+ }
+
+ /**
+ * Gets Dapp Browser
+ *
+ * Indicates that this payment method operates via a browser plugin interacting with the invoice
+ *
+ * @return bool|null the dapp browser
+ */
+ public function getDappBrowser(): ?bool
+ {
+ return $this->dappBrowser;
+ }
+
+ /**
+ * Sets Dapp Browser
+ *
+ * Indicates that this payment method operates via a browser plugin interacting with the invoice
+ *
+ * @param bool $dappBrowser the dapp browser
+ */
+ public function setDappBrowser(bool $dappBrowser): void
+ {
+ $this->dappBrowser = $dappBrowser;
+ }
+
+ /**
+ * Gets URL that displays currency image
+ *
+ * @return string|null the image url
+ */
+ public function getImage(): ?string
+ {
+ return $this->image;
+ }
+
+ /**
+ * Sets URL that displays currency image
+ *
+ * @param string $image the image url
+ */
+ public function setImage(string $image): void
+ {
+ $this->image = $image;
+ }
+
+ /**
+ * Gets pay pro
+ *
+ * Whether or not BitPay Payment Protocol is supported on this particular currency option
+ *
+ * @return bool|null the pay pro
+ */
+ public function getPayPro(): ?bool
+ {
+ return $this->payPro;
+ }
+
+ /**
+ * Sets pay pro
+ *
+ * Whether or not BitPay Payment Protocol is supported on this particular currency option
+ *
+ * @param bool $payPro the pay pro
+ */
+ public function setPayPro(bool $payPro): void
+ {
+ $this->payPro = $payPro;
+ }
+
+ /**
+ * Gets CurrencyQr
+ *
+ * Object containing QR code related information to show for this payment method
+ *
+ * @return CurrencyQr|null the qr
+ */
+ public function getQr(): ?CurrencyQr
+ {
+ return $this->qr;
+ }
+
+ /**
+ * Sets CurrencyQr
+ *
+ * Object containing QR code related information to show for this payment method
+ *
+ * @param CurrencyQr $qr the currency qr
+ */
+ public function setQr(CurrencyQr $qr): void
+ {
+ $this->qr = $qr;
+ }
+
+ /**
+ * Gets Custodial wallet withdrawal fee
+ *
+ * @return string|null the withdrawal fee
+ */
+ public function getWithdrawalFee(): ?string
+ {
+ return $this->withdrawalFee;
+ }
+
+ /**
+ * Sets Custodial wallet withdrawal fee
+ *
+ * @param string $withdrawalFee the withdrawal fee
+ */
+ public function setWithdrawalFee(string $withdrawalFee): void
+ {
+ $this->withdrawalFee = $withdrawalFee;
+ }
+
+ /**
+ * Gets wallet connect
+ *
+ * Whether or not this wallet supports walletConnect
+ *
+ * @return bool|null the wallet connect
+ */
+ public function getWalletConnect(): ?bool
+ {
+ return $this->walletConnect;
+ }
+
+ /**
+ * Sets wallet connect
+ *
+ * Whether or not this wallet supports walletConnect
+ *
+ * @param bool $walletConnect the wallet connect
+ */
+ public function setWalletConnect(bool $walletConnect): void
+ {
+ $this->walletConnect = $walletConnect;
+ }
+
+ /**
+ * Gets Currencies as array
+ *
+ * @return array Currencies as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'code' => $this->getCode(),
+ 'p2p' => $this->getP2p(),
+ 'dappBrowser' => $this->getDappBrowser(),
+ 'image' => $this->getImage(),
+ 'paypro' => $this->getPayPro(),
+ 'qr' => $this->getQr()->toArray(),
+ 'withdrawalFee' => $this->getWithdrawalFee(),
+ 'walletConnect' => $this->getWalletConnect()
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Wallet/CurrencyQr.php b/src/BitPaySDK/Model/Wallet/CurrencyQr.php
new file mode 100644
index 00000000..41ce8b96
--- /dev/null
+++ b/src/BitPaySDK/Model/Wallet/CurrencyQr.php
@@ -0,0 +1,88 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/wallets Wallets
+ */
+class CurrencyQr
+{
+ protected ?string $type = null;
+ protected ?bool $collapsed = null;
+
+ public function __construct()
+ {
+ }
+
+ /**
+ * Gets Type
+ *
+ * The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)
+ *
+ * @return string|null The type of QR code to use
+ */
+ public function getType(): ?string
+ {
+ return $this->type;
+ }
+
+ /**
+ * Sets Type
+ *
+ * The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)
+ *
+ * @param string $type The type of QR code to use
+ */
+ public function setType(string $type): void
+ {
+ $this->type = $type;
+ }
+
+ /**
+ * Gets collapsed
+ *
+ * UI hint for BitPay invoice, generally not relevant to customer integrations
+ *
+ * @return bool|null the collapsed
+ */
+ public function getCollapsed(): ?bool
+ {
+ return $this->collapsed;
+ }
+
+ /**
+ * Sets collapsed
+ *
+ * UI hint for BitPay invoice, generally not relevant to customer integrations
+ *
+ * @param bool $collapsed the collapsed
+ */
+ public function setCollapsed(bool $collapsed): void
+ {
+ $this->collapsed = $collapsed;
+ }
+
+ /**
+ * Gets CurrencyQr as array
+ *
+ * @return array CurrencyQr as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'type' => $this->getType(),
+ 'collapsed' => $this->getCollapsed(),
+ ];
+ }
+}
diff --git a/src/BitPaySDK/Model/Wallet/Wallet.php b/src/BitPaySDK/Model/Wallet/Wallet.php
new file mode 100644
index 00000000..579ee5e9
--- /dev/null
+++ b/src/BitPaySDK/Model/Wallet/Wallet.php
@@ -0,0 +1,190 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @see https://bitpay.readme.io/reference/wallets Wallets
+ */
+class Wallet
+{
+ protected ?string $key = null;
+ protected ?string $displayName = null;
+ protected ?string $avatar = null;
+ protected Currencies $currencies;
+ protected ?string $image = null;
+ protected ?bool $payPro = null;
+
+ /**
+ * Constructor, create a minimal request Wallet object.
+ */
+ public function __construct()
+ {
+ $this->currencies = new Currencies();
+ }
+
+ /**
+ * Gets A unique identifier for the wallet
+ *
+ * @return string|null the key
+ */
+ public function getKey(): ?string
+ {
+ return $this->key;
+ }
+
+ /**
+ * Sets A unique identifier for the wallet
+ *
+ * @param string $key the key
+ */
+ public function setKey(string $key): void
+ {
+ $this->key = $key;
+ }
+
+ /**
+ * Gets display name
+ *
+ * Human readable display name for the wallet
+ *
+ * @return string|null the display name
+ */
+ public function getDisplayName(): ?string
+ {
+ return $this->displayName;
+ }
+
+ /**
+ * Sets display name
+ *
+ * Human readable display name for the wallet
+ *
+ * @param string $displayName the display name
+ */
+ public function setDisplayName(string $displayName): void
+ {
+ $this->displayName = $displayName;
+ }
+
+ /**
+ * Gets avatar
+ *
+ * Filename of a wallet graphic (not fully qualified)
+ *
+ * @return string|null the avatar
+ */
+ public function getAvatar(): ?string
+ {
+ return $this->avatar;
+ }
+
+ /**
+ * Sets avatar
+ *
+ * Filename of a wallet graphic (not fully qualified)
+ *
+ * @param string $avatar the avatar
+ */
+ public function setAvatar(string $avatar): void
+ {
+ $this->avatar = $avatar;
+ }
+
+ /**
+ * Gets pay pro
+ *
+ * Whether or not the wallet supports ANY BitPay Payment Protocol options
+ *
+ * @return bool|null the pay pro
+ */
+ public function getPayPro(): ?bool
+ {
+ return $this->payPro;
+ }
+
+ /**
+ * Sets pay pro
+ *
+ * Whether or not the wallet supports ANY BitPay Payment Protocol options
+ *
+ * @param bool $payPro the pay pro
+ */
+ public function setPayPro(bool $payPro): void
+ {
+ $this->payPro = $payPro;
+ }
+
+ /**
+ * Gets currencies
+ *
+ * Details of what currencies support payments for this wallet
+ *
+ * @return Currencies the currencies
+ */
+ public function getCurrencies(): Currencies
+ {
+ return $this->currencies;
+ }
+
+ /**
+ * Sets currencies
+ *
+ * Details of what currencies support payments for this wallet
+ *
+ * @param Currencies $currencies the currencies
+ */
+ public function setCurrencies(Currencies $currencies): void
+ {
+ $this->currencies = $currencies;
+ }
+
+ /**
+ * Gets image
+ *
+ * URL that displays wallet avatar image
+ *
+ * @return string|null the image url
+ */
+ public function getImage(): ?string
+ {
+ return $this->image;
+ }
+
+ /**
+ * Sets image
+ *
+ * URL that displays wallet avatar image
+ *
+ * @param string $image the image url
+ */
+ public function setImage(string $image): void
+ {
+ $this->image = $image;
+ }
+
+ /**
+ * Gets Wallet as array
+ *
+ * @return array Wallet as array
+ */
+ public function toArray(): array
+ {
+ return [
+ 'key' => $this->getKey(),
+ 'displayName' => $this->getDisplayName(),
+ 'avatar' => $this->getAvatar(),
+ 'paypro' => $this->getPayPro(),
+ 'currencies' => $this->getCurrencies()->toArray(),
+ 'image' => $this->getImage()
+ ];
+ }
+}
diff --git a/src/BitPaySDK/PosClient.php b/src/BitPaySDK/PosClient.php
new file mode 100644
index 00000000..62c12b64
--- /dev/null
+++ b/src/BitPaySDK/PosClient.php
@@ -0,0 +1,104 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class PosClient extends Client
+{
+ protected string $env;
+ protected Tokens $token;
+ protected RESTcli $RESTcli;
+
+ /**
+ * Constructor for the BitPay SDK to use with the POS facade.
+ *
+ * @param $token string The token generated on the BitPay account.
+ * @param string|null $environment string The target environment [Default: Production].
+ *
+ * @throws BitPayException BitPayException class
+ */
+ public function __construct(string $token, string $environment = null)
+ {
+ try {
+ $this->token = new Tokens(null, null, $token);
+ $this->env = strtolower($environment) === "test" ? Env::TEST : Env::PROD;
+ $this->init();
+ parent::__construct($this->RESTcli, new Tokens(null, null, $token));
+ } catch (Exception $e) {
+ throw new BitPayException("failed to initialize BitPay Light Client (Config) : " . $e->getMessage());
+ }
+ }
+
+ /**
+ * Initialize this object with the selected environment.
+ *
+ * @throws BitPayException BitPayException class
+ */
+ private function init(): void
+ {
+ try {
+ $this->RESTcli = new RESTcli($this->env, new PrivateKey());
+ } catch (Exception $e) {
+ throw new BitPayException("failed to build configuration : " . $e->getMessage());
+ }
+ }
+
+ /**
+ * Fetch the supported currencies.
+ *
+ * @return array A list of BitPay Invoice objects.
+ * @throws CurrencyQueryException CurrencyQueryException class
+ * @throws \BitPaySDK\Exceptions\BitPayException BitPayException class
+ */
+ public function getCurrencies(): array
+ {
+ try {
+ $responseJson = $this->RESTcli->get("currencies", null, false);
+ } catch (BitPayException $e) {
+ throw new CurrencyQueryException(
+ "failed to serialize Currency object : " . $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
+ } catch (Exception $e) {
+ throw new CurrencyQueryException("failed to serialize Currency object : " . $e->getMessage());
+ }
+
+ try {
+ $mapper = new JsonMapper();
+ $mapper->bEnforceMapType = false;
+ $currencies = $mapper->mapArray(
+ json_decode($responseJson, true, 512, JSON_THROW_ON_ERROR),
+ [],
+ Currency::class
+ );
+ } catch (Exception $e) {
+ throw new CurrencyQueryException(
+ "failed to deserialize BitPay server response (Currency) : " . $e->getMessage()
+ );
+ }
+
+ return $currencies;
+ }
+}
diff --git a/src/BitPaySDK/Tokens.php b/src/BitPaySDK/Tokens.php
index f00ca871..9786ffc1 100644
--- a/src/BitPaySDK/Tokens.php
+++ b/src/BitPaySDK/Tokens.php
@@ -1,39 +1,54 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
*/
class Tokens
{
/**
- * @var
+ * @var string|null
*/
- protected $merchant;
+ protected ?string $merchant;
+
/**
- * @var
+ * @var string|null
*/
- protected $payroll;
+ protected ?string $payout;
+
+ /**
+ * @var string|null
+ */
+ protected ?string $pos;
/**
* Tokens constructor.
* @param string|null $merchant
- * @param string|null $payroll
+ * @param string|null $payout
+ * @param string|null $pos
*/
- public function __construct($merchant = null, $payroll = null)
+ public function __construct(?string $merchant = null, ?string $payout = null, ?string $pos = null)
{
$this->merchant = $merchant;
- $this->payroll = $payroll;
+ $this->payout = $payout;
+ $this->pos = $pos;
}
- public static function loadFromArray(array $tokens)
+ public static function loadFromArray(array $tokens): Tokens
{
$instance = new self();
@@ -46,49 +61,40 @@ public static function loadFromArray(array $tokens)
/**
* @param $facade
- * @return string
+ * @return string|null
* @throws Exception
*/
- public function getTokenByFacade($facade)
+ public function getTokenByFacade($facade): ?string
{
- $token = null;
- switch ($facade) {
- case Facade::Merchant:
- $token = $this->merchant;
- break;
- case Facade::Payroll:
- $token = $this->payroll;
- break;
- }
-
- if ($token) {
- return $token;
- }
-
- throw new Exception("given facade does not exist or no token defined for the given facade");
+ return match ($facade) {
+ Facade::MERCHANT => $this->merchant,
+ Facade::PAYOUT => $this->payout,
+ Facade::POS => $this->pos,
+ default => throw new Exception("given facade does not exist or no token defined for the given facade"),
+ };
}
/**
- * @param $merchant
+ * @param string $merchant
*/
- public function setMerchantToken($merchant)
+ public function setMerchantToken(string $merchant): void
{
$this->merchant = $merchant;
}
/**
- * @return mixed
+ * @return string|null
*/
- public function getPayrollToken()
+ public function getPayoutToken(): ?string
{
- return $this->payroll;
+ return $this->payout;
}
/**
- * @param $payroll
+ * @param string $payout
*/
- public function setPayrollToken($payroll)
+ public function setPayoutToken(string $payout): void
{
- $this->payroll = $payroll;
+ $this->payout = $payout;
}
-}
\ No newline at end of file
+}
diff --git a/src/BitPaySDK/Util/JsonMapper/JsonMapper.php b/src/BitPaySDK/Util/JsonMapper/JsonMapper.php
deleted file mode 100755
index 631fd359..00000000
--- a/src/BitPaySDK/Util/JsonMapper/JsonMapper.php
+++ /dev/null
@@ -1,839 +0,0 @@
-
- * @license OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link http://cweiske.de/
- */
-
-namespace BitPaySDK\Util\JsonMapper;
-
-
-use InvalidArgumentException;
-use ReflectionClass;
-use ReflectionProperty;
-
-/**
- * Automatically map JSON structures into objects.
- *
- * @category Netresearch
- * @package JsonMapper
- * @author Christian Weiske
- * @license OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link http://cweiske.de/
- */
-class JsonMapper
-{
- /**
- * Throw an exception when JSON data contain a property
- * that is not defined in the PHP class
- *
- * @var boolean
- */
- public $bExceptionOnUndefinedProperty = false;
- /**
- * Throw an exception if the JSON data miss a property
- * that is marked with @required in the PHP class
- *
- * @var boolean
- */
- public $bExceptionOnMissingData = false;
- /**
- * If the types of map() parameters shall be checked.
- *
- * You have to disable it if you're using the json_decode "assoc" parameter.
- *
- * json_decode($str, false)
- *
- * @var boolean
- */
- public $bEnforceMapType = false;
- /**
- * Throw an exception when an object is expected but the JSON contains
- * a non-object type.
- *
- * @var boolean
- */
- public $bStrictObjectTypeChecking = false;
- /**
- * Throw an exception, if null value is found
- * but the type of attribute does not allow nulls.
- *
- * @var bool
- */
- public $bStrictNullTypes = true;
- /**
- * Allow mapping of private and proteted properties.
- *
- * @var boolean
- */
- public $bIgnoreVisibility = false;
- /**
- * Remove attributes that were not passed in JSON,
- * to avoid confusion between them and NULL values.
- *
- * @var boolean
- */
- public $bRemoveUndefinedAttributes = false;
- /**
- * Override class names that JsonMapper uses to create objects.
- * Useful when your setter methods accept abstract classes or interfaces.
- *
- * @var array
- */
- public $classMap = [];
- /**
- * Callback used when an undefined property is found.
- *
- * Works only when $bExceptionOnUndefinedProperty is disabled.
- *
- * Parameters to this function are:
- * 1. Object that is being filled
- * 2. Name of the unknown JSON property
- * 3. JSON value of the property
- *
- * @var callable
- */
- public $undefinedPropertyHandler = null;
- /**
- * PSR-3 compatible logger object
- *
- * @link http://www.php-fig.org/psr/psr-3/
- * @var object
- * @see setLogger()
- */
- protected $logger;
- /**
- * Runtime cache for inspected classes. This is particularly effective if
- * mapArray() is called with a large number of objects
- *
- * @var array property inspection result cache
- */
- protected $arInspectedClasses = [];
-
- /**
- * Map data all data in $json into the given $object instance.
- *
- * @param object $json JSON object structure from json_decode()
- * @param object $object Object to map $json data into
- *
- * @return mixed Mapped object is returned.
- * @see mapArray()
- */
- public function map($json, $object)
- {
- if ($this->bEnforceMapType && !is_object($json)) {
- throw new InvalidArgumentException(
- 'JsonMapper::map() requires first argument to be an object'
- .', '.gettype($json).' given.'
- );
- }
- if (!is_object($object)) {
- throw new InvalidArgumentException(
- 'JsonMapper::map() requires second argument to be an object'
- .', '.gettype($object).' given.'
- );
- }
-
- $strClassName = get_class($object);
- $rc = new ReflectionClass($object);
- $strNs = $rc->getNamespaceName();
- $providedProperties = [];
- foreach ($json as $key => $jvalue) {
- $key = $this->getSafeName($key);
- $providedProperties[$key] = true;
-
- // Store the property inspection results so we don't have to do it
- // again for subsequent objects of the same type
- if (!isset($this->arInspectedClasses[$strClassName][$key])) {
- $this->arInspectedClasses[$strClassName][$key]
- = $this->inspectProperty($rc, $key);
- }
-
- list(
- $hasProperty, $accessor, $type)
- = $this->arInspectedClasses[$strClassName][$key];
-
- if (!$hasProperty) {
- if ($this->bExceptionOnUndefinedProperty) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" does not exist'
- .' in object of type '.$strClassName
- );
- } else {
- if ($this->undefinedPropertyHandler !== null) {
- call_user_func(
- $this->undefinedPropertyHandler,
- $object, $key, $jvalue
- );
- } else {
- $this->log(
- 'info',
- 'Property {property} does not exist in {class}',
- ['property' => $key, 'class' => $strClassName]
- );
- }
- }
- continue;
- }
-
- if ($accessor === null) {
- if ($this->bExceptionOnUndefinedProperty) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" has no public setter method'
- .' in object of type '.$strClassName
- );
- }
- $this->log(
- 'info',
- 'Property {property} has no public setter method in {class}',
- ['property' => $key, 'class' => $strClassName]
- );
- continue;
- }
-
- if ($this->isNullable($type) || !$this->bStrictNullTypes) {
- if ($jvalue === null) {
- $this->setProperty($object, $accessor, null);
- continue;
- }
- $type = $this->removeNullable($type);
- } else {
- if ($jvalue === null) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" in class "'
- .$strClassName.'" must not be NULL'
- );
- }
- }
-
- $type = $this->getFullNamespace($type, $strNs);
- $type = $this->getMappedType($type, $jvalue);
-
- if ($type === null || $type === 'mixed') {
- //no given type - simply set the json data
- $this->setProperty($object, $accessor, $jvalue);
- continue;
- } else {
- if ($this->isObjectOfSameType($type, $jvalue)) {
- $this->setProperty($object, $accessor, $jvalue);
- continue;
- } else {
- if ($this->isSimpleType($type)) {
- if ($type === 'string' && is_object($jvalue)) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" in class "'
- .$strClassName.'" is an object and'
- .' cannot be converted to a string'
- );
- }
- settype($jvalue, $type);
- $this->setProperty($object, $accessor, $jvalue);
- continue;
- }
- }
- }
-
- //FIXME: check if type exists, give detailed error message if not
- if ($type === '') {
- throw new JsonMapperException(
- 'Empty type at property "'
- .$strClassName.'::$'.$key.'"'
- );
- }
-
- $array = null;
- $subtype = null;
- if ($this->isArrayOfType($type)) {
- //array
- $array = [];
- $subtype = substr($type, 0, -2);
- } else {
- if (substr($type, -1) == ']') {
- list($proptype, $subtype) = explode('[', substr($type, 0, -1));
- if ($proptype == 'array') {
- $array = [];
- } else {
- $array = $this->createInstance($proptype, false, $jvalue);
- }
- } else {
- if (is_a($type, 'ArrayObject', true)) {
- $array = $this->createInstance($type, false, $jvalue);
- }
- }
- }
-
- if ($key == 'shopper') {
- $stop = 0;
- }
-
- if ($array !== null) {
- if (!is_array($jvalue) && $this->isFlatType(gettype($jvalue))) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" must be an array, '
- .gettype($jvalue).' given'
- );
- }
-
- $cleanSubtype = $this->removeNullable($subtype);
- $subtype = $this->getFullNamespace($cleanSubtype, $strNs);
- $child = $this->mapArray($jvalue, $array, $subtype, $key);
- } else {
- if ($this->isFlatType(gettype($jvalue))) {
- //use constructor parameter if we have a class
- // but only a flat type (i.e. string, int)
- if ($this->bStrictObjectTypeChecking) {
- throw new JsonMapperException(
- 'JSON property "'.$key.'" must be an object, '
- .gettype($jvalue).' given'
- );
- }
- $child = $this->createInstance($type, true, $jvalue);
- } else {
- $child = $this->createInstance($type, false, $jvalue);
- $this->map($jvalue, $child);
- }
- }
- $this->setProperty($object, $accessor, $child);
- }
-
- if ($this->bExceptionOnMissingData) {
- $this->checkMissingData($providedProperties, $rc);
- }
-
- if ($this->bRemoveUndefinedAttributes) {
- $this->removeUndefinedAttributes($object, $providedProperties);
- }
-
- return $object;
- }
-
- /**
- * Since hyphens cannot be used in variables we have to uppercase them.
- *
- * Technically you may use them, but they are awkward to access.
- *
- * @param string $name Property name
- *
- * @return string Name without hyphen
- */
- protected function getSafeName($name)
- {
- if (strpos($name, '-') !== false) {
- $name = $this->getCamelCaseName($name);
- }
-
- return $name;
- }
-
- /**
- * Removes - and _ and makes the next letter uppercase
- *
- * @param string $name Property name
- *
- * @return string CamelCasedVariableName
- */
- protected function getCamelCaseName($name)
- {
- return str_replace(
- ' ', '', ucwords(str_replace(['_', '-'], ' ', $name))
- );
- }
-
- /**
- * Try to find out if a property exists in a given class.
- * Checks property first, falls back to setter method.
- *
- * @param object $rc Reflection class to check
- * @param string $name Property name
- *
- * @return array First value: if the property exists
- * Second value: the accessor to use (
- * ReflectionMethod or \ReflectionProperty, or null)
- * Third value: type of the property
- */
- protected function inspectProperty(ReflectionClass $rc, $name)
- {
- //try setter method first
- $setter = 'set'.$this->getCamelCaseName($name);
-
- if ($rc->hasMethod($setter)) {
- $rmeth = $rc->getMethod($setter);
- if ($rmeth->isPublic() || $this->bIgnoreVisibility) {
- $rparams = $rmeth->getParameters();
- if (count($rparams) > 0) {
- $pclass = $rparams[0]->getClass();
- $nullability = '';
- if ($rparams[0]->allowsNull()) {
- $nullability = '|null';
- }
- if ($pclass !== null) {
- return [
- true,
- $rmeth,
- '\\'.$pclass->getName().$nullability,
- ];
- }
- }
-
- $docblock = $rmeth->getDocComment();
- $annotations = $this->parseAnnotations($docblock);
-
- if (!isset($annotations['param'][0])) {
- // If there is no annotations (higher priority) inspect
- // if there's a scalar type being defined
- if (PHP_MAJOR_VERSION >= 7) {
- $ptype = $rparams[0]->getType();
- if ($ptype !== null) {
- return [true, $rmeth, $ptype.$nullability];
- }
- }
-
- return [true, $rmeth, null];
- }
- list($type) = explode(' ', trim($annotations['param'][0]));
-
- return [true, $rmeth, $type];
- }
- }
-
- //now try to set the property directly
- //we have to look it up in the class hierarchy
- $class = $rc;
- $rprop = null;
- do {
- if ($class->hasProperty($name)) {
- $rprop = $class->getProperty($name);
- }
- } while ($rprop === null && $class = $class->getParentClass());
-
- if ($rprop === null) {
- //case-insensitive property matching
- foreach ($rc->getProperties() as $p) {
- if ((strcasecmp($p->name, $name) === 0)) {
- $rprop = $p;
- break;
- }
- }
- }
- if ($rprop !== null) {
- if ($rprop->isPublic() || $this->bIgnoreVisibility) {
- $docblock = $rprop->getDocComment();
- $annotations = $this->parseAnnotations($docblock);
-
- if (!isset($annotations['var'][0])) {
- return [true, $rprop, null];
- }
-
- //support "@var type description"
- list($type) = explode(' ', $annotations['var'][0]);
-
- return [true, $rprop, $type];
- } else {
- //no setter, private property
- return [true, null, null];
- }
- }
-
- //no setter, no property
- return [false, null, null];
- }
-
- /**
- * Copied from PHPUnit 3.7.29, Util/Test.php
- *
- * @param string $docblock Full method docblock
- *
- * @return array
- */
- protected static function parseAnnotations($docblock)
- {
- $annotations = [];
- // Strip away the docblock header and footer
- // to ease parsing of one line annotations
- $docblock = substr($docblock, 3, -2);
-
- $re = '/@(?P[A-Za-z_-]+)(?:[ \t]+(?P.*?))?[ \t]*\r?$/m';
- if (preg_match_all($re, $docblock, $matches)) {
- $numMatches = count($matches[0]);
-
- for ($i = 0; $i < $numMatches; ++$i) {
- $annotations[$matches['name'][$i]][] = $matches['value'][$i];
- }
- }
-
- return $annotations;
- }
-
- /**
- * Log a message to the $logger object
- *
- * @param string $level Logging level
- * @param string $message Text to log
- * @param array $context Additional information
- *
- * @return null
- */
- protected function log($level, $message, array $context = [])
- {
- if ($this->logger) {
- $this->logger->log($level, $message, $context);
- }
- }
-
- /**
- * Checks if the given type is nullable
- *
- * @param string $type type name from the phpdoc param
- *
- * @return boolean True if it is nullable
- */
- protected function isNullable($type)
- {
- return stripos('|'.$type.'|', '|null|') !== false;
- }
-
- /**
- * Set a property on a given object to a given value.
- *
- * Checks if the setter or the property are public are made before
- * calling this method.
- *
- * @param object $object Object to set property on
- * @param object $accessor ReflectionMethod or \ReflectionProperty
- * @param mixed $value Value of property
- *
- * @return void
- */
- protected function setProperty(
- $object,
- $accessor,
- $value
- ) {
- if (!$accessor->isPublic() && $this->bIgnoreVisibility) {
- $accessor->setAccessible(true);
- }
- if ($accessor instanceof ReflectionProperty) {
- $accessor->setValue($object, $value);
- } else {
- //setter method
- $accessor->invoke($object, $value);
- }
- }
-
- /**
- * Remove the 'null' section of a type
- *
- * @param string $type type name from the phpdoc param
- *
- * @return string The new type value
- */
- protected function removeNullable($type)
- {
- if ($type === null) {
- return null;
- }
-
- return substr(
- str_ireplace('|null|', '|', '|'.$type.'|'),
- 1, -1
- );
- }
-
- /**
- * Convert a type name to a fully namespaced type name.
- *
- * @param string $type Type name (simple type or class name)
- * @param string $strNs Base namespace that gets prepended to the type name
- *
- * @return string Fully-qualified type name with namespace
- */
- protected function getFullNamespace($type, $strNs)
- {
- if ($type === null || $type === '' || $type[0] == '\\'
- || $strNs == ''
- ) {
- return $type;
- }
- list($first) = explode('[', $type, 2);
- if ($this->isSimpleType($first) || $first === 'mixed') {
- return $type;
- }
-
- //create a full qualified namespace
- return '\\'.$strNs.'\\'.$type;
- }
-
- /**
- * Checks if the given type is a "simple type"
- *
- * @param string $type type name from gettype()
- *
- * @return boolean True if it is a simple PHP type
- *
- * @see isFlatType()
- */
- protected function isSimpleType($type)
- {
- return $type == 'string'
- || $type == 'boolean' || $type == 'bool'
- || $type == 'integer' || $type == 'int'
- || $type == 'double' || $type == 'float'
- || $type == 'array' || $type == 'object';
- }
-
- /**
- * Get the mapped class/type name for this class.
- * Returns the incoming classname if not mapped.
- *
- * @param string $type Type name to map
- * @param mixed $jvalue Constructor parameter (the json value)
- *
- * @return string The mapped type/class name
- */
- protected function getMappedType($type, $jvalue = null)
- {
- if (isset($this->classMap[$type])) {
- $target = $this->classMap[$type];
- } else {
- if (is_string($type) && $type !== '' && $type[0] == '\\'
- && isset($this->classMap[substr($type, 1)])
- ) {
- $target = $this->classMap[substr($type, 1)];
- } else {
- $target = null;
- }
- }
-
- if ($target) {
- if (is_callable($target)) {
- $type = $target($type, $jvalue);
- } else {
- $type = $target;
- }
- }
-
- return $type;
- }
-
- /**
- * Checks if the object is of this type or has this type as one of its parents
- *
- * @param string $type class name of type being required
- * @param mixed $value Some PHP value to be tested
- *
- * @return boolean True if $object has type of $type
- */
- protected function isObjectOfSameType($type, $value)
- {
- if (false === is_object($value)) {
- return false;
- }
-
- return is_a($value, $type);
- }
-
- /**
- * Returns true if type is an array of elements
- * (bracket notation)
- *
- * @param string $strType type to be matched
- *
- * @return bool
- */
- protected function isArrayOfType($strType)
- {
- return substr($strType, -2) === '[]';
- }
-
- /**
- * Create a new object of the given type.
- *
- * This method exists to be overwritten in child classes,
- * so you can do dependency injection or so.
- *
- * @param string $class Class name to instantiate
- * @param boolean $useParameter Pass $parameter to the constructor or not
- * @param mixed $jvalue Constructor parameter (the json value)
- *
- * @return object Freshly created object
- */
- public function createInstance(
- $class,
- $useParameter = false,
- $jvalue = null
- ) {
- if ($useParameter) {
- return new $class($jvalue);
- } else {
- $reflectClass = new ReflectionClass($class);
- $constructor = $reflectClass->getConstructor();
- if (null === $constructor
- || $constructor->getNumberOfRequiredParameters() > 0
- ) {
- return $reflectClass->newInstanceWithoutConstructor();
- }
-
- return $reflectClass->newInstance();
- }
- }
-
- /**
- * Checks if the given type is a type that is not nested
- * (simple type except array and object)
- *
- * @param string $type type name from gettype()
- *
- * @return boolean True if it is a non-nested PHP type
- *
- * @see isSimpleType()
- */
- protected function isFlatType($type)
- {
- return $type == 'NULL'
- || $type == 'string'
- || $type == 'boolean' || $type == 'bool'
- || $type == 'integer' || $type == 'int'
- || $type == 'double' || $type == 'float';
- }
-
- /**
- * Map an array
- *
- * @param array $json JSON array structure from json_decode()
- * @param mixed $array Array or ArrayObject that gets filled with
- * data from $json
- * @param string $class Class name for children objects.
- * All children will get mapped onto this type.
- * Supports class names and simple types
- * like "string" and nullability "string|null".
- * Pass "null" to not convert any values
- * @param string $parent_key Defines the key this array belongs to
- * in order to aid debugging.
- *
- * @return mixed Mapped $array is returned
- */
- public function mapArray($json, $array, $class = null, $parent_key = '')
- {
- $originalClass = $class;
- foreach ($json as $key => $jvalue) {
- $class = $this->getMappedType($originalClass, $jvalue);
- if ($class === null) {
- $array[$key] = $jvalue;
- } else {
- if ($this->isArrayOfType($class)) {
- $array[$key] = $this->mapArray(
- $jvalue,
- [],
- substr($class, 0, -2)
- );
- } else {
- if ($this->isFlatType(gettype($jvalue))) {
- //use constructor parameter if we have a class
- // but only a flat type (i.e. string, int)
- if ($jvalue === null) {
- $array[$key] = null;
- } else {
- if ($this->isSimpleType($class)) {
- settype($jvalue, $class);
- $array[$key] = $jvalue;
- } else {
- $array[$key] = $this->createInstance(
- $class, true, $jvalue
- );
- }
- }
- } else {
- if ($this->isFlatType($class)) {
- throw new JsonMapperException(
- 'JSON property "'.($parent_key ? $parent_key : '?').'"'
- .' is an array of type "'.$class.'"'
- .' but contained a value of type'
- .' "'.gettype($jvalue).'"'
- );
- } else {
- if (is_a($class, 'ArrayObject', true)) {
- $array[$key] = $this->mapArray(
- $jvalue,
- $this->createInstance($class)
- );
- } else {
- $array[$key] = $this->map(
- $jvalue, $this->createInstance($class, false, $jvalue)
- );
- }
- }
- }
- }
- }
- }
-
- return $array;
- }
-
- /**
- * Check required properties exist in json
- *
- * @param array $providedProperties array with json properties
- * @param object $rc Reflection class to check
- *
- * @return void
- * @throws JsonMapperException
- *
- */
- protected function checkMissingData($providedProperties, ReflectionClass $rc)
- {
- foreach ($rc->getProperties() as $property) {
- $rprop = $rc->getProperty($property->name);
- $docblock = $rprop->getDocComment();
- $annotations = $this->parseAnnotations($docblock);
- if (isset($annotations['required'])
- && !isset($providedProperties[$property->name])
- ) {
- throw new JsonMapperException(
- 'Required property "'.$property->name.'" of class '
- .$rc->getName()
- .' is missing in JSON data'
- );
- }
- }
- }
-
- /**
- * Remove attributes from object that were not passed in JSON data.
- *
- * This is to avoid confusion between those that were actually passed
- * as NULL, and those that weren't provided at all.
- *
- * @param object $object Object to remove properties from
- * @param array $providedProperties Array with JSON properties
- *
- * @return void
- */
- protected function removeUndefinedAttributes($object, $providedProperties)
- {
- foreach (get_object_vars($object) as $propertyName => $dummy) {
- if (!isset($providedProperties[$propertyName])) {
- unset($object->{$propertyName});
- }
- }
- }
-
- /**
- * Sets a logger instance on the object
- *
- * @param LoggerInterface $logger PSR-3 compatible logger object
- *
- * @return null
- */
- public function setLogger($logger)
- {
- $this->logger = $logger;
- }
-}
diff --git a/src/BitPaySDK/Util/JsonMapper/JsonMapperException.php b/src/BitPaySDK/Util/JsonMapper/JsonMapperException.php
deleted file mode 100755
index bb63b362..00000000
--- a/src/BitPaySDK/Util/JsonMapper/JsonMapperException.php
+++ /dev/null
@@ -1,25 +0,0 @@
-bitPayCode.$this->bitPayMessage."-> ".$message;
-
- parent::__construct($message, 101);
- }
-}
\ No newline at end of file
diff --git a/src/BitPaySDK/Util/JsonMapperFactory.php b/src/BitPaySDK/Util/JsonMapperFactory.php
new file mode 100644
index 00000000..00557560
--- /dev/null
+++ b/src/BitPaySDK/Util/JsonMapperFactory.php
@@ -0,0 +1,25 @@
+
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
+class JsonMapperFactory
+{
+ public static function create(): \JsonMapper
+ {
+ $jsonMapper = new \JsonMapper();
+ $jsonMapper->bEnforceMapType = false;
+
+ return $jsonMapper;
+ }
+}
diff --git a/src/BitPaySDK/Util/RESTcli/RESTcli.php b/src/BitPaySDK/Util/RESTcli/RESTcli.php
index 2938c444..ed861de4 100644
--- a/src/BitPaySDK/Util/RESTcli/RESTcli.php
+++ b/src/BitPaySDK/Util/RESTcli/RESTcli.php
@@ -1,230 +1,442 @@
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ */
class RESTcli
{
/**
* @var GuzzleHttpClient
*/
- protected $_client;
+ protected GuzzleHttpClient $client;
/**
* @var string
*/
- protected $_baseUrl;
+ protected string $baseUrl;
/**
* @var PrivateKey
*/
- protected $_ecKey;
+ protected PrivateKey $ecKey;
/**
* @var string
*/
- protected $_identity;
+ protected string $identity;
- public function __construct(string $environment, PrivateKey $ecKey)
+ /**
+ * @var string
+ */
+ protected string $proxy;
+
+ /**
+ * RESTcli constructor.
+ * @param string $environment
+ * @param PrivateKey $ecKey
+ * @param string|null $proxy
+ * @throws BitPayException
+ */
+ public function __construct(string $environment, PrivateKey $ecKey, ?string $proxy = null)
{
- $this->_ecKey = $ecKey;
- $this->_baseUrl = $environment == Env::Test ? Env::TestUrl : Env::ProdUrl;
+ $this->ecKey = $ecKey;
+ $this->baseUrl = $environment == Env::TEST ? Env::TEST_URL : Env::PROD_URL;
+ $this->proxy = $proxy !== null ? trim($proxy) : '';
$this->init();
}
- public function init()
+ /**
+ * Initialize Client.
+ *
+ * @throws BitPayException
+ */
+ public function init(): void
{
try {
- $this->_identity = $this->_ecKey->getPublicKey()->__toString();
- $this->_client = new GuzzleHttpClient(
- [
- 'base_url' => $this->_baseUrl,
- 'defaults' => [
- 'headers' => [
- 'x-accept-version' => Env::BitpayApiVersion,
- 'x-bitpay-plugin-info' => Env::BitpayPluginInfo,
- 'x-bitpay-api-frame' => Env::BitpayApiFrame,
- 'x-bitpay-api-frame-version' => Env::BitpayApiFrameVersion,
- ],
+ $this->identity = $this->ecKey->getPublicKey()->__toString();
+ $config = [
+ 'base_url' => $this->baseUrl,
+ 'defaults' => [
+ 'headers' => [
+ 'x-accept-version' => Env::BITPAY_API_VERSION,
+ 'x-bitpay-plugin-info' => Env::BITPAY_PLUGIN_INFO,
+ 'x-bitpay-api-frame' => Env::BITPAY_API_FRAME,
+ 'x-bitpay-api-frame-version' => Env::BITPAY_API_FRAME_VERSION,
],
- ]);
+ ],
+ ];
+
+ if ($this->proxy !== '') {
+ $config['proxy'] = $this->proxy;
+ }
+
+ $this->client = new GuzzleHttpClient($config);
} catch (Exception $e) {
- throw new BitPayException("RESTcli init failed : ".$e->getMessage());
+ throw new BitPayException("RESTcli init failed : " . $e->getMessage());
}
}
- public function post($uri, array $formData = [], $signatureRequired = true): string
+ /**
+ * Send POST request.
+ *
+ * @param $uri
+ * @param array $formData
+ * @param bool $signatureRequired
+ * @return string (json)
+ * @throws BitPayException
+ */
+ public function post($uri, array $formData = [], bool $signatureRequired = true): string
{
try {
- $fullURL = $this->_baseUrl.$uri;
+ $fullURL = $this->baseUrl . $uri;
$headers = [
- 'Content-Type' => 'application/json',
- 'x-accept-version' => Env::BitpayApiVersion,
- 'x-bitpay-plugin-info' => Env::BitpayPluginInfo,
- 'x-bitpay-api-frame' => Env::BitpayApiFrame,
- 'x-bitpay-api-frame-version' => Env::BitpayApiFrameVersion,
+ 'Content-Type' => 'application/json',
+ 'x-accept-version' => Env::BITPAY_API_VERSION,
+ 'x-bitpay-plugin-info' => Env::BITPAY_PLUGIN_INFO,
+ 'x-bitpay-api-frame' => Env::BITPAY_API_FRAME,
+ 'x-bitpay-api-frame-version' => Env::BITPAY_API_FRAME_VERSION,
];
if ($signatureRequired) {
- $headers['x-signature'] = $this->_ecKey->sign($fullURL.json_encode($formData));
- $headers['x-identity'] = $this->_identity;
+ $headers['x-signature'] = $this->ecKey->sign($fullURL . json_encode($formData));
+ $headers['x-identity'] = $this->identity;
}
/**
* @var Response
*/
- $response = $this->_client->requestAsync(
- 'POST', $fullURL, [
- $options[RequestOptions::SYNCHRONOUS] = false,
+ $response = $this->client->requestAsync(
+ 'POST',
+ $fullURL,
+ [
+ false,
'headers' => $headers,
RequestOptions::JSON => $formData,
- ])->wait();
-
- $responseJson = $this->responseToJsonString($response);
-
- return $responseJson;
+ ]
+ )->wait();
+
+ return $this->responseToJsonString($response);
+ } catch (BadResponseException $e) {
+ $errorJson = $this->responseToJsonString($e->getResponse());
+ throw new BitPayException(
+ "POST failed : Guzzle/BadResponseException : " .
+ $errorJson['message'],
+ $errorJson['code']
+ );
+ } catch (ClientException $e) {
+ throw new BitPayException("POST failed : Guzzle/ClientException : " . $e->getMessage());
+ } catch (ConnectException $e) {
+ throw new BitPayException("POST failed : Guzzle/ConnectException : " . $e->getMessage());
+ } catch (GuzzleException $e) {
+ throw new BitPayException("POST failed : Guzzle/GuzzleException : " . $e->getMessage());
+ } catch (InvalidArgumentException $e) {
+ throw new BitPayException("POST failed : Guzzle/InvalidArgumentException : " . $e->getMessage());
+ } catch (RequestException $e) {
+ throw new BitPayException("POST failed : Guzzle/RequestException : " . $e->getMessage());
+ } catch (ServerException $e) {
+ throw new BitPayException("POST failed : Guzzle/ServerException : " . $e->getMessage());
+ } catch (TooManyRedirectsException $e) {
+ throw new BitPayException("POST failed : Guzzle/TooManyRedirectsException : " . $e->getMessage());
} catch (Exception $e) {
- throw new BitPayException("POST failed : ".$e->getMessage());
+ throw new BitPayException("POST failed : " . $e->getMessage());
}
}
- public function get($uri, array $parameters = null, $signatureRequired = true): string
+ /**
+ * Send GET request.
+ *
+ * @param $uri
+ * @param array|null $parameters
+ * @param bool $signatureRequired
+ * @return string (json)
+ * @throws BitPayException
+ */
+ public function get($uri, array $parameters = null, bool $signatureRequired = true): string
{
try {
- $fullURL = $this->_baseUrl.$uri;
+ $fullURL = $this->baseUrl . $uri;
$headers = [
- 'Content-Type' => 'application/json',
- 'x-accept-version' => Env::BitpayApiVersion,
- 'x-bitpay-plugin-info' => Env::BitpayPluginInfo,
- 'x-bitpay-api-frame' => Env::BitpayApiFrame,
- 'x-bitpay-api-frame-version' => Env::BitpayApiFrameVersion,
+ 'Content-Type' => 'application/json',
+ 'x-accept-version' => Env::BITPAY_API_VERSION,
+ 'x-bitpay-plugin-info' => Env::BITPAY_PLUGIN_INFO,
+ 'x-bitpay-api-frame' => Env::BITPAY_API_FRAME,
+ 'x-bitpay-api-frame-version' => Env::BITPAY_API_FRAME_VERSION,
];
if ($parameters) {
- $fullURL .= '?'.http_build_query($parameters);
+ $fullURL .= '?' . http_build_query($parameters);
}
if ($signatureRequired) {
- $headers['x-signature'] = $this->_ecKey->sign($fullURL);
- $headers['x-identity'] = $this->_identity;
+ $headers['x-signature'] = $this->ecKey->sign($fullURL);
+ $headers['x-identity'] = $this->identity;
}
/**
* @var Response
*/
- $response = $this->_client->requestAsync(
- 'GET', $fullURL, [
+ $response = $this->client->requestAsync(
+ 'GET',
+ $fullURL,
+ [
$options[RequestOptions::SYNCHRONOUS] = false,
'headers' => $headers,
'query' => $parameters,
- ])->wait();
-
- $responseJson = $this->responseToJsonString($response);
-
- return $responseJson;
+ ]
+ )->wait();
+
+ return $this->responseToJsonString($response);
+ } catch (BadResponseException $e) {
+ $errorJson = $this->responseToJsonString($e->getResponse());
+ throw new BitPayException(
+ "GET failed : Guzzle/BadResponseException : " .
+ $errorJson['message'],
+ $errorJson['code']
+ );
+ } catch (ClientException $e) {
+ throw new BitPayException("GET failed : Guzzle/ClientException : " . $e->getMessage());
+ } catch (ConnectException $e) {
+ throw new BitPayException("GET failed : Guzzle/ConnectException : " . $e->getMessage());
+ } catch (GuzzleException $e) {
+ throw new BitPayException("GET failed : Guzzle/GuzzleException : " . $e->getMessage());
+ } catch (InvalidArgumentException $e) {
+ throw new BitPayException("GET failed : Guzzle/InvalidArgumentException : " . $e->getMessage());
+ } catch (RequestException $e) {
+ throw new BitPayException("GET failed : Guzzle/RequestException : " . $e->getMessage());
+ } catch (ServerException $e) {
+ throw new BitPayException("GET failed : Guzzle/ServerException : " . $e->getMessage());
+ } catch (TooManyRedirectsException $e) {
+ throw new BitPayException("GET failed : Guzzle/TooManyRedirectsException : " . $e->getMessage());
} catch (Exception $e) {
- throw new BitPayException("GET failed : ".$e->getMessage());
+ throw new BitPayException("GET failed : " . $e->getMessage());
}
}
+ /**
+ * Send DELETE request.
+ *
+ * @param $uri
+ * @param array|null $parameters
+ * @return string
+ * @throws BitPayException
+ */
public function delete($uri, array $parameters = null): string
{
try {
- $fullURL = $this->_baseUrl.$uri;
+ $fullURL = $this->baseUrl . $uri;
if ($parameters) {
- $fullURL .= '?'.http_build_query($parameters);
+ $fullURL .= '?' . http_build_query($parameters);
}
$headers = [
- 'x-accept-version' => Env::BitpayApiVersion,
- 'x-bitpay-plugin-info' => Env::BitpayPluginInfo,
- 'x-bitpay-api-frame' => Env::BitpayApiFrame,
- 'x-bitpay-api-frame-version' => Env::BitpayApiFrameVersion,
- 'Content-Type' => 'application/json',
- 'x-signature' => $this->_ecKey->sign($fullURL),
- 'x-identity' => $this->_identity,
+ 'x-accept-version' => Env::BITPAY_API_VERSION,
+ 'x-bitpay-plugin-info' => Env::BITPAY_PLUGIN_INFO,
+ 'x-bitpay-api-frame' => Env::BITPAY_API_FRAME,
+ 'x-bitpay-api-frame-version' => Env::BITPAY_API_FRAME_VERSION,
+ 'Content-Type' => 'application/json',
+ 'x-signature' => $this->ecKey->sign($fullURL),
+ 'x-identity' => $this->identity,
];
/**
* @var Response
*/
- $response = $this->_client->requestAsync(
- 'DELETE', $fullURL, [
+ $response = $this->client->requestAsync(
+ 'DELETE',
+ $fullURL,
+ [
$options[RequestOptions::SYNCHRONOUS] = false,
'headers' => $headers,
'query' => $parameters,
- ])->wait();
-
- $responseJson = $this->responseToJsonString($response);
-
- return $responseJson;
+ ]
+ )->wait();
+
+ return $this->responseToJsonString($response);
+ } catch (BadResponseException $e) {
+ $errorJson = $this->responseToJsonString($e->getResponse());
+ throw new BitPayException(
+ "DELETE failed : Guzzle/BadResponseException : " .
+ $errorJson['message'],
+ $errorJson['code']
+ );
+ } catch (ClientException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/ClientException : " . $e->getMessage());
+ } catch (ConnectException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/ConnectException : " . $e->getMessage());
+ } catch (GuzzleException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/GuzzleException : " . $e->getMessage());
+ } catch (InvalidArgumentException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/InvalidArgumentException : " . $e->getMessage());
+ } catch (RequestException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/RequestException : " . $e->getMessage());
+ } catch (ServerException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/ServerException : " . $e->getMessage());
+ } catch (TooManyRedirectsException $e) {
+ throw new BitPayException("DELETE failed : Guzzle/TooManyRedirectsException : " . $e->getMessage());
} catch (Exception $e) {
- throw new BitPayException("DELETE failed : ".$e->getMessage());
+ throw new BitPayException("DELETE failed : " . $e->getMessage());
}
}
+ /**
+ * Send PUT request.
+ *
+ * @param $uri
+ * @param array $formData
+ * @return string
+ * @throws BitPayException
+ */
public function update($uri, array $formData = []): string
{
try {
- $fullURL = $this->_baseUrl.$uri;
+ $fullURL = $this->baseUrl . $uri;
$headers = [
- 'x-accept-version' => Env::BitpayApiVersion,
- 'x-bitpay-plugin-info' => Env::BitpayPluginInfo,
- 'x-bitpay-api-frame' => Env::BitpayApiFrame,
- 'x-bitpay-api-frame-version' => Env::BitpayApiFrameVersion,
- 'Content-Type' => 'application/json',
- 'x-signature' => $this->_ecKey->sign($fullURL.json_encode($formData)),
- 'x-identity' => $this->_identity,
+ 'x-accept-version' => Env::BITPAY_API_VERSION,
+ 'x-bitpay-plugin-info' => Env::BITPAY_PLUGIN_INFO,
+ 'x-bitpay-api-frame' => Env::BITPAY_API_FRAME,
+ 'x-bitpay-api-frame-version' => Env::BITPAY_API_FRAME_VERSION,
+ 'Content-Type' => 'application/json',
+ 'x-signature' => $this->ecKey->sign($fullURL . json_encode($formData)),
+ 'x-identity' => $this->identity,
];
/**
* @var Response
*/
- $response = $this->_client->requestAsync(
- 'PUT', $fullURL, [
+ $response = $this->client->requestAsync(
+ 'PUT',
+ $fullURL,
+ [
$options[RequestOptions::SYNCHRONOUS] = false,
'headers' => $headers,
RequestOptions::JSON => $formData,
- ])->wait();
-
- $responseJson = $this->responseToJsonString($response);
-
- return $responseJson;
+ ]
+ )->wait();
+
+ return $this->responseToJsonString($response);
+ } catch (BadResponseException $e) {
+ $errorJson = $this->responseToJsonString($e->getResponse());
+ throw new BitPayException(
+ "UPDATE failed : Guzzle/BadResponseException : " .
+ $errorJson['message'],
+ $errorJson['code']
+ );
+ } catch (ClientException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/ClientException : " . $e->getMessage());
+ } catch (ConnectException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/ConnectException : " . $e->getMessage());
+ } catch (GuzzleException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/GuzzleException : " . $e->getMessage());
+ } catch (InvalidArgumentException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/InvalidArgumentException : " . $e->getMessage());
+ } catch (RequestException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/RequestException : " . $e->getMessage());
+ } catch (ServerException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/ServerException : " . $e->getMessage());
+ } catch (TooManyRedirectsException $e) {
+ throw new BitPayException("UPDATE failed : Guzzle/TooManyRedirectsException : " . $e->getMessage());
} catch (Exception $e) {
- throw new BitPayException("UPDATE failed : ".$e->getMessage());
+ throw new BitPayException("UPDATE failed : " . $e->getMessage());
}
}
+ /**
+ * Convert Response object into json
+ *
+ * @param Response $response
+ * @return string
+ * @throws BitPayException
+ * @throws Exception
+ */
public function responseToJsonString(Response $response): string
{
- if ($response == null) {
- throw new Exception("Error: HTTP response is null");
- }
-
try {
- $body = json_decode($response->getBody()->getContents(), true);
+ $body = json_decode($response->getBody()->getContents(), true, 512, JSON_THROW_ON_ERROR);
+ if ($this->proxy !== '' && !is_array($body)) {
+ throw new BitPayException(
+ "Please check your proxy settings, HTTP Code:" .
+ $response->getStatusCode() .
+ ", failed to decode json: " .
+ json_last_error_msg()
+ );
+ }
+
+ if ($this->isErrorStatus($body)) {
+ throw new BitpayException($body['message'], null, null, (string)$body['code']);
+ }
+
$error_message = false;
$error_message = (!empty($body['error'])) ? $body['error'] : $error_message;
$error_message = (!empty($body['errors'])) ? $body['errors'] : $error_message;
- $error_message = (is_array($error_message)) ? implode("\n", $error_message) : $error_message;
+
+ if (is_array($error_message)) {
+ if (count($error_message) == count($error_message, 1)) {
+ $error_message = implode("\n", $error_message);
+ } else {
+ $errors = array();
+ foreach ($error_message as $error) {
+ $errors[] = $error['param'] . ": " . $error['error'];
+ }
+ $error_message = implode(',', $errors);
+ }
+ }
+
if (false !== $error_message) {
throw new BitpayException($error_message);
}
+
if (!empty($body['success'])) {
return json_encode($body);
}
- return json_encode($body['data']);
+ // TODO Temporary fix for legacy response
+ if (!array_key_exists('data', $body)) {
+ return json_encode($body);
+ }
+ return json_encode($body['data']);
+ } catch (BitpayException $e) {
+ throw new BitPayException(
+ "failed to retrieve HTTP response body : " .
+ $e->getMessage(),
+ null,
+ null,
+ $e->getApiCode()
+ );
} catch (Exception $e) {
- throw new BitPayException("failed to retrieve HTTP response body : ".$e->getMessage());
+ throw new BitPayException("failed to retrieve HTTP response body : " . $e->getMessage());
}
}
-}
\ No newline at end of file
+ /**
+ * @param array $body
+ * @return bool
+ */
+ private function isErrorStatus(array $body): bool
+ {
+ return !empty($body['status']) && $body['status'] === 'error';
+ }
+}
diff --git a/test/functional/BitPaySDK/.gitignore b/test/functional/BitPaySDK/.gitignore
new file mode 100644
index 00000000..4853edf2
--- /dev/null
+++ b/test/functional/BitPaySDK/.gitignore
@@ -0,0 +1,3 @@
+BitPay.config.yml
+email.txt
+PrivateKeyName.key
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/AbstractClientTestCase.php b/test/functional/BitPaySDK/AbstractClientTestCase.php
new file mode 100644
index 00000000..4b072e42
--- /dev/null
+++ b/test/functional/BitPaySDK/AbstractClientTestCase.php
@@ -0,0 +1,21 @@
+client = Client::createWithFile(Config::FUNCTIONAL_TEST_PATH . DIRECTORY_SEPARATOR . Config::BITPAY_CONFIG_FILE);
+ }
+}
diff --git a/test/functional/BitPaySDK/BillClientTest.php b/test/functional/BitPaySDK/BillClientTest.php
new file mode 100644
index 00000000..d82f07cc
--- /dev/null
+++ b/test/functional/BitPaySDK/BillClientTest.php
@@ -0,0 +1,97 @@
+getBillExample();
+ $bill->setEmail("john@doe.com");
+ $bill = $this->client->createBill($bill);
+
+ self::assertEquals('draft', $bill->getStatus());
+ self::assertEquals(1, $bill->getItems()[0]->getQuantity());
+ self::assertEquals(6.0, $bill->getItems()[0]->getPrice());
+ self::assertEquals(4.0, $bill->getItems()[1]->getPrice());
+ self::assertEquals(1, $bill->getItems()[1]->getQuantity());
+ self::assertEquals("Test Item 1", $bill->getItems()[0]->getDescription());
+ self::assertEquals("Test Item 2", $bill->getItems()[1]->getDescription());
+ self::assertEquals("Test Item 2", $bill->getItems()[1]->getDescription());
+ self::assertEquals("USD", $bill->getCurrency());
+ }
+
+ public function testGetBill(): void
+ {
+ $bill = $this->getBillExample();
+ $bill->setEmail("john@doe.com");
+ $bill = $this->client->createBill($bill);
+ $bill = $this->client->getBill($bill->getId());
+
+ self::assertEquals('draft', $bill->getStatus());
+ self::assertEquals(2, count($bill->getItems()));
+ self::assertEquals('USD', $bill->getCurrency());
+ self::assertEquals('bill1234-ABCD', $bill->getNumber());
+ self::assertEquals('john@doe.com', $bill->getEmail());
+ }
+
+ public function testGetBills(): void
+ {
+ $bills = $this->client->getBills();
+
+ self::assertNotNull($bills);
+ self::assertIsArray($bills);
+ $isCount = count($bills) > 0;
+ self::assertTrue($isCount);
+ }
+ public function testUpdateBill(): void
+ {
+ $bill = $this->getBillExample();
+ $bill->setEmail("john@doe.com");
+ $bill = $this->client->createBill($bill);
+ $bill = $this->client->getBill($bill->getId());
+ $bill->setEmail('test@gmail.com');
+ $bill = $this->client->updateBill($bill, $bill->getId());
+
+ self::assertEquals('test@gmail.com', $bill->getEmail());
+ }
+
+ public function testDeliverBill(): void
+ {
+
+ $bill = $this->getBillExample();
+ $bill->setEmail("john@doe.com");
+ $bill = $this->client->createBill($bill);
+
+ $bill = $this->client->getBill($bill->getId());
+ $result = $this->client->deliverBill($bill->getId(), $bill->getToken());
+
+ self::assertTrue($result);
+ }
+
+ private function getBillExample(): Bill
+ {
+ $items = [];
+ $item = new Item();
+ $item->setPrice(6.0);
+ $item->setQuantity(1);
+ $item->setDescription("Test Item 1");
+ $items[] = $item;
+
+ $item = new Item();
+ $item->setPrice(4.0);
+ $item->setQuantity(1);
+ $item->setDescription("Test Item 2");
+ $items[] = $item;
+
+ return new Bill("bill1234-ABCD", Currency::USD, "", $items);
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/Config.php b/test/functional/BitPaySDK/Config.php
new file mode 100644
index 00000000..1d690f3f
--- /dev/null
+++ b/test/functional/BitPaySDK/Config.php
@@ -0,0 +1,12 @@
+getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+
+ self::assertEquals('new', $baseInvoice->getStatus());
+ self::assertEquals('USD', $baseInvoice->getCurrency());
+ self::assertEquals(50.0, $baseInvoice->getPrice());
+ self::assertEquals('Test', $baseInvoice->getBuyer()->getName());
+ self::assertEquals('168 General Grove', $baseInvoice->getBuyer()->getAddress1());
+ self::assertEquals('Port Horizon', $baseInvoice->getBuyer()->getLocality());
+ self::assertEquals('New Port', $baseInvoice->getBuyer()->getRegion());
+ }
+
+ public function testGetInvoice(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->getInvoice($baseInvoice->getId());
+
+ self::assertEquals('new', $baseInvoice->getStatus());
+ self::assertEquals(50.0, $baseInvoice->getPrice());
+ self::assertEquals('Test', $baseInvoice->getBuyer()->getName());
+ self::assertEquals('168 General Grove', $baseInvoice->getBuyer()->getAddress1());
+ self::assertInstanceOf(Invoice::class, $baseInvoice);
+ self::assertNotNull($baseInvoice);
+ }
+
+ public function testGetInvoiceByGuid(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->getInvoiceByGuid($baseInvoice->getGuid());
+
+ self::assertEquals('new', $baseInvoice->getStatus());
+ self::assertEquals(50.0, $baseInvoice->getPrice());
+ self::assertEquals('Test', $baseInvoice->getBuyer()->getName());
+ self::assertEquals('168 General Grove', $baseInvoice->getBuyer()->getAddress1());
+ self::assertInstanceOf(Invoice::class, $baseInvoice);
+ self::assertNotNull($baseInvoice);
+ }
+
+ public function testUpdateInvoice(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->getInvoice($baseInvoice->getId());
+
+ $updateInvoice = $this->client->updateInvoice(
+ $baseInvoice->getId(),
+ '',
+ '',
+ 'test1@email.com'
+ );
+
+ self::assertEquals('test1@email.com', $updateInvoice->getBuyer()->getEmail());
+ }
+
+ public function testGetInvoices(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-30 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $invoices = $this->client->getInvoices($dateStart, $dateEnd, 'new', null, 1);
+
+ self::assertCount(1, $invoices);
+ self::assertTrue(count($invoices) > 0);
+ self::assertNotNull($invoices);
+ }
+
+ public function testCancel(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->getInvoice($baseInvoice->getId());
+ $cancelInvoice = $this->client->cancelInvoice($baseInvoice->getId());
+
+ self::assertEquals('expired', $cancelInvoice->getStatus());
+ }
+
+ public function testCancelInvoiceByGuid()
+ {
+ $invoice = $this->getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->cancelInvoiceByGuid($baseInvoice->getGuid());
+
+ self::assertEquals('expired', $baseInvoice->getStatus());
+ self::assertEquals(50.0, $baseInvoice->getPrice());
+ self::assertInstanceOf(Invoice::class, $baseInvoice);
+ self::assertNotNull($baseInvoice);
+ }
+
+ public function testPayInvoice(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $invoice = $this->client->createInvoice($invoice);
+ $invoice = $this->client->payInvoice($invoice->getId());
+
+ self::assertEquals('confirmed', $invoice->getStatus());
+ }
+
+ private function getInvoiceExample(): Invoice
+ {
+ $invoice = new Invoice(50.0, "USD");
+ $invoice->setFullNotifications(true);
+ $invoice->setExtendedNotifications(true);
+ $invoice->setNotificationURL("https://test/lJnJg9WW7MtG9GZlPVdj");
+ $invoice->setRedirectURL("https://test/lJnJg9WW7MtG9GZlPVdj");
+ $invoice->setItemDesc("Created by PHP functional test");
+ $invoice->setNotificationEmail("");
+ $invoice->setBuyerSms('+12223334445');
+
+ $buyer = new Buyer();
+ $buyer->setName("Test");
+ $buyer->setEmail("test@email.com");
+ $buyer->setAddress1("168 General Grove");
+ $buyer->setCountry("AD");
+ $buyer->setLocality("Port Horizon");
+ $buyer->setNotify(true);
+ $buyer->setPhone("+990123456789");
+ $buyer->setPostalCode("KY7 1TH");
+ $buyer->setRegion("New Port");
+
+ $invoice->setBuyer($buyer);
+
+ return $invoice;
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/LedgerClientTest.php b/test/functional/BitPaySDK/LedgerClientTest.php
new file mode 100644
index 00000000..bfd94e77
--- /dev/null
+++ b/test/functional/BitPaySDK/LedgerClientTest.php
@@ -0,0 +1,46 @@
+client->getLedgerEntries($currency, $startDate, $endDate);
+ if (!empty($ledgers)) {
+ self::assertEquals($currency, $ledgers[0]->getInvoiceCurrency());
+ }
+
+ self::assertCount(count($ledgers), $ledgers);
+ self::assertNotNull($ledgers);
+ self::assertIsArray($ledgers);
+ }
+
+ public function testGetLedgers(): void
+ {
+ $ledgers = $this->client->getLedgers();
+
+ self::assertIsArray($ledgers);
+ self::assertCount(count($ledgers), $ledgers);
+ }
+
+ public function testGetLedgerShouldCatchRestCliException(): void
+ {
+ $currency = 'USD';
+ $startDate = '2020-05-12T13:00:45.063Z';
+ $endDate = '2022-05-13T13:00:45.063Z';
+
+ $this->expectException(LedgerQueryException::class);
+ $this->client->getLedgerEntries($currency, $startDate, $endDate);
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/PayoutClientTest.php b/test/functional/BitPaySDK/PayoutClientTest.php
new file mode 100644
index 00000000..7d613e24
--- /dev/null
+++ b/test/functional/BitPaySDK/PayoutClientTest.php
@@ -0,0 +1,106 @@
+getEmailFromFile(Config::FUNCTIONAL_TEST_PATH . DIRECTORY_SEPARATOR . 'email.txt');
+ $submitPayout = $this->submitPayout($currency, $ledgerCurrency, $amount);
+ self::assertEquals($currency, $submitPayout->getCurrency());
+ $payoutId = $submitPayout->getId();
+ $payout = $this->client->getPayout($payoutId);
+ self::assertEquals(10, $payout->getAmount());
+ self::assertEquals($email, $payout->getNotificationEmail());
+
+ $startDate = '2022-10-20T13:00:45.063Z';
+ $endDate = '2023-01-01T13:00:45.063Z';
+
+ $payouts = $this->client->getPayouts($startDate, $endDate);
+ self::assertIsArray($payouts);
+ self::assertCount(count($payouts), $payouts);
+
+ $requestPayoutNotification = $this->client->requestPayoutNotification($payoutId);
+ self::assertTrue($requestPayoutNotification);
+
+ $cancelledPayout = $this->client->cancelPayout($payoutId);
+ self::assertTrue($cancelledPayout);
+ }
+
+ /**
+ * @throws BitPayException
+ * @throws \BitPaySDK\Exceptions\PayoutCancellationException
+ * @throws \BitPaySDK\Exceptions\PayoutCreationException
+ */
+ public function testPayoutGroupRequests(): void
+ {
+ $payout = new Payout();
+ $payout->setAmount(10);
+ $payout->setCurrency(Currency::USD);
+ $payout->setLedgerCurrency(Currency::USD);
+ $payout->setReference('payout_20210527');
+ $payout->setNotificationEmail('merchant@email.com');
+ $payout->setNotificationURL('https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx');
+ $payout->setEmail($this->getEmailFromFile(Config::FUNCTIONAL_TEST_PATH . DIRECTORY_SEPARATOR . 'email.txt'));
+
+ $createGroupResponse = $this->client->createPayoutGroup([$payout]);
+ self::assertCount(1, $createGroupResponse->getPayouts());
+ self::assertEquals(PayoutStatus::NEW, $createGroupResponse->getPayouts()[0]->getStatus());
+
+ $groupId = $createGroupResponse->getPayouts()[0]->getGroupId();
+ $cancelGroupResponse = $this->client->cancelPayoutGroup($groupId);
+ self::assertEquals(PayoutStatus::CANCELLED, $cancelGroupResponse->getPayouts()[0]->getStatus());
+ }
+
+ private function submitPayout(string $currency, string $ledgerCurrency, int $amount)
+ {
+ $email = $this->getEmailFromFile(Config::FUNCTIONAL_TEST_PATH . DIRECTORY_SEPARATOR . 'email.txt');
+ $payout = new Payout($amount, $currency, $ledgerCurrency);
+
+ $recipientsList = [
+ new PayoutRecipient(
+ $email,
+ "recipient1",
+ "https://yournotiticationurl.com/b3sarz5bg0wx01eq1bv9785amx")
+ ];
+
+ $recipients = new PayoutRecipients($recipientsList);
+ $payoutRecipients = $this->client->submitPayoutRecipients($recipients);
+ $payoutRecipientId = $payoutRecipients[0]->getId();
+
+ $payout->setRecipientId($payoutRecipientId);
+ $payout->setNotificationURL("https://somenotiticationurl.com/");
+ $payout->setNotificationEmail($email);
+ $payout->setReference("PHP functional tests " . uniqid('', true));
+ $payout->setTransactions([]);
+
+ return $this->client->submitPayout($payout);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ private function getEmailFromFile(string $path): string
+ {
+ if (!file_exists($path)) {
+ throw new BitPayException("Please create email.txt with your email: " . $path);
+ }
+
+ return file_get_contents($path);
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/PayoutRecipientsClientTest.php b/test/functional/BitPaySDK/PayoutRecipientsClientTest.php
new file mode 100644
index 00000000..d0f2351e
--- /dev/null
+++ b/test/functional/BitPaySDK/PayoutRecipientsClientTest.php
@@ -0,0 +1,140 @@
+client->submitPayoutRecipients($recipients);
+
+ self::assertCount(1, $payoutRecipients);
+ self::assertEquals('test@emaill1.com', $payoutRecipients[0]->getEmail());
+ self::assertEquals('recipient1', $payoutRecipients[0]->getLabel());
+ self::assertEquals(
+ 'invited',
+ $payoutRecipients[0]->getStatus()
+ );
+ }
+
+ public function testGetPayoutRecipient()
+ {
+ $recipientsList = [
+ new PayoutRecipient(
+ "test@emaill1.com",
+ "recipient1",
+ "https://yournotiticationurl.com/b3sarz5bg0wx01eq1bv9785amx")
+ ];
+
+ $recipients = new PayoutRecipients($recipientsList);
+ $payoutRecipients = $this->client->submitPayoutRecipients($recipients);
+
+ $recipientId = $payoutRecipients[0]->getId();
+ $recipient = $this->client->getPayoutRecipient($recipientId);
+
+ self::assertEquals($recipientId, $recipient->getId());
+ self::assertEquals('test@emaill1.com', $recipient->getEmail());
+ self::assertEquals('recipient1', $recipient->getLabel());
+ self::assertEquals('invited', $recipient->getStatus());
+ self::assertEquals(null, $recipient->getShopperId());
+ }
+
+ public function testPayoutRecipientShouldCatchRestCliException(): void
+ {
+ $recipientId = 'JA4cEtmBxCp5cybtnh1rds';
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $this->client->getPayoutRecipient($recipientId);
+ }
+
+ public function testGetPayoutRecipients(): void
+ {
+ $recipients = $this->client->getPayoutRecipients('invited', 1);
+
+ self::assertCount(1, $recipients);
+ self::assertEquals('invited', $recipients[0]->getStatus());
+ self::assertNotNull($recipients);
+ }
+
+ public function testUpdatePayoutRecipients(): void
+ {
+ $label = 'updateLabel';
+ $recipientsList = [
+ new PayoutRecipient(
+ "test@emaill1.com",
+ "recipient1",
+ "https://yournotiticationurl.com/b3sarz5bg0wx01eq1bv9785amx")
+ ];
+
+ $recipients = new PayoutRecipients($recipientsList);
+ $payoutRecipients = $this->client->submitPayoutRecipients($recipients);
+ $payoutRecipient = $payoutRecipients[0];
+ $payoutRecipient->setLabel($label);
+
+ $updateRecipient = $this->client->updatePayoutRecipient($payoutRecipient->getId(), $payoutRecipient);
+
+ self::assertEquals($label, $updateRecipient->getLabel());
+ self::assertEquals('test@emaill1.com', $updateRecipient->getEmail());
+ self::assertEquals('invited', $updateRecipient->getStatus());
+ self::assertEquals($payoutRecipient->getId(), $updateRecipient->getId());
+ }
+
+ public function testDeletePayoutRecipient(): void
+ {
+ $recipientsList = [
+ new PayoutRecipient(
+ "test@emaill1.com",
+ "recipient1",
+ "https://yournotiticationurl.com/b3sarz5bg0wx01eq1bv9785amx")
+ ];
+
+ $recipients = new PayoutRecipients($recipientsList);
+ $payoutRecipients = $this->client->submitPayoutRecipients($recipients);
+ $payoutRecipientId = $payoutRecipients[0]->getId();
+
+ $result = $this->client->deletePayoutRecipient($payoutRecipientId);
+
+ self::assertEquals(true, $result);
+ }
+
+ public function testPayoutRecipientRequestNotification(): void
+ {
+ $recipientsList = [
+ new PayoutRecipient(
+ "test@emaill1.com",
+ "recipient1",
+ "https://yournotiticationurl.com/b3sarz5bg0wx01eq1bv9785amx")
+ ];
+
+ $recipients = new PayoutRecipients($recipientsList);
+ $payoutRecipients = $this->client->submitPayoutRecipients($recipients);
+ $payoutRecipientId = $payoutRecipients[0]->getId();
+
+ $result = $this->client->requestPayoutRecipientNotification($payoutRecipientId);
+
+ self::assertEquals(true, $result);
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/RateClientTest.php b/test/functional/BitPaySDK/RateClientTest.php
new file mode 100644
index 00000000..f01948a7
--- /dev/null
+++ b/test/functional/BitPaySDK/RateClientTest.php
@@ -0,0 +1,41 @@
+client->getRates();
+ $ratesData = $rates->getRates();
+
+ self::assertCount(count($ratesData), $ratesData);
+ self::assertNotNull($rates);
+ self::assertIsArray($ratesData);
+ }
+
+ public function testGetCurrencyRates()
+ {
+ $rates = $this->client->getCurrencyRates('BTC');
+ $ratesData = $rates->getRates();
+
+ self::assertCount(count($ratesData), $ratesData);
+ self::assertNotNull($rates);
+ self::assertIsArray($ratesData);
+ }
+
+ public function testGetCurrencyPairRate(): void
+ {
+ $rate = $this->client->getCurrencyPairRate('BTC', 'USD');
+
+ self::assertInstanceOf(Rate::class, $rate);
+ self::assertEquals('USD', $rate->getCode());
+ self::assertEquals('US Dollar', $rate->getName());
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/RefundClientTest.php b/test/functional/BitPaySDK/RefundClientTest.php
new file mode 100644
index 00000000..64fd2320
--- /dev/null
+++ b/test/functional/BitPaySDK/RefundClientTest.php
@@ -0,0 +1,114 @@
+getInvoiceExample();
+ $baseInvoice = $this->client->createInvoice($invoice);
+ $baseInvoice = $this->client->payInvoice($baseInvoice->getId(), 'complete');
+ $refund = $this->client->createRefund($baseInvoice->getId(), 50.0, Currency::USD);
+
+ self::assertEquals(50.0, $refund->getAmount());
+ self::assertEquals('USD', $refund->getCurrency());
+ }
+
+ public function testCreateRefundShouldCatchRestCliException(): void
+ {
+ $invoice = $this->getInvoiceExample();
+ $invoice->setId('WoE46gSLkJQS48RJEiNw3L');
+ $this->expectException(RefundCreationException::class);
+
+ $this->client->createRefund($invoice->getId(), 50.0, Currency::USD, true);
+ }
+
+ public function testGetRefunds(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-30 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $invoices = $this->client->getInvoices($dateStart, $dateEnd, 'complete', null, 1);
+ $refunds = $this->client->getRefunds($invoices[0]->getId());
+
+ self::assertCount(1, $refunds);
+ self::assertNotNull($refunds);
+ self::assertIsArray($refunds);
+ self::assertEquals('complete', $invoices[0]->getStatus());
+ self::assertEquals('created', $refunds[0]->getStatus());
+ }
+
+ public function testGetRefund(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-30 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $invoices = $this->client->getInvoices($dateStart, $dateEnd, 'complete', null, 1);
+ $refunds = $this->client->getRefunds($invoices[0]->getId());
+ $refund = $this->client->getRefund($refunds[0]->getId());
+
+ self::assertInstanceOf(Refund::class, $refund);
+ self::assertEquals('complete', $invoices[0]->getStatus());
+ self::assertCount(1, $invoices);
+ self::assertEquals('created', $refund->getStatus());
+ }
+
+ public function testSendNotification(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-30 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $invoices = $this->client->getInvoices($dateStart, $dateEnd, 'complete', null, 1);
+ $refunds = $this->client->getRefunds($invoices[0]->getId());
+
+ self::assertTrue($this->client->sendRefundNotification($refunds[0]->getId()));
+ }
+
+ public function testCancelRefund(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-30 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $invoices = $this->client->getInvoices($dateStart, $dateEnd, 'complete', null, 1);
+ $refunds = $this->client->getRefunds($invoices[0]->getId());
+ $refundId = $refunds[0]->getId();
+ $refund = $this->client->cancelRefund($refundId);
+
+ self::assertInstanceOf(Refund::class, $refund);
+ self::assertNotNull($refund);
+ self::assertEquals('canceled', $refund->getStatus());
+ }
+
+ private function getInvoiceExample(): Invoice
+ {
+ $invoice = new Invoice(50.0, "USD");
+ $invoice->setFullNotifications(true);
+ $invoice->setExtendedNotifications(true);
+ $invoice->setNotificationURL("https://test/lJnJg9WW7MtG9GZlPVdj");
+ $invoice->setRedirectURL("https://test/lJnJg9WW7MtG9GZlPVdj");
+ $invoice->setItemDesc("Created by PHP functional test");
+ $invoice->setNotificationEmail("");
+
+ $buyer = new Buyer();
+ $buyer->setName("Test");
+ $buyer->setEmail("test@email.com");
+ $buyer->setAddress1("168 General Grove");
+ $buyer->setCountry("AD");
+ $buyer->setLocality("Port Horizon");
+ $buyer->setNotify(true);
+ $buyer->setPhone("+990123456789");
+ $buyer->setPostalCode("KY7 1TH");
+ $buyer->setRegion("New Port");
+
+ $invoice->setBuyer($buyer);
+
+ return $invoice;
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/SettlementsClientTest.php b/test/functional/BitPaySDK/SettlementsClientTest.php
new file mode 100644
index 00000000..02830fcc
--- /dev/null
+++ b/test/functional/BitPaySDK/SettlementsClientTest.php
@@ -0,0 +1,59 @@
+client->getSettlements($currency, $dateStart, $dateEnd, $status);
+
+ self::assertNotNull($settlements);
+ self::assertIsArray($settlements);
+ }
+
+ public function testGetSettlement(): void
+ {
+ $dateStart = date('Y-m-d', strtotime("-365 day"));
+ $status = 'processing';
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $currency = 'USD';
+
+ $settlements = $this->client->getSettlements($currency, $dateStart, $dateEnd, $status);
+
+ $settlement = $this->client->getSettlement($settlements[0]->getId());
+
+ self::assertNotNull($settlement);
+ self::assertInstanceOf(Settlement::class, $settlement);
+ self::assertEquals($currency, $settlement->getCurrency());
+ self::assertEquals($status, $settlement->getStatus());
+ }
+
+ public function testGetReconciliationReport(): void
+ {
+ $status = 'processing';
+ $dateStart = date('Y-m-d', strtotime("-365 day"));
+ $dateEnd = date("Y-m-d", strtotime("+1 day"));
+ $currency = 'USD';
+
+ $settlements = $this->client->getSettlements($currency, $dateStart, $dateEnd, $status);
+ $settlement = $this->client->getSettlement($settlements[0]->getId());
+ $settlement = $this->client->getSettlementReconciliationReport($settlement);
+
+ self::assertEquals('processing', $settlement->getStatus());
+ self::assertNotNull($settlement);
+ self::assertEquals('USD', $settlement->getCurrency());
+ self::assertEquals($status, $settlement->getStatus());
+ }
+}
\ No newline at end of file
diff --git a/test/functional/BitPaySDK/TokenClientTest.php b/test/functional/BitPaySDK/TokenClientTest.php
new file mode 100644
index 00000000..7adada71
--- /dev/null
+++ b/test/functional/BitPaySDK/TokenClientTest.php
@@ -0,0 +1,19 @@
+client->getTokens();
+
+ self::assertNotEmpty($tokens);
+ }
+}
diff --git a/test/functional/BitPaySDK/WalletClientTest.php b/test/functional/BitPaySDK/WalletClientTest.php
new file mode 100644
index 00000000..da39f5dc
--- /dev/null
+++ b/test/functional/BitPaySDK/WalletClientTest.php
@@ -0,0 +1,18 @@
+client->getSupportedWallets();
+
+ self::assertNotNull($supportedWallets);
+ self::assertIsArray($supportedWallets);
+ }
+}
diff --git a/test/unit/BitPaySDK/BitPay.config-unit.json b/test/unit/BitPaySDK/BitPay.config-unit.json
new file mode 100644
index 00000000..d11f73b5
--- /dev/null
+++ b/test/unit/BitPaySDK/BitPay.config-unit.json
@@ -0,0 +1,25 @@
+{
+ "BitPayConfiguration": {
+ "Environment": "Test",
+ "EnvConfig": {
+ "Test": {
+ "PrivateKeyPath": "test/unit/BitPaySDK/PrivateKeyNameUnit.key",
+ "PrivateKeySecret": "changedPassword",
+ "ApiTokens": {
+ "merchant": "testMerchantApiToken",
+ "payout": "testPayoutApiToken"
+ },
+ "proxy": null
+ },
+ "Prod": {
+ "PrivateKeyPath": null,
+ "PrivateKeySecret": null,
+ "ApiTokens": {
+ "merchant": null,
+ "payout": null
+ },
+ "proxy": null
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/BitPay.config-unit.yml b/test/unit/BitPaySDK/BitPay.config-unit.yml
new file mode 100644
index 00000000..e377eb6b
--- /dev/null
+++ b/test/unit/BitPaySDK/BitPay.config-unit.yml
@@ -0,0 +1,17 @@
+BitPayConfiguration:
+ Environment: Test
+ EnvConfig:
+ Test:
+ PrivateKeyPath: test/unit/BitPaySDK/PrivateKeyNameUnit.key
+ PrivateKeySecret: changedPassword
+ ApiTokens:
+ merchant: HpNyt429yg8mVtWwRJJs7A3CgK6qYesMoPfXUJxWhkh7
+ payout: 42dpWSzkv3EiJHcUUaLJ98JkhEJjrpCYzxuobCHo5DCZ
+ proxy: null
+ Prod:
+ PrivateKeyPath: null
+ PrivateKeySecret: null
+ ApiTokens:
+ merchant: null
+ payout: null
+ proxy: null
diff --git a/test/unit/BitPaySDK/ClientTest.php b/test/unit/BitPaySDK/ClientTest.php
new file mode 100644
index 00000000..a0623f98
--- /dev/null
+++ b/test/unit/BitPaySDK/ClientTest.php
@@ -0,0 +1,3576 @@
+refreshResourceClients();
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testWithData()
+ {
+ $tokens = $this->createMock(Tokens::class);
+ $result = $this->getTestedClassInstance()::createWithData(
+ Env::TEST,
+ __DIR__ . '/bitpay_private_test.key',
+ $tokens,
+ 'YourMasterPassword'
+ );
+
+ self::assertInstanceOf(Client::class, $result);
+ }
+
+ public function testWithDataException()
+ {
+ $instance = $this->getTestedClassInstance();
+ $tokens = $this->createMock(Tokens::class);
+ $this->expectException(BitPayException::class);
+
+ $instance::createWithData(
+ Env::TEST,
+ __DIR__ . '/bitpay_private_test.key',
+ $tokens,
+ 'badPassword'
+ );
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testWithFileJsonConfig(): Client
+ {
+ $instance = $this->getTestedClassInstance();
+ $result = $instance::createWithFile(__DIR__ . '/BitPay.config-unit.json');
+ self::assertInstanceOf(Client::class, $result);
+ return $result;
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testWithFileYmlConfig()
+ {
+ $instance = $this->getTestedClassInstance();
+ $result = $instance::createWithFile(__DIR__ . '/BitPay.config-unit.yml');
+ self::assertInstanceOf(Client::class, $result);
+ }
+
+ public function testWithFileException()
+ {
+ $instance = $this->getTestedClassInstance();
+ $this->expectException(BitPayException::class);
+ $instance::createWithFile('badpath');
+ }
+
+ public function testGetTokens(): void
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("tokens")
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/getTokensResponse.json'));
+
+ $tokenClient = $this->getClient($restCliMock);
+ $tokens = $tokenClient->getTokens();
+
+ self::assertEquals('someMerchantToken', $tokens[0]['merchant']);
+ }
+
+ public function testCreateBill()
+ {
+ $expectedId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $expectedStatus = 'draft';
+ $expectedToken = 'qVVgRARN6fKtNZ7Tcq6qpoPBBE3NxdrmdMD883RyMK4Pf8EHENKVxCXhRwyynWveo';
+
+ $billMock = $this->createMock(Bill::class);
+ $billToArray = [
+ 'id' => $expectedId,
+ 'status' => $expectedStatus,
+ 'token' => $expectedToken,
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills", $billMock->toArray(), true)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/createBillResponse.json'));
+
+ $billClient = $this->getClient($restCliMock);
+ $createdBill = $billClient->createBill($billMock, Facade::MERCHANT);
+
+ self::assertEquals($expectedId, $createdBill->getId());
+ self::assertEquals($expectedStatus, $createdBill->getStatus());
+ self::assertEquals($expectedToken, $createdBill->getToken());
+ }
+
+ public function testCreateBillException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $restCliMock = $this->getRestCliMock();
+ $billToArray = [
+ 'id' => 'testId',
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills", $billMock->toArray(), true)
+ ->willThrowException(new BitPayException());
+ $billClient = $this->getClient($restCliMock);
+
+ $this->expectException(BillCreationException::class);
+
+ $billClient->createBill($billMock, Facade::MERCHANT);
+ }
+
+ public function testCreateBillShouldCatchRestCliException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $billToArray = [
+ 'id' => 'testId',
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills", $billMock->toArray(), true)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillCreationException::class);
+ $client->createBill($billMock, Facade::MERCHANT, true);
+ }
+
+ public function testCreateBillShouldCatchJsonMapperException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $exampleBillId = 'testId';
+ $exampleBadResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $billToArray = [
+ 'id' => $exampleBillId,
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills", $billMock->toArray(), true)
+ ->willReturn($exampleBadResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillCreationException::class);
+ $client->createBill($billMock, Facade::MERCHANT, true);
+ }
+
+ public function testGetBill()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/getBill.json'));
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getBill($exampleBillId);
+
+ self::assertEquals(
+ '6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA',
+ $result->getToken()
+ );
+ self::assertInstanceOf(Bill::class, $result);
+ }
+
+ public function testGetBillShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willThrowException(new BillQueryException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillQueryException::class);
+ $client->getBill($exampleBillId);
+ }
+
+ public function testGetBillShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(Exception::class);
+ $client->getBill($exampleBillId);
+ }
+
+ public function testGetBillShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleBadResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn($exampleBadResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillQueryException::class);
+ $client->getBill($exampleBillId);
+ }
+
+ public function testGetBills()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getBills.json');
+ $status = 'draft';
+ $params['status'] = $status;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills", $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getBills($status);
+ self::assertIsArray($result);
+ self::assertEquals(
+ '6EBQR37MgDJPfEiLY3jtRqBMYLg8XSDqhp2kp7VSDqCMHGHnsw4bqnnwQmtehzCvSo',
+ $result[0]->getToken()
+ );
+ self::assertEquals(
+ '6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA',
+ $result[1]->getToken()
+ );
+ self::assertInstanceOf(Bill::class, $result[0]);
+ self::assertInstanceOf(Bill::class, $result[1]);
+ }
+
+ public function testGetBillsShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $status = 'draft';
+ $params['status'] = $status;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills", $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillQueryException::class);
+ $client->getBills($status);
+ }
+
+ public function testGetBillsShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $status = 'draft';
+ $params['status'] = $status;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills", $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillQueryException::class);
+ $client->getBills($status);
+ }
+
+ /**
+ * @throws BitPayException
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetBillsShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $status = 'draft';
+ $params['status'] = $status;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills", $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillQueryException::class);
+ $client->getBills($status);
+ }
+
+ public function testUpdateBill()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getBill.json');
+
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $billMock->method('getId')->willReturn($exampleBillId);
+ $billToArray = [
+ 'id' => $exampleBillId,
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("bills/" . $exampleBillId, $billMock->toArray())
+ ->willReturn($exampleResponse);
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->updateBill($billMock, $exampleBillId);
+ self::assertInstanceOf(Bill::class, $result);
+ }
+
+ public function testUpdateBillShouldCatchRestCliBitPayException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getBill.json', true);
+ $billMock->method('getId')->willReturn($exampleBillId);
+ $billToArray = [
+ 'id' => $exampleBillId,
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("bills/" . $exampleBillId, $billMock->toArray())
+ ->willThrowException(new BitPayException());
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillUpdateException::class);
+ $client->updateBill($billMock, $exampleBillId);
+ }
+
+ public function testUpdateBillShouldCatchRestCliException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getBill.json');
+ $billMock->method('getId')->willReturn($exampleBillId);
+ $billToArray = [
+ 'id' => $exampleBillId,
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("bills/" . $exampleBillId, $billMock->toArray())
+ ->willThrowException(new Exception());
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillUpdateException::class);
+ $client->updateBill($billMock, $exampleBillId);
+ }
+
+ public function testUpdateBillShouldCatchJsonMapperException()
+ {
+ $billMock = $this->createMock(Bill::class);
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getBill.json');
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $billMock->method('getId')->willReturn($exampleBillId);
+ $billToArray = [
+ 'id' => $exampleBillId,
+ 'status' => 'status',
+ 'token' => 'token',
+ ];
+ $billMock->method('toArray')->willReturn($billToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("bills/" . $exampleBillId, $billMock->toArray())
+ ->willReturn($badResponse);
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("bills/" . $exampleBillId, $params, true)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillUpdateException::class);
+ $client->updateBill($billMock, $exampleBillId);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testDeliverBill()
+ {
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleBillToken = self::MERCHANT_TOKEN;
+ $exampleResponse = 'Success';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills/" . $exampleBillId . '/deliveries', ['token' => $exampleBillToken])
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->deliverBill($exampleBillId, $exampleBillToken);
+ self::assertTrue($result);
+ }
+
+ public function testDeliverBillShouldCatchRestCliBitPayException()
+ {
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleBillToken = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills/" . $exampleBillId . '/deliveries', ['token' => $exampleBillToken])
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillDeliveryException::class);
+ $client->deliverBill($exampleBillId, $exampleBillToken);
+ }
+
+ public function testDeliverBillShouldCatchRestCliException()
+ {
+ $exampleBillId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleBillToken = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("bills/" . $exampleBillId . '/deliveries', ['token' => $exampleBillToken])
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(BillDeliveryException::class);
+ $client->deliverBill($exampleBillId, $exampleBillToken);
+ }
+
+ public function testGetLedger()
+ {
+ $exampleCurrency = Currency::BTC;
+ $exampleStartDate = '2021-5-10';
+ $exampleEndDate = '2021-5-31';
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getLedgerBalances.json');
+
+ $params['token'] = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb';
+ $params["currency"] = $exampleCurrency;
+ $params["startDate"] = $exampleStartDate;
+ $params["endDate"] = $exampleEndDate;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("ledgers/" . $exampleCurrency, $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+ $result = $client->getLedgerEntries($exampleCurrency, $exampleStartDate, $exampleEndDate);
+
+ self::assertIsArray($result);
+ self::assertEquals('EUR', $result[0]->getCurrency());
+ self::assertEquals('USD', $result[1]->getCurrency());
+ self::assertEquals('BTC', $result[2]->getCurrency());
+ self::assertInstanceOf(LedgerEntry::class, $result[0]);
+ }
+
+ public function testGetLedgerShouldCatchRestCliException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->willThrowException(new \Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $exampleCurrency = Currency::BTC;
+ $exampleStartDate = '2021-5-10';
+ $exampleEndDate = '2021-5-31';
+ $client->getLedgerEntries($exampleCurrency, $exampleStartDate, $exampleEndDate);
+ }
+
+ public function testGetLedgerShouldCatchRestCliBitPayException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $exampleCurrency = Currency::BTC;
+ $exampleStartDate = '2021-5-10';
+ $exampleEndDate = '2021-5-31';
+ $client->getLedgerEntries($exampleCurrency, $exampleStartDate, $exampleEndDate);
+ }
+
+ public function testGetLedgerShouldCatchJsonMapperException()
+ {
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $exampleCurrency = Currency::BTC;
+ $exampleStartDate = '2021-5-10';
+ $exampleEndDate = '2021-5-31';
+ $client->getLedgerEntries($exampleCurrency, $exampleStartDate, $exampleEndDate);
+ }
+
+ public function testGetLedgers()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params['token'] = 'kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getLedgers.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("ledgers", $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getLedgers();
+
+
+ self::assertIsArray($result);
+ self::assertInstanceOf(Ledger::class, $result[0]);
+ }
+
+ public function testGetLedgersShouldCatchBitPayException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $client->getLedgers();
+ }
+
+ public function testGetLedgersShouldCatchRestCliException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $client->getLedgers();
+ }
+
+ public function testGetLedgersShouldCatchJsonMapperException()
+ {
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(LedgerQueryException::class);
+ $client->getLedgers();
+ }
+
+ public function testSubmitPayoutRecipients()
+ {
+ $payoutRecipientsMock = $this->createMock(PayoutRecipients::class);
+ $exampleRecipientId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/submitPayoutRecipientsResponse.json');
+
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientsMock->method('toArray')->willReturn($payoutRecipientToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients", $payoutRecipientsMock->toArray())
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->submitPayoutRecipients($payoutRecipientsMock);
+ self::assertIsArray($result);
+ }
+
+ public function testSubmitPayoutRecipientsShouldCatchRestCliBitPayException()
+ {
+ $payoutRecipientsMock = $this->createMock(PayoutRecipients::class);
+ $exampleRecipientId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientsMock->method('toArray')->willReturn($payoutRecipientToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients", $payoutRecipientsMock->toArray())
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientCreationException::class);
+ $client->submitPayoutRecipients($payoutRecipientsMock);
+ }
+
+ public function testSubmitPayoutRecipientsShouldCatchRestCliException()
+ {
+ $payoutRecipientsMock = $this->createMock(PayoutRecipients::class);
+ $exampleRecipientId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientsMock->method('toArray')->willReturn($payoutRecipientToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients", $payoutRecipientsMock->toArray())
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(Exception::class);
+ $client->submitPayoutRecipients($payoutRecipientsMock);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testSubmitPayoutRecipientsShouldCatchJsonMapperException()
+ {
+ $payoutRecipientsMock = $this->createMock(PayoutRecipients::class);
+ $exampleRecipientId = 'X6KJbe9RxAGWNReCwd1xRw';
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientsMock->method('toArray')->willReturn($payoutRecipientToArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients", $payoutRecipientsMock->toArray())
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientCreationException::class);
+ $client->submitPayoutRecipients($payoutRecipientsMock);
+ }
+
+ public function testGetPayoutRecipient()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $recipientId = 'test';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayoutRecipient.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients/" . $recipientId, $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getPayoutRecipient($recipientId);
+ self::assertInstanceOf(PayoutRecipient::class, $result);
+ }
+
+ public function testGetPayoutRecipientShouldHandleRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $recipientId = 'test';
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients/" . $recipientId, $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $client->getPayoutRecipient($recipientId);
+ }
+
+ public function testGetPayoutRecipientShouldHandleRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $recipientId = 'test';
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients/" . $recipientId, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $client->getPayoutRecipient($recipientId);
+ }
+
+ public function testGetPayoutRecipientShouldHandleJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $recipientId = 'test';
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients/" . $recipientId, $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutQueryException::class);
+ $client->getPayoutRecipient($recipientId);
+ }
+
+ public function testGetPayoutRecipients()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayoutRecipients.json');
+
+ $status = 'status';
+ $limit = 2;
+ $offset = 1;
+
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients", $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getPayoutRecipients($status, $limit, $offset);
+ self::assertIsArray($result);
+ self::assertInstanceOf(PayoutRecipient::class, $result[0]);
+ }
+
+ public function testGetPayoutRecipientsShouldHandleRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients", $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $client->getPayoutRecipients($status, $limit, $offset);
+ }
+
+ public function testGetPayoutRecipientsShouldHandleRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients", $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $client->getPayoutRecipients($status, $limit, $offset);
+ }
+
+ public function testGetPayoutRecipientsShouldHandleJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("recipients", $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientQueryException::class);
+ $client->getPayoutRecipients($status, $limit, $offset);
+ }
+
+ /**
+ * @throws PayoutRecipientUpdateException
+ */
+ public function testUpdatePayoutRecipient()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayoutRecipient.json');
+ $payoutRecipientMock = $this->createMock(PayoutRecipient::class);
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientMock->method('toArray')->willReturn($payoutRecipientToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("recipients/" . $exampleRecipientId, $payoutRecipientMock->toArray())
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->updatePayoutRecipient($exampleRecipientId, $payoutRecipientMock);
+ self::assertInstanceOf(PayoutRecipient::class, $result);
+ }
+
+ public function testUpdatePayoutRecipientShouldCatchRestCliBitPayException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $payoutRecipientMock = $this->createMock(PayoutRecipient::class);
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientMock->method('toArray')->willReturn($payoutRecipientToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("recipients/" . $exampleRecipientId, $payoutRecipientMock->toArray())
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientUpdateException::class);
+ $client->updatePayoutRecipient($exampleRecipientId, $payoutRecipientMock);
+ }
+
+ public function testUpdatePayoutRecipientShouldCatchRestCliException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $payoutRecipientMock = $this->createMock(PayoutRecipient::class);
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientMock->method('toArray')->willReturn($payoutRecipientToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("recipients/" . $exampleRecipientId, $payoutRecipientMock->toArray())
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientUpdateException::class);
+ $client->updatePayoutRecipient($exampleRecipientId, $payoutRecipientMock);
+ }
+
+ public function testUpdatePayoutRecipientShouldCatchJsonMapperException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $payoutRecipientMock = $this->createMock(PayoutRecipient::class);
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $payoutRecipientToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'id' => $exampleRecipientId
+ ];
+ $payoutRecipientMock->method('toArray')->willReturn($payoutRecipientToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("recipients/" . $exampleRecipientId, $payoutRecipientMock->toArray())
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientUpdateException::class);
+ $client->updatePayoutRecipient($exampleRecipientId, $payoutRecipientMock);
+ }
+
+ public function testDeletePayoutRecipient()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $params['token'] = self::MERCHANT_TOKEN;
+ $successResponse = file_get_contents(__DIR__ . '/jsonResponse/success.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("recipients/" . $exampleRecipientId, $params)
+ ->willReturn($successResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->deletePayoutRecipient($exampleRecipientId);
+ self::assertIsBool($result);
+ self::assertTrue($result);
+ }
+
+ public function testDeletePayoutRecipientShouldCatchRestCliBitPayException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("recipients/" . $exampleRecipientId, $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientCancellationException::class);
+ $client->deletePayoutRecipient($exampleRecipientId);
+ }
+
+ public function testDeletePayoutRecipientShouldCatchRestCliException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("recipients/" . $exampleRecipientId, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientCancellationException::class);
+ $client->deletePayoutRecipient($exampleRecipientId);
+ }
+
+ public function testDeletePayoutRecipientShouldCatchJsonDecodeException()
+ {
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $params['token'] = self::MERCHANT_TOKEN;
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/false.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("recipients/" . $exampleRecipientId, $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ self::assertFalse($client->deletePayoutRecipient($exampleRecipientId));
+ }
+
+ public function testRequestPayoutRecipientNotification()
+ {
+ $content['token'] = self::MERCHANT_TOKEN;
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $successResponse = file_get_contents(__DIR__ . '/jsonResponse/success.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients/" . $exampleRecipientId . '/notifications', $content)
+ ->willReturn($successResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->requestPayoutRecipientNotification($exampleRecipientId);
+ self::assertIsBool($result);
+ self::assertTrue($result);
+ }
+
+ public function testRequestPayoutRecipientNotificationShouldCatchRestCliBitPayException()
+ {
+ $content['token'] = self::MERCHANT_TOKEN;
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients/" . $exampleRecipientId . '/notifications', $content)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientNotificationException::class);
+ $client->requestPayoutRecipientNotification($exampleRecipientId);
+ }
+
+ public function testRequestPayoutRecipientNotificationShouldCatchRestCliException()
+ {
+ $content['token'] = self::MERCHANT_TOKEN;
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients/" . $exampleRecipientId . '/notifications', $content)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(PayoutRecipientNotificationException::class);
+ $client->requestPayoutRecipientNotification($exampleRecipientId);
+ }
+
+ public function testRequestPayoutRecipientNotificationShouldCatchJsonDecodeException()
+ {
+ $content['token'] = self::MERCHANT_TOKEN;
+ $exampleRecipientId = 'X3icwc4tE8KJ5hEPNPpDXW';
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/false.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("recipients/" . $exampleRecipientId . '/notifications', $content)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ self::assertFalse($client->requestPayoutRecipientNotification($exampleRecipientId));
+ }
+
+ public function testGetRates()
+ {
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getRates.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates', null, false)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getRates();
+ self::assertEquals('41248.11', $result->getRate('USD'));
+ self::assertIsArray($result->getRates());
+ self::assertInstanceOf(Rates::class, $result);
+ }
+
+ public function testGetRatesShouldHandleRestCliBitPayException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates', null, false)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getRates();
+ }
+
+ public function testGetRatesShouldHandleRestCliException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates', null, false)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getRates();
+ }
+
+ public function testGetRatesShouldHandleCorruptJson()
+ {
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates', null, false)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getRates();
+ }
+
+ public function testGetCurrencyRates()
+ {
+ $exampleCurrency = Currency::BTC;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getCurrencyRates.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates/' . $exampleCurrency, null, false)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getCurrencyRates(Currency::BTC);
+ self::assertEquals('41248.11', $result->getRate(Currency::USD));
+ self::assertIsArray($result->getRates());
+ self::assertInstanceOf(Rates::class, $result);
+ }
+
+ public function testGetCurrencyRatesShouldHandleRestCliBitPayException()
+ {
+ $exampleCurrency = Currency::USD;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates/' . $exampleCurrency, null, false)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyRates(Currency::USD);
+ }
+
+ public function testGetCurrencyRatesShouldHandleRestCliException()
+ {
+ $exampleCurrency = Currency::USD;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates/' . $exampleCurrency, null, false)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyRates(Currency::USD);
+ }
+
+ public function testGetCurrencyRatesShouldFailWhenDataInvalid()
+ {
+ $exampleCurrency = Currency::USD;
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates/' . $exampleCurrency, null, false)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyRates(Currency::USD);
+ }
+
+ public function testGetCurrencyPairRate()
+ {
+ $baseCurrency = Currency::USD;
+ $currency = Currency::USD;
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getCurrencyPairRate.json');
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with('rates/' . $baseCurrency . '/' . $currency, null, false)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getCurrencyPairRate($baseCurrency, $currency);
+ self::assertEquals('41154.05', $result->getRate());
+ self::assertEquals('US Dollar', $result->getName());
+ self::assertEquals('USD', $result->getCode());
+ self::assertInstanceOf(Rate::class, $result);
+ }
+
+ public function testGetCurrencyPairRateShouldCatchRestCliBitPayException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyPairRate(Currency::BTC, Currency::USD);
+ }
+
+ public function testGetCurrencyPairRateShouldThrowExceptionWhenResponseIsException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyPairRate(Currency::BTC, Currency::USD);
+ }
+
+ public function testGetCurrencyPairRateShouldReturnExceptionWhenNoDataInJson()
+ {
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+ $restCliMock = $this->getRestCliMock();
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RateQueryException::class);
+ $client->getCurrencyPairRate(Currency::BTC, Currency::USD);
+ }
+
+ public function testGetSettlements()
+ {
+ $currency = Currency::USD;
+ $dateStart = 'dateStart';
+ $dateEnd = 'dateEnd';
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+ $restCliMock = $this->getRestCliMock();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['dateStart'] = $dateStart;
+ $params['dateEnd'] = $dateEnd;
+ $params['currency'] = $currency;
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getSettlementsResponse.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements", $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getSettlements($currency, $dateStart, $dateEnd, $status, $limit, $offset);
+ self::assertIsArray($result);
+ self::assertEquals('KBkdURgmE3Lsy9VTnavZHX', $result[0]->getId());
+ self::assertEquals('processing', $result[0]->getStatus());
+ self::assertEquals('RPWTabW8urd3xWv2To989v', $result[1]->getId());
+ self::assertEquals('processing', $result[1]->getStatus());
+ self::assertInstanceOf(Settlement::class, $result[0]);
+ }
+
+ public function testGetSettlementsShouldCatchRestCliBitPayException()
+ {
+ $currency = Currency::USD;
+ $dateStart = 'dateStart';
+ $dateEnd = 'dateEnd';
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+ $restCliMock = $this->getRestCliMock();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['dateStart'] = $dateStart;
+ $params['dateEnd'] = $dateEnd;
+ $params['currency'] = $currency;
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements", $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlements($currency, $dateStart, $dateEnd, $status, $limit, $offset);
+ }
+
+ public function testGetSettlementsShouldCatchRestCliException()
+ {
+ $currency = Currency::USD;
+ $dateStart = 'dateStart';
+ $dateEnd = 'dateEnd';
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+ $restCliMock = $this->getRestCliMock();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['dateStart'] = $dateStart;
+ $params['dateEnd'] = $dateEnd;
+ $params['currency'] = $currency;
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements", $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlements($currency, $dateStart, $dateEnd, $status, $limit, $offset);
+ }
+
+ public function testGetSettlementsShouldCatchJsonMapperException()
+ {
+ $currency = Currency::USD;
+ $dateStart = 'dateStart';
+ $dateEnd = 'dateEnd';
+ $status = 'status';
+ $limit = 1;
+ $offset = 1;
+ $restCliMock = $this->getRestCliMock();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['dateStart'] = $dateStart;
+ $params['dateEnd'] = $dateEnd;
+ $params['currency'] = $currency;
+ $params['status'] = $status;
+ $params['limit'] = $limit;
+ $params['offset'] = $offset;
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements", $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlements($currency, $dateStart, $dateEnd, $status, $limit, $offset);
+ }
+
+ public function testGetSettlement()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $settlementId = 'RPWTabW8urd3xWv2To989v';
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getSettlementResponse.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $settlementId, $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getSettlement($settlementId);
+ self::assertEquals('RPWTabW8urd3xWv2To989v', $result->getId());
+ self::assertEquals('EUR', $result->getCurrency());
+ self::assertEquals(
+ '2GrR6GDeYxUFYM9sDKViy6nFFTy4Rjvm1SYdLBjK46jkeJdgUTRccRfhtwkhNcuZky',
+ $result->getToken()
+ );
+ self::assertEquals('processing', $result->getStatus());
+ self::assertInstanceOf(Settlement::class, $result);
+ }
+
+ public function testGetSettlementShouldHandleRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $settlementId = 'RPWTabW8urd3xWv2To989v';
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $settlementId, $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlement($settlementId);
+ }
+
+ public function testGetSettlementShouldHandleRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $settlementId = 'RPWTabW8urd3xWv2To989v';
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $settlementId, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlement($settlementId);
+ }
+
+ public function testGetSettlementShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $settlementId = 'RPWTabW8urd3xWv2To989v';
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $settlementId, $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlement($settlementId);
+ }
+
+ public function testGetSettlementReconciliationReport()
+ {
+ $settlement = $this->createMock(Settlement::class);
+ $exampleToken = self::MERCHANT_TOKEN;
+ $exampleId = 'RPWTabW8urd3xWv2To989v';
+ $settlement->method('getToken')->willReturn($exampleToken);
+ $settlement->method('getId')->willReturn($exampleId);
+ $params['token'] = $exampleToken;
+ $exampleResponse = file_get_contents(
+ __DIR__ . '/jsonResponse/getSettlementReconciliationReportResponse.json'
+ );
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $exampleId . '/reconciliationReport', $params)
+ ->willReturn($exampleResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getSettlementReconciliationReport($settlement);
+
+ self::assertEquals('RvNuCTMAkURKimwgvSVEMP', $result->getId());
+ self::assertEquals('processing', $result->getStatus());
+ self::assertEquals('USD', $result->getCurrency());
+ self::assertInstanceOf(Settlement::class, $result);
+ }
+
+ public function testGetSettlementReconciliationReportShouldCatchRestCliBitPayException()
+ {
+ $settlement = $this->createMock(Settlement::class);
+ $exampleToken = self::MERCHANT_TOKEN;
+ $exampleId = 'RPWTabW8urd3xWv2To989v';
+ $settlement->method('getToken')->willReturn($exampleToken);
+ $settlement->method('getId')->willReturn($exampleId);
+ $params['token'] = $exampleToken;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $exampleId . '/reconciliationReport', $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlementReconciliationReport($settlement);
+ }
+
+ public function testGetSettlementReconciliationReportShouldCatchRestCliException()
+ {
+ $settlement = $this->createMock(Settlement::class);
+ $exampleToken = self::MERCHANT_TOKEN;
+ $exampleId = 'RPWTabW8urd3xWv2To989v';
+ $settlement->method('getToken')->willReturn($exampleToken);
+ $settlement->method('getId')->willReturn($exampleId);
+ $params['token'] = $exampleToken;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $exampleId . '/reconciliationReport', $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlementReconciliationReport($settlement);
+ }
+
+ public function testGetSettlementReconciliationReportShouldCatchJsonMapperException()
+ {
+ $settlement = $this->createMock(Settlement::class);
+ $exampleToken = self::MERCHANT_TOKEN;
+ $exampleId = 'RPWTabW8urd3xWv2To989v';
+ $settlement->method('getToken')->willReturn($exampleToken);
+ $settlement->method('getId')->willReturn($exampleId);
+ $params['token'] = $exampleToken;
+ $badResponse = file_get_contents(__DIR__ . '/jsonResponse/badResponse.json');
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("settlements/" . $exampleId . '/reconciliationReport', $params)
+ ->willReturn($badResponse);
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(SettlementQueryException::class);
+ $client->getSettlementReconciliationReport($settlement);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetPayout()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayout.json');
+ $exampleResponseArray = json_decode($exampleResponse, true);
+ $payoutId = $exampleResponseArray['id'];
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts/" . $payoutId, $params)
+ ->willReturn($exampleResponse);
+ $client = $this->getClient($restCliMock);
+ $result = $client->getPayout($payoutId);
+ self::assertEquals(self::MERCHANT_TOKEN, $result->getToken());
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetPayoutShouldHandleRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayout.json');
+ $exampleResponseArray = json_decode($exampleResponse, true);
+ $payoutId = $exampleResponseArray['id'];
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts/" . $payoutId, $params)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayout($payoutId);
+ }
+
+ public function testGetPayoutShouldHandleJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayout.json');
+ $exampleResponseArray = json_decode($exampleResponse, true);
+ $payoutId = $exampleResponseArray['id'];
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts/" . $payoutId, $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayout($payoutId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetPayoutShouldHandleRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayout.json');
+ $exampleResponseArray = json_decode($exampleResponse, true);
+ $payoutId = $exampleResponseArray['id'];
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts/" . $payoutId, $params)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayout($payoutId);
+ }
+
+ public function testGetPayouts()
+ {
+ $params = $this->getPayoutParams();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $exampleResponse = file_get_contents(__DIR__ . '/jsonResponse/getPayouts.json');
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts", $params)
+ ->willReturn($exampleResponse);
+ $client = $this->getClient($restCliMock);
+ $result = $client->getPayouts(
+ $params['startDate'],
+ $params['endDate'],
+ $params['status'],
+ $params['reference'],
+ $params['limit'],
+ $params['offset']
+ );
+ self::assertIsArray($result);
+ self::assertEquals('JMwv8wQCXANoU2ZZQ9a9GH', $result[0]->getId());
+ self::assertEquals(10, $result[0]->getAmount());
+ self::assertEquals('USD', $result[0]->getCurrency());
+ self::assertInstanceOf(Payout::class, $result[0]);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetPayoutsShouldHandleRestCliBitPayException()
+ {
+ $params = $this->getPayoutParams();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts", $params)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayouts(
+ $params['startDate'],
+ $params['endDate'],
+ $params['status'],
+ $params['reference'],
+ $params['limit'],
+ $params['offset']
+ );
+ }
+
+ public function testGetPayoutsShouldHandleRestCliException()
+ {
+ $params = $this->getPayoutParams();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts", $params)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayouts(
+ $params['startDate'],
+ $params['endDate'],
+ $params['status'],
+ $params['reference'],
+ $params['limit'],
+ $params['offset']
+ );
+ }
+
+ public function testGetPayoutsShouldHandleJsonMapperException()
+ {
+ $params = $this->getPayoutParams();
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("payouts", $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutQueryException::class);
+
+ $client->getPayouts(
+ $params['startDate'],
+ $params['endDate'],
+ $params['status'],
+ $params['reference'],
+ $params['limit'],
+ $params['offset']
+ );
+ }
+
+ public function testCancelPayout()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $examplePayoutId = 'test';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("payouts/" . $examplePayoutId, $params)
+ ->willReturn('{"status":"success"}');
+ $client = $this->getClient($restCliMock);
+ $result = $client->cancelPayout($examplePayoutId);
+
+ self::assertIsBool($result);
+ }
+
+ public function testCancelPayoutShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $examplePayoutId = 'test';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("payouts/" . $examplePayoutId, $params)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutCancellationException::class);
+
+ $client->cancelPayout($examplePayoutId);
+ }
+
+ public function testCancelPayoutShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $examplePayoutId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("payouts/" . $examplePayoutId, $params)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutCancellationException::class);
+
+ $client->cancelPayout($examplePayoutId);
+ }
+
+ public function testCancelPayoutShouldCatchUnexistentPropertyError()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $examplePayoutId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("payouts/" . $examplePayoutId, $params)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/false.json', true));
+ $client = $this->getClient($restCliMock);
+
+ self::assertFalse($client->cancelPayout($examplePayoutId));
+ }
+
+ public function testSubmitPayout()
+ {
+ $payoutMock = $this->createMock(Payout::class);
+ $exampleCurrency = Currency::USD;
+ $payoutBatchToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'currency' => $exampleCurrency
+ ];
+ $payoutMock->method('getCurrency')->willReturn($exampleCurrency);
+ $payoutMock->method('toArray')->willReturn($payoutBatchToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts", $payoutMock->toArray())
+ ->willReturn('{ "currency": "EUR", "balance": 0 }');
+ $client = $this->getClient($restCliMock);
+ $result = $client->submitPayout($payoutMock);
+
+ self::assertEquals('EUR', $result->getCurrency());
+ self::assertInstanceOf(Payout::class, $result);
+ }
+
+ public function testSubmitPayoutShouldCatchRestCliBitPayException()
+ {
+ $payoutMock = $this->createMock(Payout::class);
+ $exampleCurrency = Currency::USD;
+ $payoutBatchToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'currency' => $exampleCurrency
+ ];
+ $payoutMock->method('getCurrency')->willReturn($exampleCurrency);
+ $payoutMock->method('toArray')->willReturn($payoutBatchToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts", $payoutMock->toArray())
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutCreationException::class);
+
+ $client->submitPayout($payoutMock);
+ }
+
+ public function testSubmitPayoutShouldCatchRestCliException()
+ {
+ $payoutMock = $this->createMock(Payout::class);
+ $exampleCurrency = Currency::USD;
+ $payoutBatchToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'currency' => $exampleCurrency
+ ];
+ $payoutMock->method('getCurrency')->willReturn($exampleCurrency);
+ $payoutMock->method('toArray')->willReturn($payoutBatchToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts", $payoutMock->toArray())
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutCreationException::class);
+
+ $client->submitPayout($payoutMock);
+ }
+
+ public function testSubmitPayoutShouldCatchJsonMapperException()
+ {
+ $payoutMock = $this->createMock(Payout::class);
+ $exampleCurrency = Currency::USD;
+ $payoutBatchToArray = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'currency' => $exampleCurrency
+ ];
+ $payoutMock->method('getCurrency')->willReturn($exampleCurrency);
+ $payoutMock->method('toArray')->willReturn($payoutBatchToArray);
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts", $payoutMock->toArray())
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutCreationException::class);
+
+ $client->submitPayout($payoutMock);
+ }
+
+ public function testRequestNotification()
+ {
+ $content = ['token' => self::MERCHANT_TOKEN];
+ $payoutId = 'JMwv8wQCXANoU2ZZQ9a9GH';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts/{$payoutId}/notifications", $content)
+ ->willReturn('{ "status": "success", "data": {}, "message": null }');
+ $client = $this->getClient($restCliMock);
+ $result = $client->requestPayoutNotification($payoutId);
+
+ self::assertTrue($result);
+ }
+
+ public function testRequestNotificationShouldCatchRestCliBitPayException()
+ {
+ $content = ['token' => self::MERCHANT_TOKEN];
+ $payoutId = 'JMwv8wQCXANoU2ZZQ9a9GH';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts/{$payoutId}/notifications", $content)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutNotificationException::class);
+
+ $client->requestPayoutNotification($payoutId);
+ }
+
+ public function testRequestNotificationShouldCatchRestCliException()
+ {
+ $content = ['token' => self::MERCHANT_TOKEN];
+ $payoutId = 'JMwv8wQCXANoU2ZZQ9a9GH';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts/{$payoutId}/notifications", $content)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(PayoutNotificationException::class);
+
+ $client->requestPayoutNotification($payoutId);
+ }
+
+ public function testRequestNotificationShouldCatchJsonException()
+ {
+ $content = ['token' => self::MERCHANT_TOKEN];
+ $payoutId = 'JMwv8wQCXANoU2ZZQ9a9GH';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts/{$payoutId}/notifications", $content)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/false.json', true));
+ $client = $this->getClient($restCliMock);
+
+ self::assertFalse($client->requestPayoutNotification($payoutId));
+ }
+
+ public function testCreatePayoutGroup(): void
+ {
+ $expectedRequest = json_decode(
+ file_get_contents(__DIR__ . '/jsonResponse/createPayoutGroupRequest.json', true),
+ true,
+ 512,
+ JSON_THROW_ON_ERROR
+ );
+ $notificationURL = 'https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx';
+ $shopperId = '7qohDf2zZnQK5Qanj8oyC2';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("payouts/group", $expectedRequest)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/createPayoutGroupResponse.json', true));
+
+ $client = $this->getClient($restCliMock);
+
+ $payout = new Payout();
+ $payout->setAmount(10);
+ $payout->setCurrency(Currency::USD);
+ $payout->setLedgerCurrency(Currency::USD);
+ $payout->setReference('payout_20210527');
+ $payout->setNotificationEmail('merchant@email.com');
+ $payout->setNotificationURL($notificationURL);
+ $payout->setEmail('john@doe.com');
+ $payout->setRecipientId('LDxRZCGq174SF8AnQpdBPB');
+ $payout->setShopperId($shopperId);
+
+ $result = $client->createPayoutGroup([$payout]);
+ $firstPayout = $result->getPayouts()[0];
+ $firstFailed = $result->getFailed()[0];
+
+ self::assertCount(1, $result->getPayouts());
+ self::assertEquals($notificationURL, $firstPayout->getNotificationURL());
+ self::assertEquals($shopperId, $firstPayout->getShopperId());
+ self::assertEquals('Ledger currency is required', $firstFailed->getErrorMessage());
+ self::assertEquals('john@doe.com', $firstFailed->getPayee());
+ }
+
+ public function testCancelPayoutGroup(): void
+ {
+ $groupId = '12345';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("payouts/group/" . $groupId, ['token' => self::PAYOUT_TOKEN])
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/cancelPayoutGroupResponse.json', true));
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->cancelPayoutGroup($groupId);
+ $firstPayout = $result->getPayouts()[0];
+ $firstFailed = $result->getFailed()[0];
+
+ self::assertCount(2, $result->getPayouts());
+ self::assertEquals(
+ 'https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx',
+ $firstPayout->getNotificationURL()
+ );
+ self::assertEquals('7qohDf2zZnQK5Qanj8oyC2', $firstPayout->getShopperId());
+ self::assertEquals('PayoutId is missing or invalid', $firstFailed->getErrorMessage());
+ self::assertEquals('D8tgWzn1psUua4NYWW1vYo', $firstFailed->getPayoutId());
+ }
+
+ public function testCreateRefund()
+ {
+ $params = $this->getInvoiceRefundParams();
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())
+ ->method('post')
+ ->with("refunds/", $params, true)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/createRefundResponse.json', true));
+
+ $client = $this->getClient($restCliMock);
+ /** @var Refund $result */
+ $result = $client->createRefund(
+ $params['invoiceId'],
+ $params['amount'],
+ $params['currency'],
+ $params['preview'],
+ $params['immediate'],
+ $params['buyerPaysRefundFee'],
+ $params['guid']
+ );
+
+ self::assertEquals('Eso8srxKJR5U71ahCspAAA', $result->getId());
+ self::assertEquals($params['invoiceId'], $result->getInvoice());
+ }
+
+ public function testCreateRefundShouldCatchRestCliBitPayException()
+ {
+ $params = $this->getInvoiceRefundParams();
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/", $params, true)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCreationException::class);
+
+ $client->createRefund(
+ $params['invoiceId'],
+ $params['amount'],
+ $params['currency'],
+ $params['preview'],
+ $params['immediate'],
+ $params['buyerPaysRefundFee'],
+ $params['guid']
+ );
+ }
+
+ public function testCreateRefundShouldCatchRestCliException()
+ {
+ $params = $this->getInvoiceRefundParams();
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/", $params, true)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCreationException::class);
+
+ $client->createRefund(
+ $params['invoiceId'],
+ $params['amount'],
+ $params['currency'],
+ $params['preview'],
+ $params['immediate'],
+ $params['buyerPaysRefundFee'],
+ $params['guid']
+ );
+ }
+
+ public function testCreateRefundShouldCatchJsonMapperException()
+ {
+ $params = $this->getInvoiceRefundParams();
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')->with("refunds/", $params, true)->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCreationException::class);
+
+ $client->createRefund(
+ $params['invoiceId'],
+ $params['amount'],
+ $params['currency'],
+ $params['preview'],
+ $params['immediate'],
+ $params['buyerPaysRefundFee'],
+ $params['guid']
+ );
+ }
+
+ public function testCancelRefund()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/" . $exampleRefundId, $params)
+ ->willReturn(self::CANCEL_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->cancelRefund($exampleRefundId);
+ self::assertEquals('USD', $result->getCurrency());
+ self::assertEquals(10, $result->getAmount());
+ self::assertEquals('cancelled', $result->getStatus());
+ self::assertInstanceOf(Refund::class, $result);
+ }
+
+ public function testCancelRefundShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/" . $exampleRefundId, $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCancellationException::class);
+
+ $client->cancelRefund($exampleRefundId);
+ }
+
+ public function testCancelRefundShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/" . $exampleRefundId, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundCancellationException::class);
+ $client->cancelRefund($exampleRefundId);
+ }
+
+ public function testCancelRefundShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/" . $exampleRefundId, $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCancellationException::class);
+
+ $client->cancelRefund($exampleRefundId);
+ }
+
+ public function testCancelRefundByGuid()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willReturn(self::CANCEL_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->cancelRefundByGuid($guid);
+ self::assertEquals('USD', $result->getCurrency());
+ self::assertEquals(10, $result->getAmount());
+ self::assertEquals('cancelled', $result->getStatus());
+ self::assertInstanceOf(Refund::class, $result);
+ }
+
+ public function testCancelRefundByGuidShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willThrowException(new BitPayException());
+
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCancellationException::class);
+
+ $client->cancelRefundByGuid($guid);
+ }
+
+ public function testCancelRefundByGuidShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundCancellationException::class);
+ $client->cancelRefundByGuid($guid);
+ }
+
+ public function testCancelRefundByGuidShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('delete')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundCancellationException::class);
+
+ $client->cancelRefundByGuid($guid);
+ }
+
+ public function testUpdateRefund()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $refundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/" . $refundId, $params)
+ ->willReturn(self::UPDATE_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+ $result = $client->updateRefund($refundId, $params['status']);
+
+ self::assertInstanceOf(Refund::class, $result);
+ }
+
+ public function testUpdateRefundShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $refundId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/" . $refundId, $params)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+
+ $client->updateRefund($refundId, $params['status']);
+ }
+
+ public function testUpdateRefundShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $refundId = 'testId';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/" . $refundId, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+ $client->updateRefund($refundId, $params['status']);
+ }
+
+ public function testUpdateRefundShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $refundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/" . $refundId, $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+
+ $client->updateRefund($refundId, $params['status']);
+ }
+
+ public function testUpdateRefundByGuid()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willReturn(self::UPDATE_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+ $result = $client->updateRefundByGuid($guid, $params['status']);
+
+ self::assertInstanceOf(Refund::class, $result);
+ self::assertEquals('created', $result->getStatus());
+ self::assertEquals(10, $result->getAmount());
+ }
+
+ public function testUpdateRefundBuGuidShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $guid = 'testGuid';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+
+ $client->updateRefundByGuid($guid, $params['status']);
+ }
+
+ public function testUpdateRefundBuGuidShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $guid = 'testGuid';
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willThrowException(new Exception());
+
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+ $client->updateRefundByGuid($guid, $params['status']);
+ }
+
+ public function testUpdateRefundByGuidShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $params['status'] = 'status';
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')
+ ->with("refunds/guid/" . $guid, $params)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundUpdateException::class);
+
+ $client->updateRefundByGuid($guid, $params['status']);
+ }
+
+ public function testGetRefunds()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleInvoiceId = 'testId';
+ $params['invoiceId'] = $exampleInvoiceId;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/", $params, true)
+ ->willReturn(self::CORRECT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $result = $client->getRefunds($exampleInvoiceId);
+
+ self::assertIsArray($result);
+ self::assertInstanceOf(Refund::class, $result[0]);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundsShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleInvoiceId = 'testId';
+ $params['invoiceId'] = $exampleInvoiceId;
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/", $params, true)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundQueryException::class);
+
+ $client->getRefunds($exampleInvoiceId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundsShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleInvoiceId = 'testId';
+ $params['invoiceId'] = $exampleInvoiceId;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/", $params, true)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundQueryException::class);
+
+ $client->getRefunds($exampleInvoiceId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundsShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleInvoiceId = 'testId';
+ $params['invoiceId'] = $exampleInvoiceId;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/", $params, true)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundQueryException::class);
+
+ $client->getRefunds($exampleInvoiceId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefund()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/" . $exampleRefundId, $params, true)
+ ->willReturn(self::UPDATE_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+ $result = $client->getRefund($exampleRefundId);
+
+ self::assertEquals('USD', $result->getCurrency());
+ self::assertEquals(10, $result->getAmount());
+ self::assertEquals('created', $result->getStatus());
+ self::assertEquals('WoE46gSLkJQS48RJEiNw3L', $result->getId());
+ self::assertInstanceOf(Refund::class, $result);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/" . $exampleRefundId, $params, true)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefund($exampleRefundId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/" . $exampleRefundId, $params, true)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefund($exampleRefundId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundShouldCatchRestCliJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $exampleRefundId = 'testId';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/" . $exampleRefundId, $params, true)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefund($exampleRefundId);
+ }
+
+ public function testGetRefundByGuid()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/guid/" . $guid, $params, true)
+ ->willReturn(self::UPDATE_REFUND_JSON_STRING);
+
+ $client = $this->getClient($restCliMock);
+ $result = $client->getRefundByGuid($guid);
+
+ self::assertEquals('USD', $result->getCurrency());
+ self::assertEquals(10, $result->getAmount());
+ self::assertEquals('created', $result->getStatus());
+ self::assertEquals('WoE46gSLkJQS48RJEiNw3L', $result->getId());
+ self::assertInstanceOf(Refund::class, $result);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundByGuidShouldCatchRestCliBitPayException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/guid/" . $guid, $params, true)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefundByGuid($guid);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundByGuidShouldCatchRestCliException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/guid/" . $guid, $params, true)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefundByGuid($guid);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testGetRefundByGuidShouldCatchRestCliJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $guid = 'testGuid';
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('get')
+ ->with("refunds/guid/" . $guid, $params, true)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+ $client = $this->getClient($restCliMock);
+
+ $this->expectException(RefundQueryException::class);
+ $client->getRefundByGuid($guid);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testSendRefundNotification()
+ {
+ $exampleRefundId = 'testId';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/" . $exampleRefundId . "/notifications", $params, true)
+ ->willReturn('{"status":"success"}');
+ $client = $this->getClient($restCliMock);
+ $result = $client->sendRefundNotification($exampleRefundId);
+
+ self::assertIsBool($result);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testSendRefundNotificationShouldCatchRestCliBitPayException()
+ {
+ $exampleRefundId = 'testId';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/" . $exampleRefundId . "/notifications", $params, true)
+ ->willThrowException(new BitPayException());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundNotificationException::class);
+
+ $client->sendRefundNotification($exampleRefundId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testSendRefundNotificationShouldCatchRestCliException()
+ {
+ $exampleRefundId = 'testId';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/" . $exampleRefundId . "/notifications", $params, true)
+ ->willThrowException(new Exception());
+ $client = $this->getClient($restCliMock);
+ $this->expectException(RefundNotificationException::class);
+
+ $client->sendRefundNotification($exampleRefundId);
+ }
+
+ /**
+ * @depends testWithFileJsonConfig
+ */
+ public function testSendRefundNotificationShouldCatchJsonMapperException()
+ {
+ $exampleRefundId = 'testId';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')
+ ->with("refunds/" . $exampleRefundId . "/notifications", $params, true)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/false.json', true));
+ $client = $this->getClient($restCliMock);
+
+ self::assertFalse($client->sendRefundNotification($exampleRefundId));
+ }
+
+ public function testGetInvoice()
+ {
+ $exampleInvoiceObject = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices/' . $exampleInvoiceObject->id, ['token' => self::MERCHANT_TOKEN], true)
+ ->willReturn(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $testedObject = $this->getClient($restCliMock);
+ $result = $testedObject->getInvoice($exampleInvoiceObject->id, Facade::MERCHANT, true);
+
+ self::assertEquals($exampleInvoiceObject->id, $result->getId());
+ self::assertEquals($exampleInvoiceObject->amountPaid, $result->getAmountPaid());
+ self::assertEquals($exampleInvoiceObject->currency, $result->getCurrency());
+ }
+
+ public function testGetInvoiceByGuid()
+ {
+ $exampleInvoiceObject = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices/guid/' . $exampleInvoiceObject->guid, ['token' => self::MERCHANT_TOKEN], true)
+ ->willReturn(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $testedObject = $this->getClient($restCliMock);
+ $result = $testedObject->getInvoiceByGuid($exampleInvoiceObject->guid, Facade::MERCHANT, true);
+
+ self::assertEquals($exampleInvoiceObject->id, $result->getId());
+ self::assertEquals($exampleInvoiceObject->amountPaid, $result->getAmountPaid());
+ self::assertEquals($exampleInvoiceObject->currency, $result->getCurrency());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testGetInvoiceShouldCatchRestCliExceptions(string $exceptionClass): void
+ {
+ $exampleInvoiceObject = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices/' . $exampleInvoiceObject->id, ['token' => $exampleInvoiceObject->token], true)
+ ->willThrowException(new $exceptionClass);
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceQueryException::class);
+
+ $testedObject->getInvoice($exampleInvoiceObject->id, Facade::MERCHANT, true);
+ }
+
+ public function testGetInvoiceShouldCatchJsonMapperException()
+ {
+ $exampleInvoiceObject = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices/' . $exampleInvoiceObject->id, ['token' => $exampleInvoiceObject->token], true)
+ ->willReturn('badString');
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceQueryException::class);
+
+ $testedObject->getInvoice($exampleInvoiceObject->id, Facade::MERCHANT, true);
+ }
+
+ public function testGetInvoices()
+ {
+ $params = [
+ 'status' => 'status',
+ 'dateStart' => 'dateStart',
+ 'dateEnd' => 'dateEnd',
+ 'limit' => 1,
+ 'offset' => 1,
+ 'orderId' => 'orderId',
+ 'token' => self::MERCHANT_TOKEN
+ ];
+
+ $successResponse = file_get_contents(__DIR__ . '/jsonResponse/getInvoices.json');
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices', $params)
+ ->willReturn($successResponse);
+
+ $testedObject = $this->getClient($restCliMock);
+ $result = $testedObject->getInvoices(
+ $params['dateStart'],
+ $params['dateEnd'],
+ $params['status'],
+ $params['orderId'],
+ $params['limit'],
+ $params['offset']);
+
+ $responseToCompare = json_decode($successResponse, true);
+
+ self::assertInstanceOf(Invoice::class, $result[0]);
+ self::assertEquals($responseToCompare[0]['id'], $result[0]->getId());
+ self::assertEquals($responseToCompare[0]['guid'], $result[0]->getGuid());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testGetInvoicesShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $params = [
+ 'status' => 'status',
+ 'dateStart' => 'dateStart',
+ 'dateEnd' => 'dateEnd',
+ 'limit' => 1,
+ 'offset' => 1,
+ 'orderId' => 'orderId',
+ 'token' => self::MERCHANT_TOKEN
+ ];
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices', $params)
+ ->willThrowException(new $exceptionClass);
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceQueryException::class);
+
+ $testedObject->getInvoices(
+ $params['dateStart'],
+ $params['dateEnd'],
+ $params['status'],
+ $params['orderId'],
+ $params['limit'],
+ $params['offset']);
+ }
+
+ public function testGetInvoicesShouldCatchJsonMapperException()
+ {
+ $params = [
+ 'status' => 'status',
+ 'dateStart' => 'dateStart',
+ 'dateEnd' => 'dateEnd',
+ 'limit' => 1,
+ 'offset' => 1,
+ 'orderId' => 'orderId',
+ 'token' => self::MERCHANT_TOKEN
+ ];
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method("get")
+ ->with('invoices', $params)
+ ->willReturn('badString');
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceQueryException::class);
+
+ $testedObject->getInvoices(
+ $params['dateStart'],
+ $params['dateEnd'],
+ $params['status'],
+ $params['orderId'],
+ $params['limit'],
+ $params['offset']);
+ }
+
+ public function testRequestInvoiceNotificationShouldReturnTrueOnSuccess()
+ {
+ $invoiceId = self::TEST_INVOICE_ID;
+ $params['token'] = self::MERCHANT_TOKEN;
+ $expectedSuccessResponse = 'success';
+ $restCliMock = $this->getRestCliMock();
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with('invoices/' . $invoiceId . '/notifications', $params)
+ ->willReturn($expectedSuccessResponse);
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $result = $testedObject->requestInvoiceNotification($invoiceId);
+ self::assertTrue($result);
+ }
+
+ public function testRequestInvoiceNotificationShouldReturnFalseOnFailure()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $expectedFailResponse = 'fail';
+ $restCliMock = $this->getRestCliMock();
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with('invoices/' . self::TEST_INVOICE_ID . '/notifications', $params)
+ ->willReturn($expectedFailResponse);
+ $testedObject = $this->getClient($restCliMock);
+
+ $result = $testedObject->requestInvoiceNotification(self::TEST_INVOICE_ID);
+ self::assertFalse($result);
+ }
+
+ public function testRequestInvoiceNotificationShouldCatchJsonMapperException()
+ {
+ $params['token'] = self::MERCHANT_TOKEN;
+ $restCliMock = $this->getRestCliMock();
+
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with("invoices/" . self::TEST_INVOICE_ID . '/notifications', $params, true)
+ ->willThrowException(new InvoiceQueryException());
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoiceQueryException::class);
+ $testedObject->requestInvoiceNotification(self::TEST_INVOICE_ID);
+ }
+
+ public function testCancelInvoice()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $invoice = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+ $invoice->isCancelled = true;
+ $restCliMock->expects(self::once())->method('delete')->with("invoices/" . self::TEST_INVOICE_ID, $params)->willReturn(json_encode($invoice));
+ $testedObject = $this->getClient($restCliMock);
+
+ $result = $testedObject->cancelInvoice(self::TEST_INVOICE_ID, $params['forceCancel']);
+ self::assertEquals(self::TEST_INVOICE_ID, $result->getId());
+ self::assertEquals(true, $result->getIsCancelled());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testCancelInvoiceShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $restCliMock->expects(self::once())->method('delete')->with("invoices/" . self::TEST_INVOICE_ID, $params)->willThrowException(new $exceptionClass());
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoiceCancellationException::class);
+ $testedObject->cancelInvoice(self::TEST_INVOICE_ID, $params['forceCancel']);
+ }
+
+ public function testCancelInvoiceShouldCatchJsonMapperException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $restCliMock->expects(self::once())->method('delete')->with("invoices/" . self::TEST_INVOICE_ID, $params)->willReturn('corruptJson');
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoiceCancellationException::class);
+ $testedObject->cancelInvoice(self::TEST_INVOICE_ID, $params['forceCancel']);
+ }
+
+ public function testCancelInvoiceByGuid()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $invoice = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'));
+ $invoice->isCancelled = true;
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("invoices/guid/" . self::TEST_INVOICE_GUID, $params)
+ ->willReturn(json_encode($invoice));
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $result = $testedObject->cancelInvoiceByGuid(self::TEST_INVOICE_GUID, $params['forceCancel']);
+ self::assertEquals(self::TEST_INVOICE_GUID, $result->getGuid());
+ self::assertEquals(self::TEST_INVOICE_ID, $result->getId());
+ self::assertEquals(true, $result->getIsCancelled());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testCancelInvoiceByGuidShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("invoices/guid/" . self::TEST_INVOICE_GUID, $params)
+ ->willThrowException(new $exceptionClass());
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoiceCancellationException::class);
+ $testedObject->cancelInvoiceByGuid(self::TEST_INVOICE_GUID, $params['forceCancel']);
+ }
+
+ public function testCancelInvoiceByGuidShouldCatchJsonMapperException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'forceCancel' => true
+ ];
+ $restCliMock
+ ->expects(self::once())
+ ->method('delete')
+ ->with("invoices/guid/" . self::TEST_INVOICE_GUID, $params)
+ ->willReturn('corruptJson');
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoiceCancellationException::class);
+ $testedObject->cancelInvoiceByGuid(self::TEST_INVOICE_GUID, $params['forceCancel']);
+ }
+
+ public function testPayInvoice()
+ {
+ $params['status'] = 'confirmed';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with("invoices/pay/" . self::TEST_INVOICE_ID, $params)
+ ->willReturn(file_get_contents(__DIR__ . '/jsonResponse/payInvoiceResponse.json'));
+ $testedObject = $this->getClient($restCliMock);
+
+ $result = $testedObject->payInvoice(self::TEST_INVOICE_ID, $params['status']);
+ self::assertEquals("7f3b1a02-d6ee-4185-bcd5-838276a598b5", $result->getGuid());
+ self::assertEquals('complete', $result->getStatus());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testPayInvoiceShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $params['status'] = 'confirmed';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')->with("invoices/pay/" . self::TEST_INVOICE_ID, $params)->willThrowException(new $exceptionClass());
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoicePaymentException::class);
+ $testedObject->payInvoice(self::TEST_INVOICE_ID, $params['status']);
+ }
+
+ public function testPayInvoiceShouldCatchJsonMapperException()
+ {
+ $params['status'] = 'confirmed';
+ $params['token'] = self::MERCHANT_TOKEN;
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('update')->with("invoices/pay/" . self::TEST_INVOICE_ID, $params)->willReturn('corruptJson');
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(InvoicePaymentException::class);
+ $testedObject->payInvoice(self::TEST_INVOICE_ID, $params['status']);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testCreateInvoice()
+ {
+ $invoiceArray = json_decode(file_get_contents(__DIR__.'/jsonResponse/createInvoiceResponse.json'), true);
+ $invoiceMock = $this->createMock(Invoice::class);
+ $invoiceMock->expects(self::once())->method('toArray')->willReturn($invoiceArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('post')
+ ->with('invoices', $invoiceArray, true)
+ ->willReturn(file_get_contents(__DIR__.'/jsonResponse/createInvoiceResponse.json'));
+
+ $testedObject = $this->getClient($restCliMock);
+ $result = $testedObject->createInvoice($invoiceMock);
+ self::assertEquals($invoiceArray['id'], $result->getId());
+ self::assertEquals($invoiceArray['status'], $result->getStatus());
+ self::assertEquals($invoiceArray['guid'], $result->getGuid());
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testCreateInvoiceShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $invoiceArray = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'), true);
+ $invoiceMock = $this->createMock(Invoice::class);
+ $invoiceMock->expects(self::once())->method('toArray')->willReturn($invoiceArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')->with('invoices', $invoiceArray, true)->willThrowException(new $exceptionClass());
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceCreationException::class);
+ $testedObject->createInvoice($invoiceMock);
+ }
+
+ public function testCreateInvoiceShouldCatchJsonMapperException()
+ {
+ $invoiceArray = json_decode(file_get_contents(__DIR__.'/jsonResponse/getInvoice.json'), true);
+ $invoiceMock = $this->createMock(Invoice::class);
+ $invoiceMock->expects(self::once())->method('toArray')->willReturn($invoiceArray);
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock->expects(self::once())->method('post')->with('invoices', $invoiceArray, true)->willReturn('corruptJson');
+
+ $testedObject = $this->getClient($restCliMock);
+ $this->expectException(InvoiceCreationException::class);
+ $testedObject->createInvoice($invoiceMock);
+ }
+
+ /**
+ * @dataProvider exceptionClassProvider
+ */
+ public function testUpdateInvoiceShouldCatchRestCliExceptions(string $exceptionClass)
+ {
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'buyerEmail' => '',
+ 'buyerSms' => 'buyerSms',
+ 'smsCode' => 'smsCode',
+ 'autoVerify' => false
+ ];
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with('invoices/'. self::TEST_INVOICE_ID, $params)
+ ->willThrowException(new $exceptionClass());
+
+ $this->expectException(InvoiceUpdateException::class);
+ $testedObject = $this->getClient($restCliMock);
+ $testedObject->updateInvoice(
+ self::TEST_INVOICE_ID,
+ $params['buyerSms'],
+ $params['smsCode'],
+ $params['buyerEmail'],
+ $params['autoVerify']
+ );
+ }
+
+ public function testUpdateInvoiceShouldCatchJsonMapperException()
+ {
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'buyerEmail' => '',
+ 'buyerSms' => 'buyerSms',
+ 'smsCode' => 'smsCode',
+ 'autoVerify' => false
+ ];
+
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with('invoices/'. self::TEST_INVOICE_ID, $params)
+ ->willReturn('corruptJson');
+
+ $this->expectException(InvoiceUpdateException::class);
+ $testedObject = $this->getClient($restCliMock);
+ $testedObject->updateInvoice(
+ self::TEST_INVOICE_ID,
+ $params['buyerSms'],
+ $params['smsCode'],
+ $params['buyerEmail'],
+ $params['autoVerify']
+ );
+ }
+
+ public function testUpdateInvoiceShouldThrowExceptionWhenBothBuyerEmailAndSmsProvided()
+ {
+ $params = [
+ 'buyerEmail' => 'test',
+ 'buyerSms' => 'buyerSms',
+ 'smsCode' => 'smsCode',
+ 'autoVerify' => false
+ ];
+
+ $this->expectExceptionMessage('Updating the invoice requires buyerSms or buyerEmail, but not both.');
+ $testedObject = $this->getClient($this->getRestCliMock());
+ $testedObject->updateInvoice(
+ self::TEST_INVOICE_ID,
+ $params['buyerSms'],
+ $params['smsCode'],
+ $params['buyerEmail'],
+ $params['autoVerify']
+ );
+ }
+
+ public function testUpdateInvoiceShouldThrowExceptionWhenNoSmsCodeProvided()
+ {
+ $params = [
+ 'buyerEmail' => '',
+ 'buyerSms' => 'buyerSms',
+ 'smsCode' => '',
+ 'autoVerify' => false
+ ];
+
+ $this->expectExceptionMessage('Updating the invoice requires both buyerSms and smsCode when verifying SMS.');
+ $testedObject = $this->getClient($this->getRestCliMock());
+ $testedObject->updateInvoice(
+ self::TEST_INVOICE_ID,
+ $params['buyerSms'],
+ $params['smsCode'],
+ $params['buyerEmail'],
+ $params['autoVerify']
+ );
+ }
+
+ public function testUpdateInvoice()
+ {
+ $params = [
+ 'token' => self::MERCHANT_TOKEN,
+ 'buyerEmail' => null,
+ 'buyerSms' => 'buyerSms',
+ 'smsCode' => 'smsCode',
+ 'autoVerify' => false
+ ];
+
+ $successResponse = file_get_contents(__DIR__.'/jsonResponse/getInvoice.json');
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('update')
+ ->with('invoices/'. self::TEST_INVOICE_ID, $params)
+ ->willReturn($successResponse);
+
+ $testedObject = $this->getClient($restCliMock);
+ $result = $testedObject->updateInvoice(
+ self::TEST_INVOICE_ID,
+ $params['buyerSms'],
+ $params['smsCode'],
+ $params['buyerEmail'],
+ $params['autoVerify']
+ );
+
+ $invoiceArray = json_decode($successResponse, true);
+ self::assertEquals($invoiceArray['id'], $result->getId());
+ self::assertEquals($invoiceArray['status'], $result->getStatus());
+ self::assertEquals($invoiceArray['guid'], $result->getGuid());
+ }
+
+ public function testGetSupportedWallets()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("supportedWallets/", null, false)
+ ->willReturn(file_get_contents(__DIR__.'/jsonResponse/getSupportedWalletsResponse.json'));
+
+ $client = $this->getClient($restCliMock);
+
+ $result = $client->getSupportedWallets();
+ self::assertIsArray($result);
+ self::assertInstanceOf(Wallet::class, $result[0]);
+ self::assertEquals('bitpay-wallet.png', $result[0]->getAvatar());
+ self::assertEquals('copay-wallet.svg', $result[1]->getAvatar());
+ self::assertEquals('BitPay', $result[0]->getDisplayName());
+ self::assertEquals('Copay', $result[1]->getDisplayName());
+ }
+
+ public function testGetSupportedWalletsShouldCatchRestCliBitPayException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("supportedWallets/", null, false)
+ ->willThrowException(new BitPayException());
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(WalletQueryException::class);
+ $testedObject->getSupportedWallets();
+ }
+
+ public function testGetSupportedWalletsShouldCatchRestCliException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("supportedWallets/", null, false)
+ ->willThrowException(new Exception());
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(WalletQueryException::class);
+ $testedObject->getSupportedWallets();
+ }
+
+ public function testGetSupportedWalletsShouldCatchJsonMapperException()
+ {
+ $restCliMock = $this->getRestCliMock();
+ $restCliMock
+ ->expects(self::once())
+ ->method('get')
+ ->with("supportedWallets/", null, false)
+ ->willReturn(self::CORRUPT_JSON_STRING);
+
+ $testedObject = $this->getClient($restCliMock);
+
+ $this->expectException(WalletQueryException::class);
+ $testedObject->getSupportedWallets();
+ }
+
+ public static function exceptionClassProvider(): array
+ {
+ return [
+ [BitPayException::class],
+ [Exception::class],
+ ];
+ }
+
+ private function getClient(RESTcli $restCli)
+ {
+ $testToken = self::MERCHANT_TOKEN;
+
+ $tokens = $this->getMockBuilder(Tokens::class)->getMock();
+ $tokens->setMerchantToken($testToken);
+ $tokens->method('getTokenByFacade')->willReturn($testToken);
+
+ return new Client($restCli, $tokens);
+ }
+
+ private function getTestedClassInstance(): Client
+ {
+ $restCli = $this->getMockBuilder(RESTcli::class)->disableOriginalConstructor()->getMock();
+ $tokens = $this->getMockBuilder(Tokens::class)->disableOriginalConstructor()->getMock();
+
+ return new Client($restCli, $tokens);
+ }
+
+ private function getRestCliMock()
+ {
+ return $this->getMockBuilder(RESTcli::class)->disableOriginalConstructor()->getMock();
+ }
+
+ private function getPayoutParams(): array
+ {
+ return [
+ 'status' => 'status',
+ 'startDate' => '2021-07-08 14:21:05',
+ 'endDate' => '2021-07-08 14:24:05',
+ 'limit' => 1,
+ 'offset' => 1,
+ 'reference' => 'reference',
+ ];
+ }
+
+ private function getInvoiceRefundParams(): array
+ {
+ return [
+ 'token' => self::MERCHANT_TOKEN,
+ 'invoiceId' => 'UZjwcYkWAKfTMn9J1yyfs4',
+ 'amount' => 10.10,
+ 'currency' => Currency::BTC,
+ 'preview' => true,
+ 'immediate' => false,
+ 'buyerPaysRefundFee' => false,
+ 'guid' => '3df73895-2531-e26a-3caa-098a746389b7'
+ ];
+ }
+
+ /**
+ * @throws \ReflectionException
+ */
+ private function refreshResourceClients(): void
+ {
+ $listOfClientsToClear = [
+ BillClient::class,
+ InvoiceClient::class,
+ LedgerClient::class,
+ PayoutClient::class,
+ PayoutRecipientsClient::class,
+ RateClient::class,
+ RefundClient::class,
+ SettlementClient::class,
+ WalletClient::class,
+ TokenClient::class
+ ];
+
+ foreach ($listOfClientsToClear as $className) {
+ $refProperty = new ReflectionProperty($className, 'instance');
+ $refProperty->setAccessible(true);
+ $refProperty->setValue(null);
+ }
+ }
+}
diff --git a/test/unit/BitPaySDK/Exceptions/BillCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BillCreationExceptionTest.php
new file mode 100644
index 00000000..e8daf004
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BillCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(BillCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-BILL-CREATE: Failed to create bill-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(112, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BillCreationException(
+ 'My test message',
+ 112,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BillCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/BillDeliveryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BillDeliveryExceptionTest.php
new file mode 100644
index 00000000..1ee55eb1
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BillDeliveryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(BillDeliveryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-BILL-DELIVERY: Failed to deliver bill-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(115, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BillDeliveryException(
+ 'My test message',
+ 115,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BillDeliveryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/BillExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BillExceptionTest.php
new file mode 100644
index 00000000..cc52fb8b
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BillExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(BillException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-BILL-GENERIC: An unexpected error occurred while trying to manage the bill-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(111, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BillException(
+ 'My test message',
+ 111,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BillException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/BillQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BillQueryExceptionTest.php
new file mode 100644
index 00000000..728e1fc5
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BillQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(BillQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-BILL-GET: Failed to retrieve bill-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(113, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BillQueryException(
+ 'My test message',
+ 113,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BillQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/BillUpdateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BillUpdateExceptionTest.php
new file mode 100644
index 00000000..e80e549d
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BillUpdateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(BillUpdateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-BILL-UPDATE: Failed to update bill-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(114, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BillUpdateException(
+ 'My test message',
+ 114,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BillUpdateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/BitPayExceptionTest.php b/test/unit/BitPaySDK/Exceptions/BitPayExceptionTest.php
new file mode 100644
index 00000000..8dcd0944
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/BitPayExceptionTest.php
@@ -0,0 +1,60 @@
+createClassObject();
+ self::assertInstanceOf(BitPayException::class, $exception);
+ }
+
+ public function testDefaultApiCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(null, $exception->getApiCode());
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(100, $exception->getCode());
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-GENERIC: Unexpected Bitpay exeption.-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new BitPayException(
+ 'My test message',
+ 100,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new BitPayException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/CurrencyExceptionTest.php b/test/unit/BitPaySDK/Exceptions/CurrencyExceptionTest.php
new file mode 100644
index 00000000..22ae6a20
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/CurrencyExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(CurrencyException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-CURRENCY-GENERIC: An unexpected error occurred while trying to manage the currencies-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(181, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new CurrencyException(
+ 'My test message',
+ 181,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new CurrencyException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/CurrencyQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/CurrencyQueryExceptionTest.php
new file mode 100644
index 00000000..483a6040
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/CurrencyQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(CurrencyQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-CURRENCY-GET: Failed to retrieve currencies-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(182, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new CurrencyQueryException(
+ 'My test message',
+ 182,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new CurrencyQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoiceCancellationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoiceCancellationExceptionTest.php
new file mode 100644
index 00000000..7950bd22
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoiceCancellationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoiceCancellationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-CANCEL: Failed to cancel invoice object-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(105, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoiceCancellationException(
+ 'My test message',
+ 105,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoiceCancellationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoiceCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoiceCreationExceptionTest.php
new file mode 100644
index 00000000..c93a23fb
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoiceCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoiceCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-CREATE: Failed to create invoice-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(102, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoiceCreationException(
+ 'My test message',
+ 102,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoiceCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoiceExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoiceExceptionTest.php
new file mode 100644
index 00000000..cfd75865
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoiceExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoiceException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-GENERIC: An unexpected error occurred while trying to manage the invoice-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(101, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoiceException(
+ 'My test message',
+ 101,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoiceException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoicePaymentExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoicePaymentExceptionTest.php
new file mode 100644
index 00000000..b9d6233a
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoicePaymentExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoicePaymentException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-PAY-UPDATE: Failed to pay invoice-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(107, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoicePaymentException(
+ 'My test message',
+ 107,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoicePaymentException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoiceQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoiceQueryExceptionTest.php
new file mode 100644
index 00000000..20241e3f
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoiceQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoiceQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-GET: Failed to retrieve invoice-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(103, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoiceQueryException(
+ 'My test message',
+ 103,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoiceQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/InvoiceUpdateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/InvoiceUpdateExceptionTest.php
new file mode 100644
index 00000000..a587f257
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/InvoiceUpdateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(InvoiceUpdateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-INVOICE-UPDATE: Failed to update invoice-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(104, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new InvoiceUpdateException(
+ 'My test message',
+ 104,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new InvoiceUpdateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/LedgerExceptionTest.php b/test/unit/BitPaySDK/Exceptions/LedgerExceptionTest.php
new file mode 100644
index 00000000..a8705b8a
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/LedgerExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(LedgerException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-LEDGER-GENERIC: An unexpected error occurred while trying to manage the ledger-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(131, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new LedgerException(
+ 'My test message',
+ 131,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new LedgerException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/LedgerQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/LedgerQueryExceptionTest.php
new file mode 100644
index 00000000..c4cf1d6c
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/LedgerQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(LedgerQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-LEDGER-GET: Failed to retrieve ledger-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(132, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new LedgerQueryException(
+ 'My test message',
+ 132,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new LedgerQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutBatchCancellationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutBatchCancellationExceptionTest.php
new file mode 100644
index 00000000..876863db
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutBatchCancellationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutBatchCancellationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-CANCEL: Failed to cancel payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(204, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutBatchCancellationException(
+ 'My test message',
+ 204,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutBatchCancellationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutBatchCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutBatchCreationExceptionTest.php
new file mode 100644
index 00000000..3abd2ec1
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutBatchCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutBatchCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-SUBMIT: Failed to create payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(202, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutBatchCreationException(
+ 'My test message',
+ 202,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutBatchCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutBatchExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutBatchExceptionTest.php
new file mode 100644
index 00000000..fcd969c8
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutBatchExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutBatchException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-GENERIC: An unexpected error occurred while trying to manage the payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(201, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutBatchException(
+ 'My test message',
+ 201,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutBatchException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutBatchNotificationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutBatchNotificationExceptionTest.php
new file mode 100644
index 00000000..ee5dd566
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutBatchNotificationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutBatchNotificationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-NOTIFICATION: Failed to send payout batch notification-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(205, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutBatchNotificationException(
+ 'My test message',
+ 205,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutBatchNotificationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutBatchQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutBatchQueryExceptionTest.php
new file mode 100644
index 00000000..487a5baa
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutBatchQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutBatchQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-GET: Failed to retrieve payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(203, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutBatchQueryException(
+ 'My test message',
+ 203,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutBatchQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutCancellationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutCancellationExceptionTest.php
new file mode 100644
index 00000000..79cbe94c
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutCancellationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutCancellationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-CANCEL: Failed to cancel payout-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(124, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutCancellationException(
+ 'My test message',
+ 124,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutCancellationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutCreationExceptionTest.php
new file mode 100644
index 00000000..fc981884
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-SUBMIT: Failed to create payout-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(122, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutCreationException(
+ 'My test message',
+ 122,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutExceptionTest.php
new file mode 100644
index 00000000..5e1d31a9
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-GENERIC: An unexpected error occurred while trying to manage the payout-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(121, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutException(
+ 'My test message',
+ 121,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutNotificationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutNotificationExceptionTest.php
new file mode 100644
index 00000000..2a832afd
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutNotificationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutNotificationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-NOTIFICATION: Failed to send payout notification-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(126, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutNotificationException(
+ 'My test message',
+ 126,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutNotificationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutQueryExceptionTest.php
new file mode 100644
index 00000000..a63dae1a
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-GET: Failed to retrieve payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(123, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutQueryException(
+ 'My test message',
+ 123,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientCancellationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientCancellationExceptionTest.php
new file mode 100644
index 00000000..34432dfa
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientCancellationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientCancellationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-CANCEL: Failed to cancel payout recipient-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(194, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientCancellationException(
+ 'My test message',
+ 194,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientCancellationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientCreationExceptionTest.php
new file mode 100644
index 00000000..75ef1dd3
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-SUBMIT: Failed to create payout recipient-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(192, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientCreationException(
+ 'My test message',
+ 192,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientExceptionTest.php
new file mode 100644
index 00000000..b521f9f6
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-GENERIC: An unexpected error occurred while trying to manage the payout recipient-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(191, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientException(
+ 'My test message',
+ 191,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientNotificationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientNotificationExceptionTest.php
new file mode 100644
index 00000000..5515d74c
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientNotificationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientNotificationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-NOTIFICATION: Failed to send payout recipient notification-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(196, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientNotificationException(
+ 'My test message',
+ 196,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientNotificationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientQueryExceptionTest.php
new file mode 100644
index 00000000..700407d9
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-GET: Failed to retrieve payout recipient-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(193, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientQueryException(
+ 'My test message',
+ 193,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutRecipientUpdateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutRecipientUpdateExceptionTest.php
new file mode 100644
index 00000000..197af2d7
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutRecipientUpdateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutRecipientUpdateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-RECIPIENT-UPDATE: Failed to update payout recipient-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(195, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutRecipientUpdateException(
+ 'My test message',
+ 195,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutRecipientUpdateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/PayoutUpdateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/PayoutUpdateExceptionTest.php
new file mode 100644
index 00000000..445ba428
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/PayoutUpdateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(PayoutUpdateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-PAYOUT-BATCH-UPDATE: Failed to update payout batch-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(125, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new PayoutUpdateException(
+ 'My test message',
+ 125,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new PayoutUpdateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RateExceptionTest.php
new file mode 100644
index 00000000..00226311
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-RATES-GENERIC: An unexpected error occurred while trying to manage the rates-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(141, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RateException(
+ 'My test message',
+ 141,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RateQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RateQueryExceptionTest.php
new file mode 100644
index 00000000..890d9136
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RateQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RateQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-RATES-GET: Failed to retrieve rates-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(142, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RateQueryException(
+ 'My test message',
+ 142,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RateQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundCancellationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundCancellationExceptionTest.php
new file mode 100644
index 00000000..56ab216f
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundCancellationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundCancellationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-CANCEL: Failed to cancel refund object-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(165, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundCancellationException(
+ 'My test message',
+ 165,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundCancellationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundCreationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundCreationExceptionTest.php
new file mode 100644
index 00000000..2bc35dff
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundCreationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundCreationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-CREATE: Failed to create refund-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(162, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundCreationException(
+ 'My test message',
+ 162,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundCreationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundExceptionTest.php
new file mode 100644
index 00000000..81c202f5
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-GENERIC: An unexpected error occurred while trying to manage the refund-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(161, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundException(
+ 'My test message',
+ 161,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundNotificationExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundNotificationExceptionTest.php
new file mode 100644
index 00000000..d07cd2e0
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundNotificationExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundNotificationException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-NOTIFICATION: Failed to send refund notification-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(166, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundNotificationException(
+ 'My test message',
+ 166,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundNotificationException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundQueryExceptionTest.php
new file mode 100644
index 00000000..d30d7f09
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-GET: Failed to retrieve refund-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(163, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundQueryException(
+ 'My test message',
+ 163,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/RefundUpdateExceptionTest.php b/test/unit/BitPaySDK/Exceptions/RefundUpdateExceptionTest.php
new file mode 100644
index 00000000..949f52a8
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/RefundUpdateExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(RefundUpdateException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-REFUND-UPDATE: Failed to update refund-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(164, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new RefundUpdateException(
+ 'My test message',
+ 164,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new RefundUpdateException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/SettlementExceptionTest.php b/test/unit/BitPaySDK/Exceptions/SettlementExceptionTest.php
new file mode 100644
index 00000000..0ae37f29
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/SettlementExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(SettlementException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-SETTLEMENTS-GENERIC: An unexpected error occurred while trying to manage the settlements-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(151, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new SettlementException(
+ 'My test message',
+ 151,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new SettlementException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/SettlementQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/SettlementQueryExceptionTest.php
new file mode 100644
index 00000000..897bf466
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/SettlementQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(SettlementQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-SETTLEMENTS-GET: Failed to retrieve settlements-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(152, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new SettlementQueryException(
+ 'My test message',
+ 152,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new SettlementQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/WalletExceptionTest.php b/test/unit/BitPaySDK/Exceptions/WalletExceptionTest.php
new file mode 100644
index 00000000..499e73fa
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/WalletExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(WalletException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-WALLET-GENERIC: An unexpected error occurred while trying to manage the wallet-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(181, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new WalletException(
+ 'My test message',
+ 181,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new WalletException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Exceptions/WalletQueryExceptionTest.php b/test/unit/BitPaySDK/Exceptions/WalletQueryExceptionTest.php
new file mode 100644
index 00000000..ac751931
--- /dev/null
+++ b/test/unit/BitPaySDK/Exceptions/WalletQueryExceptionTest.php
@@ -0,0 +1,61 @@
+createClassObject();
+
+ self::assertEquals('000000', $exception->getApiCode());
+ }
+
+ public function testInstanceOf()
+ {
+ $exception = $this->createClassObject();
+ self::assertInstanceOf(WalletQueryException::class, $exception);
+ }
+
+ public function testDefaultMessage()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(
+ 'BITPAY-WALLET-GET: Failed to retrieve supported wallets-> ',
+ $exception->getMessage()
+ );
+ }
+
+ public function testDefaultCode()
+ {
+ $exception = $this->createClassObject();
+
+ self::assertEquals(183, $exception->getCode());
+ }
+
+ public function testGetApiCode()
+ {
+ $exception = new WalletQueryException(
+ 'My test message',
+ 183,
+ null,
+ 'CUSTOM-API-CODE'
+ );
+
+ self::assertEquals('CUSTOM-API-CODE', $exception->getApiCode());
+ }
+
+ private function createClassObject()
+ {
+ return new WalletQueryException();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Bill/BillTest.php b/test/unit/BitPaySDK/Model/Bill/BillTest.php
new file mode 100644
index 00000000..f524a397
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Bill/BillTest.php
@@ -0,0 +1,302 @@
+createClassObject();
+ self::assertInstanceOf(Bill::class, $bill);
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = 'abcd123';
+
+ $bill = $this->createClassObject();
+ $bill->setToken($expectedToken);
+ self::assertEquals($expectedToken, $bill->getToken());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $bill = $this->createClassObject();
+ $bill->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $bill->getCurrency());
+ }
+
+ public function testGetEmail()
+ {
+ $expectedEmail = 'test@test.com';
+
+ $bill = $this->createClassObject();
+ $bill->setEmail($expectedEmail);
+ self::assertEquals($expectedEmail, $bill->getEmail());
+ }
+
+ public function testSetItems()
+ {
+ $bill = $this->createClassObject();
+ $arrayWithoutObject = ['description' => 'gd'];
+
+ $createdObject = Item::createFromArray($arrayWithoutObject);
+ $testArray = [new Item(), $createdObject];
+
+ $bill->setItems($testArray);
+
+ self::assertEquals($testArray, $bill->getItems());
+ }
+
+ public function testGetNumber()
+ {
+ $expectedNumber = '12';
+
+ $bill = $this->createClassObject();
+ $bill->setNumber($expectedNumber);
+ self::assertEquals($expectedNumber, $bill->getNumber());
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'TestName';
+
+ $bill = $this->createClassObject();
+ $bill->setName($expectedName);
+ self::assertEquals($expectedName, $bill->getName());
+ }
+
+ public function testGetAddress1()
+ {
+ $expectedAddress = 'Address1';
+
+ $bill = $this->createClassObject();
+ $bill->setAddress1($expectedAddress);
+ self::assertEquals($expectedAddress, $bill->getAddress1());
+ }
+
+ public function testGetAddress2()
+ {
+ $expectedAddress2 = 'Address2';
+
+ $bill = $this->createClassObject();
+ $bill->setAddress2($expectedAddress2);
+ self::assertEquals($expectedAddress2, $bill->getAddress2());
+ }
+
+ public function testGetCity()
+ {
+ $expectedCity = 'Miami';
+
+ $bill = $this->createClassObject();
+ $bill->setCity($expectedCity);
+ self::assertEquals($expectedCity, $bill->getCity());
+ }
+
+ public function testGetState()
+ {
+ $expectedState = 'Ab';
+
+ $bill = $this->createClassObject();
+ $bill->setState($expectedState);
+ self::assertEquals($expectedState, $bill->getState());
+ }
+
+ public function testGetZip()
+ {
+ $expectedZip = '12345';
+
+ $bill = $this->createClassObject();
+ $bill->setZip($expectedZip);
+ self::assertEquals($expectedZip, $bill->getZip());
+ }
+
+ public function testGetCountry()
+ {
+ $expectedCountry = 'Canada';
+
+ $bill = $this->createClassObject();
+ $bill->setCountry($expectedCountry);
+ self::assertEquals($expectedCountry, $bill->getCountry());
+ }
+
+ public function testGetCc()
+ {
+ $expectedCc = [''];
+
+ $bill = $this->createClassObject();
+ $bill->setCc($expectedCc);
+ self::assertEquals($expectedCc, $bill->getCc());
+ }
+
+ public function testGetPhone()
+ {
+ $expectedPhone = '123456789';
+
+ $bill = $this->createClassObject();
+ $bill->setPhone($expectedPhone);
+ self::assertEquals($expectedPhone, $bill->getPhone());
+ }
+
+ public function testGetDueDate()
+ {
+ $expectedDueDate = '2022-01-01';
+
+ $bill = $this->createClassObject();
+ $bill->setDueDate($expectedDueDate);
+ self::assertEquals($expectedDueDate, $bill->getDueDate());
+ }
+
+ public function testGetPassProcessingFee()
+ {
+ $bill = $this->createClassObject();
+ $bill->setPassProcessingFee(true);
+ self::assertTrue($bill->getPassProcessingFee());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'status';
+
+ $bill = $this->createClassObject();
+ $bill->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $bill->getStatus());
+ }
+
+ public function testGetUrl()
+ {
+ $expectedUrl = 'http://test.com/';
+
+ $bill = $this->createClassObject();
+ $bill->setUrl($expectedUrl);
+ self::assertEquals($expectedUrl, $bill->getUrl());
+ }
+
+ public function testGetCreateDate()
+ {
+ $expectedCreateDate = '2022-01-01';
+
+ $bill = $this->createClassObject();
+ $bill->setCreateDate($expectedCreateDate);
+ self::assertEquals($expectedCreateDate, $bill->getCreateDate());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = '1';
+
+ $bill = $this->createClassObject();
+ $bill->setId($expectedId);
+ self::assertEquals($expectedId, $bill->getId());
+ }
+
+ public function testGetMerchant()
+ {
+ $expectedMerchant = 'TestUser';
+
+ $bill = $this->createClassObject();
+ $bill->setMerchant($expectedMerchant);
+ self::assertEquals($expectedMerchant, $bill->getMerchant());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testToArray()
+ {
+ $bill = $this->createClassObject();
+ $this->objectSetters($bill);
+
+ $billArray = $bill->toArray();
+
+ self::assertNotNull($billArray);
+ self::assertIsArray($billArray);
+
+ self::assertArrayHasKey('currency', $billArray);
+ self::assertArrayHasKey('token', $billArray);
+ self::assertArrayHasKey('email', $billArray);
+ self::assertArrayHasKey('items', $billArray);
+ self::assertArrayHasKey('number', $billArray);
+ self::assertArrayHasKey('name', $billArray);
+ self::assertArrayHasKey('address1', $billArray);
+ self::assertArrayHasKey('address2', $billArray);
+ self::assertArrayHasKey('city', $billArray);
+ self::assertArrayHasKey('state', $billArray);
+ self::assertArrayHasKey('zip', $billArray);
+ self::assertArrayHasKey('country', $billArray);
+ self::assertArrayHasKey('cc', $billArray);
+ self::assertArrayHasKey('phone', $billArray);
+ self::assertArrayHasKey('dueDate', $billArray);
+ self::assertArrayHasKey('passProcessingFee', $billArray);
+ self::assertArrayHasKey('status', $billArray);
+ self::assertArrayHasKey('url', $billArray);
+ self::assertArrayHasKey('createDate', $billArray);
+ self::assertArrayHasKey('id', $billArray);
+ self::assertArrayHasKey('merchant', $billArray);
+
+ self::assertEquals('BTC', $billArray['currency']);
+ self::assertEquals('abcd123', $billArray['token']);
+ self::assertEquals('test@test.com', $billArray['email']);
+ self::assertEquals([[]], $billArray['items']);
+ self::assertEquals('12', $billArray['number']);
+ self::assertEquals('TestName', $billArray['name']);
+ self::assertEquals('Address1', $billArray['address1']);
+ self::assertEquals('Address2', $billArray['address2']);
+ self::assertEquals('Miami', $billArray['city']);
+ self::assertEquals('AB', $billArray['state']);
+ self::assertEquals('12345', $billArray['zip']);
+ self::assertEquals('Canada', $billArray['country']);
+ self::assertEquals([''], $billArray['cc']);
+ self::assertEquals('123456789', $billArray['phone']);
+ self::assertEquals('2022-01-01', $billArray['dueDate']);
+ self::assertEquals(true, $billArray['passProcessingFee']);
+ self::assertEquals('status', $billArray['status']);
+ self::assertEquals('http://test.com/', $billArray['url']);
+ self::assertEquals('2022-01-01', $billArray['createDate']);
+ self::assertEquals('1', $billArray['id']);
+ self::assertEquals('TestUser', $billArray['merchant']);
+ }
+
+ private function createClassObject(): Bill
+ {
+ return new Bill();
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ private function objectSetters(Bill $bill): void
+ {
+ $bill->setCurrency('BTC');
+ $bill->setToken('abcd123');
+ $bill->setEmail('test@test.com');
+ $bill->setItems([new Item()]);
+ $bill->setNumber('12');
+ $bill->setName('TestName');
+ $bill->setAddress1('Address1');
+ $bill->setAddress2('Address2');
+ $bill->setCity('Miami');
+ $bill->setState('AB');
+ $bill->setZip('12345');
+ $bill->setCountry('Canada');
+ $bill->setCc(['']);
+ $bill->setPhone('123456789');
+ $bill->setDueDate('2022-01-01');
+ $bill->setPassProcessingFee(true);
+ $bill->setStatus('status');
+ $bill->setUrl('http://test.com/');
+ $bill->setCreateDate('2022-01-01');
+ $bill->setId('1');
+ $bill->setMerchant('TestUser');
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Bill/ItemTest.php b/test/unit/BitPaySDK/Model/Bill/ItemTest.php
new file mode 100644
index 00000000..71aa05e2
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Bill/ItemTest.php
@@ -0,0 +1,99 @@
+createClassObject();
+ self::assertInstanceOf(Item::class, $item);
+ }
+
+ public function testGetId()
+ {
+ $expectedId = 5;
+
+ $item = $this->createClassObject();
+ $item->setId($expectedId);
+ self::assertEquals($expectedId, $item->getId());
+ }
+
+ public function testGetDescription()
+ {
+ $expectedDescription = 'test description';
+
+ $item = $this->createClassObject();
+ $item->setDescription($expectedDescription);
+ self::assertEquals($expectedDescription, $item->getDescription());
+ }
+
+ public function testGetPrice()
+ {
+ $expectedPrice = 10.0;
+
+ $item = $this->createClassObject();
+ $item->setPrice($expectedPrice);
+ self::assertEquals($expectedPrice, $item->getPrice());
+ }
+
+ public function testGetQuantity()
+ {
+ $expectedQuantity = 5;
+
+ $item = $this->createClassObject();
+ $item->setQuantity($expectedQuantity);
+ self::assertEquals($expectedQuantity, $item->getQuantity());
+ }
+
+ public function testCreateFromArray()
+ {
+ $testArrayItem = [
+ 'description' => 'test',
+ 'price' => 12
+ ];
+
+ $item = $this->createClassObject();
+ $item = $item::createFromArray($testArrayItem);
+
+ self::assertEquals('test', $item->getDescription());
+ self::assertEquals(12, $item->getPrice());
+ }
+
+ public function testToArray()
+ {
+ $item = $this->createClassObject();
+ $this->objectSetters($item);
+
+ $itemArray = $item->toArray();
+
+ self::assertNotNull($itemArray);
+ self::assertIsArray($itemArray);
+
+ self::assertArrayHasKey('id', $itemArray);
+ self::assertArrayHasKey('description', $itemArray);
+ self::assertArrayHasKey('price', $itemArray);
+ self::assertArrayHasKey('quantity', $itemArray);
+
+ self::assertEquals(1, $itemArray['id']);
+ self::assertEquals('description', $itemArray['description']);
+ self::assertEquals(1.2, $itemArray['price']);
+ self::assertEquals(1, $itemArray['quantity']);
+ }
+
+ private function createClassObject(): Item
+ {
+ return new Item();
+ }
+
+ private function objectSetters(Item $item)
+ {
+ $item->setId(1);
+ $item->setDescription('description');
+ $item->setPrice(1.2);
+ $item->setQuantity(1);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/CurrencyTest.php b/test/unit/BitPaySDK/Model/CurrencyTest.php
new file mode 100644
index 00000000..6f7da423
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/CurrencyTest.php
@@ -0,0 +1,171 @@
+createClassObject();
+ self::assertInstanceOf(Currency::class, $currency);
+ }
+
+ public function testIsValid()
+ {
+ $currencyObject = $this->createClassObject();
+ $reflect = new ReflectionClass(Currency::class);
+ $allCurrencies = $reflect->getConstants();
+
+ foreach ($allCurrencies as $currency) {
+ $result = $currencyObject::isValid($currency);
+
+ self::assertTrue($result);
+ }
+
+ self::assertFalse($currencyObject::isValid('wrongValue'));
+ }
+
+ public function testToArray()
+ {
+ $currency = $this->createClassObject();
+ $this->setSetters($currency);
+
+ $currencyArray = $currency->toArray();
+
+ self::assertNotNull($currencyArray);
+ self::assertIsArray($currencyArray);
+ self::assertArrayHasKey('code', $currencyArray);
+ self::assertArrayHasKey('symbol', $currencyArray);
+ self::assertArrayHasKey('precision', $currencyArray);
+ self::assertArrayHasKey('currentlySettled', $currencyArray);
+ self::assertArrayHasKey('name', $currencyArray);
+ self::assertArrayHasKey('plural', $currencyArray);
+ self::assertArrayHasKey('alts', $currencyArray);
+ self::assertArrayHasKey('minimum', $currencyArray);
+ self::assertArrayHasKey('sanctioned', $currencyArray);
+ self::assertArrayHasKey('decimals', $currencyArray);
+ self::assertArrayHasKey('payoutFields', $currencyArray);
+ self::assertArrayHasKey('settlementMinimum', $currencyArray);
+ self::assertEquals('BTC', $currencyArray['code']);
+ self::assertEquals('Symbol', $currencyArray['symbol']);
+ self::assertEquals(1, $currencyArray['precision']);
+ self::assertEquals(true, $currencyArray['currentlySettled']);
+ self::assertEquals('Bitcoin', $currencyArray['name']);
+ self::assertEquals('plural', $currencyArray['plural']);
+ self::assertEquals('alts', $currencyArray['alts']);
+ self::assertEquals('minimum', $currencyArray['minimum']);
+ self::assertEquals(true, $currencyArray['sanctioned']);
+ self::assertEquals('decimals', $currencyArray['decimals']);
+ self::assertEquals(['test'], $currencyArray['payoutFields']);
+ self::assertEquals(['test'], $currencyArray['settlementMinimum']);
+ }
+
+ public function testGetCode()
+ {
+ $currency = $this->createClassObject();
+ $currency->setCode('testCode');
+ self::assertEquals('testCode', $currency->getCode());
+ }
+
+ public function testGetSymbol()
+ {
+ $currency = $this->createClassObject();
+ $currency->setSymbol('testSymbol');
+ self::assertEquals('testSymbol', $currency->getSymbol());
+ }
+
+ public function testGetPrecision()
+ {
+ $currency = $this->createClassObject();
+ $currency->setPrecision(1);
+ self::assertEquals(1, $currency->getPrecision());
+ }
+
+ public function testGetCurrentlySettled()
+ {
+ $currency = $this->createClassObject();
+ $currency->setCurrentlySettled(true);
+ self::assertEquals(true, $currency->getCurrentlySettled());
+ }
+
+ public function testGetName()
+ {
+ $currency = $this->createClassObject();
+ $currency->setName('testName');
+ self::assertEquals('testName', $currency->getName());
+ }
+
+ public function testGetPlural()
+ {
+ $currency = $this->createClassObject();
+ $currency->setPlural('testPlural');
+ self::assertEquals('testPlural', $currency->getPlural());
+ }
+
+ public function testGetAlts()
+ {
+ $currency = $this->createClassObject();
+ $currency->setAlts('testAlts');
+ self::assertEquals('testAlts', $currency->getAlts());
+ }
+
+ public function testGetMinimum()
+ {
+ $currency = $this->createClassObject();
+ $currency->setMinimum('testMinimum');
+ self::assertEquals('testMinimum', $currency->getMinimum());
+ }
+
+ public function testGetSanctioned()
+ {
+ $currency = $this->createClassObject();
+ $currency->setSanctioned(true);
+ self::assertEquals(true, $currency->getSanctioned());
+ }
+
+ public function testGetDecimals()
+ {
+ $currency = $this->createClassObject();
+ $currency->setDecimals('testDecimals');
+ self::assertEquals('testDecimals', $currency->getDecimals());
+ }
+
+ public function testGetPayoutFields()
+ {
+ $currency = $this->createClassObject();
+ $currency->setPayoutFields(['test']);
+ self::assertEquals(['test'], $currency->getPayoutFields());
+ }
+
+ public function testGetSettlementMinimum()
+ {
+ $currency = $this->createClassObject();
+ $currency->setSettlementMinimum(['test']);
+ self::assertEquals(['test'], $currency->getSettlementMinimum());
+ }
+
+ private function createClassObject(): Currency
+ {
+ return new Currency();
+ }
+
+ private function setSetters(Currency $currency)
+ {
+ $currency->setCode('BTC');
+ $currency->setSymbol('Symbol');
+ $currency->setPrecision(1);
+ $currency->setCurrentlySettled(true);
+ $currency->setName('Bitcoin');
+ $currency->setPlural('plural');
+ $currency->setAlts('alts');
+ $currency->setMinimum('minimum');
+ $currency->setSanctioned(true);
+ $currency->setDecimals('decimals');
+ $currency->setPayoutFields(['test']);
+ $currency->setSettlementMinimum(['test']);
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/BuyerProvidedInfoTest.php b/test/unit/BitPaySDK/Model/Invoice/BuyerProvidedInfoTest.php
new file mode 100644
index 00000000..605079d1
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/BuyerProvidedInfoTest.php
@@ -0,0 +1,146 @@
+createClassObject();
+ self::assertInstanceOf(BuyerProvidedInfo::class, $buyerProvidedInfo);
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'Test User';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setName($expectedName);
+ self::assertEquals($expectedName, $buyerProvidedInfo->getName());
+ }
+
+ /**
+ * https://github.com/bitpay/php-bitpay-client-v2/issues/212
+ *
+ * @return void
+ */
+ public function testGetSelectedWalletAsNull()
+ {
+ $expectedSelectedWallet = null;
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setSelectedWallet($expectedSelectedWallet);
+
+ self::assertNull($buyerProvidedInfo->getSelectedWallet());
+ }
+
+ public function testGetPhoneNumber()
+ {
+ $expectedPhoneNumber = '1112223333';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setPhoneNumber($expectedPhoneNumber);
+ self::assertEquals($expectedPhoneNumber, $buyerProvidedInfo->getPhoneNumber());
+ }
+
+ public function testGetSelectedWallet()
+ {
+ $expectedSelectedWallet = 'bitpay';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setSelectedWallet($expectedSelectedWallet);
+ self::assertEquals($expectedSelectedWallet, $buyerProvidedInfo->getSelectedWallet());
+ }
+
+ public function testGetEmailAddress()
+ {
+ $expectedEmailAddress = 'example@bitpay.com';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setEmailAddress($expectedEmailAddress);
+ self::assertEquals($expectedEmailAddress, $buyerProvidedInfo->getEmailAddress());
+ }
+
+ public function testGetSelectedTransactionCurrency()
+ {
+ $expectedSelectedTransactionCurrency = 'BTC';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setSelectedTransactionCurrency($expectedSelectedTransactionCurrency);
+ self::assertEquals($expectedSelectedTransactionCurrency, $buyerProvidedInfo->getSelectedTransactionCurrency());
+ }
+
+ public function testGetSms()
+ {
+ $expectedSms = '4445556666';
+
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setSms($expectedSms);
+ self::assertEquals($expectedSms, $buyerProvidedInfo->getSms());
+ }
+
+ public function testGetSmsVerified()
+ {
+ $buyerProvidedInfo = $this->createClassObject();
+ $buyerProvidedInfo->setSmsVerified(true);
+ self::assertTrue($buyerProvidedInfo->getSmsVerified());
+ }
+
+ public function testToArray()
+ {
+ $buyerProvidedInfo = $this->createClassObject();
+ $this->objectSetters($buyerProvidedInfo);
+
+ $buyerProvidedInfoArray = $buyerProvidedInfo->toArray();
+
+ self::assertNotNull($buyerProvidedInfoArray);
+ self::assertIsArray($buyerProvidedInfoArray);
+
+ self::assertArrayHasKey('name', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('phoneNumber', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('selectedWallet', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('emailAddress', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('selectedTransactionCurrency', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('sms', $buyerProvidedInfoArray);
+ self::assertArrayHasKey('smsVerified', $buyerProvidedInfoArray);
+
+ self::assertEquals('Test User', $buyerProvidedInfoArray['name']);
+ self::assertEquals('1112223333', $buyerProvidedInfoArray['phoneNumber']);
+ self::assertEquals('bitpay', $buyerProvidedInfoArray['selectedWallet']);
+ self::assertEquals('example@bitpay.com', $buyerProvidedInfoArray['emailAddress']);
+ self::assertEquals('BTC', $buyerProvidedInfoArray['selectedTransactionCurrency']);
+ self::assertEquals('4445556666', $buyerProvidedInfoArray['sms']);
+ self::assertEquals(true, $buyerProvidedInfoArray['smsVerified']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $buyerProvidedInfo = $this->createClassObject();
+
+ $buyerProvidedInfoArray = $buyerProvidedInfo->toArray();
+
+ self::assertNotNull($buyerProvidedInfoArray);
+ self::assertIsArray($buyerProvidedInfoArray);
+
+ self::assertArrayNotHasKey('name', $buyerProvidedInfoArray);
+ }
+
+ private function createClassObject(): BuyerProvidedInfo
+ {
+ return new BuyerProvidedInfo();
+ }
+
+ private function objectSetters(BuyerProvidedInfo $buyerProvidedInfo)
+ {
+ $buyerProvidedInfo->setName('Test User');
+ $buyerProvidedInfo->setPhoneNumber('1112223333');
+ $buyerProvidedInfo->setSelectedWallet('bitpay');
+ $buyerProvidedInfo->setEmailAddress('example@bitpay.com');
+ $buyerProvidedInfo->setSelectedTransactionCurrency('BTC');
+ $buyerProvidedInfo->setSms('4445556666');
+ $buyerProvidedInfo->setSmsVerified(true);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Invoice/BuyerTest.php b/test/unit/BitPaySDK/Model/Invoice/BuyerTest.php
new file mode 100644
index 00000000..c537581a
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/BuyerTest.php
@@ -0,0 +1,166 @@
+createClassObject();
+ self::assertInstanceOf(Buyer::class, $buyer);
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'Test name';
+
+ $buyer = $this->createClassObject();
+ $buyer->setName($expectedName);
+ self::assertEquals($expectedName, $buyer->getName());
+ }
+
+ public function testGetAddress1()
+ {
+ $expectedAddress1 = 'Test address 1';
+
+ $buyer = $this->createClassObject();
+ $buyer->setAddress1($expectedAddress1);
+ self::assertEquals($expectedAddress1, $buyer->getAddress1());
+ }
+
+ public function testGetAddress2()
+ {
+ $expectedAddress2 = 'Test address 2';
+
+ $buyer = $this->createClassObject();
+ $buyer->setAddress2($expectedAddress2);
+ self::assertEquals($expectedAddress2, $buyer->getAddress2());
+ }
+
+ public function testGetLocality()
+ {
+ $expectedLocality = 'Tavares';
+
+ $buyer = $this->createClassObject();
+ $buyer->setLocality($expectedLocality);
+ self::assertEquals($expectedLocality, $buyer->getLocality());
+ }
+
+ public function testGetRegion()
+ {
+ $expectedRegion = 'Test region';
+
+ $buyer = $this->createClassObject();
+ $buyer->setRegion($expectedRegion);
+ self::assertEquals($expectedRegion, $buyer->getRegion());
+ }
+
+ public function testGetPostalCode()
+ {
+ $expectedPostalCode = '12345';
+
+ $buyer = $this->createClassObject();
+ $buyer->setPostalCode($expectedPostalCode);
+ self::assertEquals($expectedPostalCode, $buyer->getPostalCode());
+ }
+
+ public function testGetCountry()
+ {
+ $expectedCountry = 'USA';
+
+ $buyer = $this->createClassObject();
+ $buyer->setCountry($expectedCountry);
+ self::assertEquals($expectedCountry, $buyer->getCountry());
+ }
+
+ public function testGetEmail()
+ {
+ $expectedEmail = 'test@email.com';
+
+ $buyer = $this->createClassObject();
+ $buyer->setEmail($expectedEmail);
+ self::assertEquals($expectedEmail, $buyer->getEmail());
+ }
+
+ public function testGetPhone()
+ {
+ $expectedPhone = '123456789';
+
+ $buyer = $this->createClassObject();
+ $buyer->setPhone($expectedPhone);
+ self::assertEquals($expectedPhone, $buyer->getPhone());
+ }
+
+ public function testGetNotify()
+ {
+ $buyer = $this->createClassObject();
+ $buyer->setNotify(false);
+ self::assertFalse($buyer->getNotify());
+ }
+
+ public function testToArray()
+ {
+ $buyer = $this->createClassObject();
+ $this->setSetters($buyer);
+ $buyerArray = $buyer->toArray();
+
+ self::assertNotNull($buyerArray);
+ self::assertIsArray($buyerArray);
+
+ self::assertArrayHasKey('name', $buyerArray);
+ self::assertArrayHasKey('address1', $buyerArray);
+ self::assertArrayHasKey('address2', $buyerArray);
+ self::assertArrayHasKey('locality', $buyerArray);
+ self::assertArrayHasKey('region', $buyerArray);
+ self::assertArrayHasKey('postalCode', $buyerArray);
+ self::assertArrayHasKey('country', $buyerArray);
+ self::assertArrayHasKey('email', $buyerArray);
+ self::assertArrayHasKey('phone', $buyerArray);
+ self::assertArrayHasKey('notify', $buyerArray);
+
+ self::assertEquals('Test name', $buyerArray['name']);
+ self::assertEquals('Address 1', $buyerArray['address1']);
+ self::assertEquals('Address 2', $buyerArray['address2']);
+ self::assertEquals('Tavares', $buyerArray['locality']);
+ self::assertEquals('Test region', $buyerArray['region']);
+ self::assertEquals('12345', $buyerArray['postalCode']);
+ self::assertEquals('USA', $buyerArray['country']);
+ self::assertEquals('test@email.com', $buyerArray['email']);
+ self::assertEquals('123456789', $buyerArray['phone']);
+ self::assertTrue($buyerArray['notify']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $buyer = $this->createClassObject();
+
+ $buyerArray = $buyer->toArray();
+
+ self::assertNotNull($buyerArray);
+ self::assertIsArray($buyerArray);
+
+ self::assertArrayNotHasKey('name', $buyerArray);
+ }
+
+ private function createClassObject(): Buyer
+ {
+ return new Buyer();
+ }
+
+ private function setSetters(Buyer $buyer)
+ {
+ $buyer->setName('Test name');
+ $buyer->setAddress1('Address 1');
+ $buyer->setAddress2('Address 2');
+ $buyer->setLocality('Tavares');
+ $buyer->setRegion('Test region');
+ $buyer->setPostalCode('12345');
+ $buyer->setCountry('USA');
+ $buyer->setEmail('test@email.com');
+ $buyer->setPhone('123456789');
+ $buyer->setNotify(true);
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/InvoiceTest.php b/test/unit/BitPaySDK/Model/Invoice/InvoiceTest.php
new file mode 100644
index 00000000..dbe7dfd3
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/InvoiceTest.php
@@ -0,0 +1,991 @@
+createClassObject();
+ self::assertInstanceOf(Invoice::class, $invoice);
+ }
+
+ public function testGetCurrencyException()
+ {
+ $expectedCurrency = 'ELO';
+
+ $invoice = $this->createClassObject();
+ $this->expectException(BitPayException::class);
+ $this->expectExceptionMessage('currency code must be a type of Model.Currency');
+ $invoice->setCurrency($expectedCurrency);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $invoice = $this->createClassObject();
+ $invoice->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $invoice->getCurrency());
+ }
+
+ public function testGetGuid()
+ {
+ $expectedGuid = 'Test guid';
+
+ $invoice = $this->createClassObject();
+ $invoice->setGuid($expectedGuid);
+ self::assertEquals($expectedGuid, $invoice->getGuid());
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = 's7k3f9v2nnn3kb3';
+
+ $invoice = $this->createClassObject();
+ $invoice->setToken($expectedToken);
+ self::assertEquals($expectedToken, $invoice->getToken());
+ }
+
+ public function testGetPrice()
+ {
+ $expectedPrice = 150.25;
+
+ $invoice = $this->createClassObject();
+ $invoice->setPrice($expectedPrice);
+ self::assertEquals($expectedPrice, $invoice->getPrice());
+ }
+
+ public function testGetPosData()
+ {
+ $expectedPostData = 'Test post data';
+
+ $invoice = $this->createClassObject();
+ $invoice->setPosData($expectedPostData);
+ self::assertEquals($expectedPostData, $invoice->getPosData());
+ }
+
+ public function testGetNotificationURL()
+ {
+ $expectedNotificationURL = 'http://test.com/';
+
+ $invoice = $this->createClassObject();
+ $invoice->setNotificationURL($expectedNotificationURL);
+ self::assertEquals($expectedNotificationURL, $invoice->getNotificationURL());
+ }
+
+ public function testGetTransactionSpeed()
+ {
+ $expectedTransactionSpeed = 'Test transaction speed';
+
+ $invoice = $this->createClassObject();
+ $invoice->setTransactionSpeed($expectedTransactionSpeed);
+ self::assertEquals($expectedTransactionSpeed, $invoice->getTransactionSpeed());
+ }
+
+ public function testGetFullNotifications()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setFullNotifications(true);
+ self::assertTrue($invoice->getFullNotifications());
+ }
+
+ public function testGetNotificationEmail()
+ {
+ $expectedNotificationEmail = 'test@email.com';
+
+ $invoice = $this->createClassObject();
+ $invoice->setNotificationEmail($expectedNotificationEmail);
+ self::assertEquals($expectedNotificationEmail, $invoice->getNotificationEmail());
+ }
+
+ public function testGetRedirectURL()
+ {
+ $expectedRedirectURL = 'http://test.com/';
+
+ $invoice = $this->createClassObject();
+ $invoice->setRedirectURL($expectedRedirectURL);
+ self::assertEquals($expectedRedirectURL, $invoice->getRedirectURL());
+ }
+
+ public function testGetOrderId()
+ {
+ $expectedOrderId = '15';
+
+ $invoice = $this->createClassObject();
+ $invoice->setOrderId($expectedOrderId);
+ self::assertEquals($expectedOrderId, $invoice->getOrderId());
+ }
+
+ public function testGetItemDesc()
+ {
+ $expectedItemDesc = 'Test item desc';
+
+ $invoice = $this->createClassObject();
+ $invoice->setItemDesc($expectedItemDesc);
+ self::assertEquals($expectedItemDesc, $invoice->getItemDesc());
+ }
+
+ public function testGetItemCode()
+ {
+ $expectedItemCode = 'X3NH';
+
+ $invoice = $this->createClassObject();
+ $invoice->setItemCode($expectedItemCode);
+ self::assertEquals($expectedItemCode, $invoice->getItemCode());
+ }
+
+ public function testGetPhysical()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setPhysical(false);
+ self::assertFalse($invoice->getPhysical());
+ }
+
+ public function testGetPaymentCurrencies()
+ {
+ $expectedPaymentCurrencies = ['BTC'];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentCurrencies($expectedPaymentCurrencies);
+ self::assertEquals($expectedPaymentCurrencies, $invoice->getPaymentCurrencies());
+ }
+
+ public function testGetAcceptanceWindow()
+ {
+ $expectedAcceptanceWindow = 15.0;
+
+ $invoice = $this->createClassObject();
+ $invoice->setAcceptanceWindow($expectedAcceptanceWindow);
+ self::assertEquals($expectedAcceptanceWindow, $invoice->getAcceptanceWindow());
+ }
+
+ public function testGetCloseURL()
+ {
+ $expectedCloseURL = 'http://test.com/';
+
+ $invoice = $this->createClassObject();
+ $invoice->setCloseURL($expectedCloseURL);
+ self::assertEquals($expectedCloseURL, $invoice->getCloseURL());
+ }
+
+ public function testGetAutoRedirect()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setAutoRedirect(true);
+ self::assertTrue($invoice->getAutoRedirect());
+ }
+
+ public function testGetJsonPayProRequired()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setJsonPayProRequired(false);
+ self::assertFalse($invoice->getJsonPayProRequired());
+ }
+
+ public function testGetBitpayIdRequired()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setBitpayIdRequired(true);
+ self::assertTrue($invoice->getBitpayIdRequired());
+ }
+
+ public function testGetMerchantName()
+ {
+ $expectedMerchantName = 'Test merchant name';
+
+ $invoice = $this->createClassObject();
+ $invoice->setMerchantName($expectedMerchantName);
+ self::assertEquals($expectedMerchantName, $invoice->getMerchantName());
+ }
+
+ public function testGetSelectedTransactionCurrency()
+ {
+ $expectedSelectedTransactionCurrency = 'BTC';
+
+ $invoice = $this->createClassObject();
+ $invoice->setSelectedTransactionCurrency($expectedSelectedTransactionCurrency);
+ self::assertEquals($expectedSelectedTransactionCurrency, $invoice->getSelectedTransactionCurrency());
+ }
+
+ public function testGetForcedBuyerSelectedWallet()
+ {
+ $expectedForcedBuyerSelectedWallet = 'Test wallet';
+
+ $invoice = $this->createClassObject();
+ $invoice->setForcedBuyerSelectedWallet($expectedForcedBuyerSelectedWallet);
+ self::assertEquals($expectedForcedBuyerSelectedWallet, $invoice->getForcedBuyerSelectedWallet());
+ }
+
+ public function testGetForcedBuyerSelectedTransactionCurrency()
+ {
+ $expectedForcedBuyerSelectedTransactionCurrency = 'BTC';
+
+ $invoice = $this->createClassObject();
+ $invoice->setForcedBuyerSelectedTransactionCurrency($expectedForcedBuyerSelectedTransactionCurrency);
+ self::assertEquals($expectedForcedBuyerSelectedTransactionCurrency, $invoice->getForcedBuyerSelectedTransactionCurrency());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetItemizedDetailsAsArray(): void
+ {
+ $expectedDescription = 'testDescription';
+ $itemizedDetails = new ItemizedDetails();
+ $itemizedDetails->setAmount(1);
+ $itemizedDetails->setDescription($expectedDescription);
+ $itemizedDetails->setIsFee(true);
+
+ $invoice = $this->createClassObject();
+ $invoice->setItemizedDetails([$itemizedDetails]);
+
+ self::assertSame([$itemizedDetails], $invoice->getItemizedDetails());
+ self::assertSame($expectedDescription, $invoice->getItemizedDetails()[0]->getDescription());
+ self::assertInstanceOf(ItemizedDetails::class, $invoice->getItemizedDetails()[0]);
+ }
+
+ public function testGetBuyer()
+ {
+ $expectedBuyer = $this->getMockBuilder(Buyer::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setBuyer($expectedBuyer);
+ self::assertEquals($expectedBuyer, $invoice->getBuyer());
+ }
+
+ public function testGetBuyerEmail()
+ {
+ $expectedBuyerEmail = 'test@email.com';
+
+ $invoice = $this->createClassObject();
+ $invoice->setBuyerEmail($expectedBuyerEmail);
+ self::assertEquals($expectedBuyerEmail, $invoice->getBuyerEmail());
+ }
+
+ public function testGetBuyerSms()
+ {
+ $expectedBuyerSms = 'Test buyer sms';
+
+ $invoice = $this->createClassObject();
+ $invoice->setBuyerSms($expectedBuyerSms);
+ self::assertEquals($expectedBuyerSms, $invoice->getBuyerSms());
+ }
+
+ public function testGetRefundAddresses()
+ {
+ $expectedRefundAddresses = ['Test refund address'];
+
+ $invoice = $this->createClassObject();
+ $invoice->setRefundAddresses($expectedRefundAddresses);
+ self::assertEquals($expectedRefundAddresses, $invoice->getRefundAddresses());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = '12';
+
+ $invoice = $this->createClassObject();
+ $invoice->setId($expectedId);
+ self::assertEquals($expectedId, $invoice->getId());
+ }
+
+ public function testGetUrl()
+ {
+ $expectedUrl = 'http://test.com/';
+
+ $invoice = $this->createClassObject();
+ $invoice->setUrl($expectedUrl);
+ self::assertEquals($expectedUrl, $invoice->getUrl());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'pending';
+
+ $invoice = $this->createClassObject();
+ $invoice->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $invoice->getStatus());
+ }
+
+ public function testGetFeeDetected()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setLowFeeDetected(true);
+ self::assertTrue($invoice->getLowFeeDetected());
+ }
+
+ public function testGetInvoiceTime()
+ {
+ $expectedInvoiceTime = 1620669854224;
+
+ $invoice = $this->createClassObject();
+ $invoice->setInvoiceTime($expectedInvoiceTime);
+ self::assertEquals($expectedInvoiceTime, $invoice->getInvoiceTime());
+ }
+
+ public function testGetExpirationTime()
+ {
+ $expectedExpirationTime = '01:01:01';
+
+ $invoice = $this->createClassObject();
+ $invoice->setExpirationTime($expectedExpirationTime);
+ self::assertEquals($expectedExpirationTime, $invoice->getExpirationTime());
+ }
+
+ public function testGetCurrentTime()
+ {
+ $expectedCurrencyTime = '01:01:01';
+
+ $invoice = $this->createClassObject();
+ $invoice->setCurrentTime($expectedCurrencyTime);
+ self::assertEquals($expectedCurrencyTime, $invoice->getCurrentTime());
+ }
+
+ public function testGetTransactions()
+ {
+ $expectedTransaction = [];
+
+ $invoice = $this->createClassObject();
+ $invoice->setTransactions($expectedTransaction);
+ self::assertEquals($expectedTransaction, $invoice->getTransactions());
+ }
+
+ public function testGetExceptionStatus()
+ {
+ $expectedExceptionStatus = 'Test exception status';
+
+ $invoice = $this->createClassObject();
+ $invoice->setExceptionStatus($expectedExceptionStatus);
+ self::assertEquals($expectedExceptionStatus, $invoice->getExceptionStatus());
+ }
+
+ public function testGetTargetConfirmations()
+ {
+ $expectedTargetConfirmation = 6;
+
+ $invoice = $this->createClassObject();
+ $invoice->setTargetConfirmations($expectedTargetConfirmation);
+ self::assertEquals($expectedTargetConfirmation, $invoice->getTargetConfirmations());
+ }
+
+ public function testGetRefundAddressRequestPending()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setRefundAddressRequestPending(false);
+ self::assertFalse($invoice->getRefundAddressRequestPending());
+ }
+
+ public function testGetBuyerProvidedEmail()
+ {
+ $expectedBuyerProvidedEmail = 'test@email.com';
+
+ $invoice = $this->createClassObject();
+ $invoice->setBuyerProvidedEmail($expectedBuyerProvidedEmail);
+ self::assertEquals($expectedBuyerProvidedEmail, $invoice->getBuyerProvidedEmail());
+ }
+
+ public function testGetBuyerProvidedInfo()
+ {
+ $expectedBuyerProvidedInfo = $this->getMockBuilder(BuyerProvidedInfo::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setBuyerProvidedInfo($expectedBuyerProvidedInfo);
+ self::assertEquals($expectedBuyerProvidedInfo, $invoice->getBuyerProvidedInfo());
+ }
+
+ public function testGetUniversalCodes()
+ {
+ $expectedUniversalCodes = $this->getMockBuilder(UniversalCodes::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setUniversalCodes($expectedUniversalCodes);
+ self::assertEquals($expectedUniversalCodes, $invoice->getUniversalCodes());
+ }
+
+ public function testGetSupportedTransactionCurrencies()
+ {
+ $expectedSupportedTransactionCurrencies = $this->getMockBuilder(SupportedTransactionCurrencies::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setSupportedTransactionCurrencies($expectedSupportedTransactionCurrencies);
+ self::assertEquals($expectedSupportedTransactionCurrencies, $invoice->getSupportedTransactionCurrencies());
+ }
+
+ public function testGetPaymentTotals()
+ {
+ $expectedPaymentTotals = [
+ "BTC" => 70200,
+ "BCH" => 11495400,
+ "ETH" => 9327000000000000,
+ "GUSD" => 1200,
+ "PAX" => 12000000000000000000,
+ "BUSD" => 12000000000000000000,
+ "USDC" => 12000000,
+ "DOGE" => 13219659000,
+ "LTC" => 20332100,
+ "MATIC" => 12502605000000000000,
+ "USDC_m" => 12000000
+ ];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentTotals($expectedPaymentTotals);
+ self::assertEquals($expectedPaymentTotals, $invoice->getPaymentTotals());
+ }
+
+ public function testGetPaymentSubTotals()
+ {
+ $expectedPaymentSubTotals = [
+ "BTC" => 70100,
+ "BCH" => 11495400,
+ "ETH" => 9327000000000000,
+ "GUSD" => 1200,
+ "PAX" => 12000000000000000000,
+ "BUSD" => 12000000000000000000,
+ "USDC" => 12000000,
+ "DOGE" => 13219659000,
+ "LTC" => 20332100,
+ "MATIC" => 12502605000000000000,
+ "USDC_m" => 12000000
+ ];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentSubtotals($expectedPaymentSubTotals);
+ self::assertEquals($expectedPaymentSubTotals, $invoice->getPaymentSubtotals());
+ }
+
+ public function testGetPaymentDisplaySubTotals()
+ {
+ $expectedPaymentDisplaySubTotals = [
+ "BTC" => "0.000701",
+ "BCH" => "0.114954",
+ "ETH" => "0.009327",
+ "GUSD" => "12.00",
+ "PAX" => "12.00",
+ "BUSD" => "12.00",
+ "USDC" => "12.00",
+ "DOGE" => "132.196590",
+ "LTC" => "0.203321",
+ "MATIC" => "12.502605",
+ "USDC_m" => "12.00"
+ ];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentDisplaySubTotals($expectedPaymentDisplaySubTotals);
+ self::assertEquals($expectedPaymentDisplaySubTotals, $invoice->getPaymentDisplaySubTotals());
+ }
+
+ public function testGetPaymentDisplayTotals()
+ {
+ $expectedPaymentDisplayTotals = [
+ "BTC" => "0.000702",
+ "BCH" => "0.114954",
+ "ETH" => "0.009327",
+ "GUSD" => "12.00",
+ "PAX" => "12.00",
+ "BUSD" => "12.00",
+ "USDC" => "12.00",
+ "DOGE" => "132.196590",
+ "LTC" => "0.203321",
+ "MATIC" => "12.502605",
+ "USDC_m" => "12.00"
+ ];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentDisplayTotals($expectedPaymentDisplayTotals);
+ self::assertEquals($expectedPaymentDisplayTotals, $invoice->getPaymentDisplayTotals());
+ }
+
+ public function testGetPaymentCodes()
+ {
+ $expectedPaymentCodes = [
+ 'BTC' => [
+ "BIP72b" => "bitcoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73"=> "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "BCH" => [
+ "BIP72b" => "bitcoincash:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73" => "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "ETH" => [
+ "EIP681" => "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "GUSD" => [
+ "EIP681b" => "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "PAX" => [
+ "EIP681b" => "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "BUSD" => [
+ "EIP681b" => "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "USDC" => [
+ "EIP681b" => "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "DOGE" => [
+ "BIP72b" => "dogecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73" => "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "LTC" => [
+ "BIP72b" => "litecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73" => "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "MATIC" => [
+ "EIP681" => "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ],
+ "USDC_m" => [
+ "EIP681b" => "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ ]
+ ];
+
+ $invoice = $this->createClassObject();
+ $invoice->setPaymentCodes($expectedPaymentCodes);
+ self::assertEquals($expectedPaymentCodes, $invoice->getPaymentCodes());
+ }
+
+ public function testGetUnderpaidAmount()
+ {
+ $expectedUnderpaidAmount = 10;
+
+ $invoice = $this->createClassObject();
+ $invoice->setUnderpaidAmount($expectedUnderpaidAmount);
+ self::assertEquals($expectedUnderpaidAmount, $invoice->getUnderpaidAmount());
+ }
+
+ public function testGetOverpaidAmount()
+ {
+ $expectedOverpaidAmount = 10;
+
+ $invoice = $this->createClassObject();
+ $invoice->setOverpaidAmount($expectedOverpaidAmount);
+ self::assertEquals($expectedOverpaidAmount, $invoice->getOverpaidAmount());
+ }
+
+ public function testGetMinerFees()
+ {
+ $expectedMinerFees = $this->getMockBuilder(MinerFees::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setMinerFees($expectedMinerFees);
+ self::assertEquals($expectedMinerFees, $invoice->getMinerFees());
+ }
+
+ public function testGetNonPayProPaymentReceived()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setNonPayProPaymentReceived(true);
+ self::assertTrue($invoice->getNonPayProPaymentReceived());
+ }
+
+ public function testGetShopper()
+ {
+ $expectedShopper = $this->getMockBuilder(Shopper::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setShopper($expectedShopper);
+ self::assertEquals($expectedShopper, $invoice->getShopper());
+ }
+
+ public function testGetBillId()
+ {
+ $expectedBillId = '123';
+
+ $invoice = $this->createClassObject();
+ $invoice->setBillId($expectedBillId);
+ self::assertEquals($expectedBillId, $invoice->getBillId());
+ }
+
+ public function testGetRefundInfo()
+ {
+ $expectedRefundInfo = $this->getMockBuilder(RefundInfo::class)->getMock();
+
+ $invoice = $this->createClassObject();
+ $invoice->setRefundInfo($expectedRefundInfo);
+ self::assertEquals($expectedRefundInfo, $invoice->getRefundInfo());
+ }
+
+ public function testGetExtendedNotifications()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setExtendedNotifications(false);
+ self::assertFalse($invoice->getExtendedNotifications());
+ }
+
+ public function testgetTransactionCurrency()
+ {
+ $expectedTransactionCurrency = 'BTC';
+
+ $invoice = $this->createClassObject();
+ $invoice->setTransactionCurrency($expectedTransactionCurrency);
+ self::assertEquals($expectedTransactionCurrency, $invoice->getTransactionCurrency());
+ }
+
+ public function testGetAmountPaid()
+ {
+ $expectedAmountPaid = 11;
+
+ $invoice = $this->createClassObject();
+ $invoice->setAmountPaid($expectedAmountPaid);
+ self::assertEquals($expectedAmountPaid, $invoice->getAmountPaid());
+ }
+
+ public function testGetDisplayAmountPaid()
+ {
+ $expectedDisplayAmountPaid = 'Test display amount paid';
+
+ $invoice = $this->createClassObject();
+ $invoice->setDisplayAmountPaid($expectedDisplayAmountPaid);
+ self::assertEquals($expectedDisplayAmountPaid, $invoice->getDisplayAmountPaid());
+ }
+
+ public function testGetExchangeRates()
+ {
+ $expectedExchangeRates = $this->getExampleExchangeRates();
+
+ $invoice = $this->createClassObject();
+ $invoice->setExchangeRates($expectedExchangeRates);
+ self::assertEquals($expectedExchangeRates, $invoice->getExchangeRates());
+ }
+
+ public function testGetIsCancelled()
+ {
+ $invoice = $this->createClassObject();
+ $invoice->setIsCancelled(false);
+ self::assertFalse($invoice->getIsCancelled());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testToArray()
+ {
+ $invoice = $this->createClassObject();
+ $this->setObjectSetters($invoice);
+ $invoiceArray = $invoice->toArray();
+
+ self::assertNotNull($invoiceArray);
+ self::assertIsArray($invoiceArray);
+
+ self::assertArrayHasKey('currency', $invoiceArray);
+ self::assertArrayHasKey('guid', $invoiceArray);
+ self::assertArrayHasKey('token', $invoiceArray);
+ self::assertArrayHasKey('price', $invoiceArray);
+ self::assertArrayHasKey('posData', $invoiceArray);
+ self::assertArrayHasKey('notificationURL', $invoiceArray);
+ self::assertArrayHasKey('transactionSpeed', $invoiceArray);
+ self::assertArrayHasKey('fullNotifications', $invoiceArray);
+ self::assertArrayHasKey('notificationEmail', $invoiceArray);
+ self::assertArrayHasKey('redirectURL', $invoiceArray);
+ self::assertArrayHasKey('orderId', $invoiceArray);
+ self::assertArrayHasKey('itemDesc', $invoiceArray);
+ self::assertArrayHasKey('itemCode', $invoiceArray);
+ self::assertArrayHasKey('physical', $invoiceArray);
+ self::assertArrayHasKey('paymentCurrencies', $invoiceArray);
+ self::assertArrayHasKey('acceptanceWindow', $invoiceArray);
+ self::assertArrayHasKey('closeURL', $invoiceArray);
+ self::assertArrayHasKey('autoRedirect', $invoiceArray);
+ self::assertArrayHasKey('refundAddresses', $invoiceArray);
+ self::assertArrayHasKey('id', $invoiceArray);
+ self::assertArrayHasKey('url', $invoiceArray);
+ self::assertArrayHasKey('status', $invoiceArray);
+ self::assertArrayHasKey('lowFeeDetected', $invoiceArray);
+ self::assertArrayHasKey('invoiceTime', $invoiceArray);
+ self::assertArrayHasKey('expirationTime', $invoiceArray);
+ self::assertArrayHasKey('currentTime', $invoiceArray);
+ self::assertArrayHasKey('exceptionStatus', $invoiceArray);
+ self::assertArrayHasKey('targetConfirmations', $invoiceArray);
+// self::assertArrayHasKey('refundAddressRequestPending', $invoiceArray);
+ self::assertArrayHasKey('buyerProvidedEmail', $invoiceArray);
+ self::assertArrayHasKey('billId', $invoiceArray);
+ self::assertArrayHasKey('extendedNotifications', $invoiceArray);
+ self::assertArrayHasKey('transactionCurrency', $invoiceArray);
+ self::assertArrayHasKey('amountPaid', $invoiceArray);
+ self::assertArrayHasKey('exchangeRates', $invoiceArray);
+ self::assertArrayHasKey('merchantName', $invoiceArray);
+ self::assertArrayHasKey('selectedTransactionCurrency', $invoiceArray);
+ self::assertArrayHasKey('bitpayIdRequired', $invoiceArray);
+ self::assertArrayHasKey('forcedBuyerSelectedWallet', $invoiceArray);
+ self::assertArrayHasKey('isCancelled', $invoiceArray);
+ self::assertArrayHasKey('buyerEmail', $invoiceArray);
+ self::assertArrayHasKey('buyerSms', $invoiceArray);
+ self::assertArrayHasKey('forcedBuyerSelectedTransactionCurrency', $invoiceArray);
+
+ self::assertEquals('BTC', $invoiceArray['currency']);
+ self::assertEquals('Test guid', $invoiceArray['guid']);
+ self::assertEquals('4h2h7kee5eh2hh4', $invoiceArray['token']);
+ self::assertEquals(355.3, $invoiceArray['price']);
+ self::assertEquals('Test pos data', $invoiceArray['posData']);
+ self::assertEquals('http://test.com/', $invoiceArray['notificationURL']);
+ self::assertEquals('Test transaction speed', $invoiceArray['transactionSpeed']);
+ self::assertTrue($invoiceArray['fullNotifications']);
+ self::assertEquals('test@email.com', $invoiceArray['notificationEmail']);
+ self::assertEquals('http://test.com/', $invoiceArray['redirectURL']);
+ self::assertEquals('34', $invoiceArray['orderId']);
+ self::assertEquals('Test item desc', $invoiceArray['itemDesc']);
+ self::assertEquals('Test item code', $invoiceArray['itemCode']);
+ self::assertTrue($invoiceArray['physical']);
+ self::assertEquals(['BTC'], $invoiceArray['paymentCurrencies']);
+ self::assertEquals(1.1, $invoiceArray['acceptanceWindow']);
+ self::assertEquals('http://test.com/', $invoiceArray['closeURL']);
+ self::assertTrue($invoiceArray['autoRedirect']);
+ self::assertEquals(['Test refund address'], $invoiceArray['refundAddresses']);
+ self::assertEquals('12', $invoiceArray['id']);
+ self::assertEquals('http://test.com/', $invoiceArray['url']);
+ self::assertEquals('pending', $invoiceArray['status']);
+ self::assertEquals('Low fee detected', $invoiceArray['lowFeeDetected']);
+ self::assertEquals(1620734545366, $invoiceArray['invoiceTime']);
+ self::assertEquals('01:01:01', $invoiceArray['expirationTime']);
+ self::assertEquals('01:01:01', $invoiceArray['currentTime']);
+ self::assertEquals('Exception status', $invoiceArray['exceptionStatus']);
+ self::assertEquals(6, $invoiceArray['targetConfirmations']);
+ self::assertEquals('test@email.com', $invoiceArray['buyerProvidedEmail']);
+ self::assertEquals('34', $invoiceArray['billId']);
+ self::assertTrue($invoiceArray['extendedNotifications']);
+ self::assertEquals('BTC', $invoiceArray['transactionCurrency']);
+ self::assertEquals(12, $invoiceArray['amountPaid']);
+ self::assertEquals($this->getExampleExchangeRates(), $invoiceArray['exchangeRates']);
+ self::assertEquals('Merchant name', $invoiceArray['merchantName']);
+ self::assertEquals('BTC', $invoiceArray['selectedTransactionCurrency']);
+ self::assertTrue($invoiceArray['bitpayIdRequired']);
+ self::assertEquals('Forced Buyer Selected Wallet', $invoiceArray['forcedBuyerSelectedWallet']);
+ self::assertTrue($invoiceArray['isCancelled']);
+ self::assertEquals('test@email.com', $invoiceArray['buyerEmail']);
+ self::assertEquals('Buyer sms', $invoiceArray['buyerSms']);
+ self::assertEquals('BTC', $invoiceArray['forcedBuyerSelectedTransactionCurrency']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $invoice = $this->createClassObject();
+ $invoiceArray = $invoice->toArray();
+
+ self::assertNotNull($invoiceArray);
+ self::assertIsArray($invoiceArray);
+
+ self::assertArrayNotHasKey('transactions', $invoiceArray);
+ self::assertArrayNotHasKey('refundAddressRequestPending', $invoiceArray);
+ }
+
+ private function createClassObject(): Invoice
+ {
+ return new Invoice();
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ private function setObjectSetters(Invoice $invoice)
+ {
+ $invoice->setCurrency('BTC');
+ $invoice->setGuid('Test guid');
+ $invoice->setToken('4h2h7kee5eh2hh4');
+ $invoice->setPrice(355.3);
+ $invoice->setPosData('Test pos data');
+ $invoice->setNotificationURL('http://test.com/');
+ $invoice->setTransactionSpeed('Test transaction speed');
+ $invoice->setFullNotifications(true);
+ $invoice->setNotificationEmail('test@email.com');
+ $invoice->setRedirectURL('http://test.com/');
+ $invoice->setOrderId('34');
+ $invoice->setItemDesc('Test item desc');
+ $invoice->setItemCode('Test item code');
+ $invoice->setPhysical(true);
+ $invoice->setPaymentCurrencies(['BTC']);
+ $invoice->setAcceptanceWindow(1.1);
+ $invoice->setCloseURL('http://test.com/');
+ $invoice->setAutoRedirect(true);
+ $invoice->setRefundAddresses(['Test refund address']);
+ $invoice->setId('12');
+ $invoice->setUrl('http://test.com/');
+ $invoice->setStatus('pending');
+ $invoice->setLowFeeDetected('Low fee detected');
+ $invoice->setInvoiceTime(1620734545366);
+ $invoice->setExpirationTime('01:01:01');
+ $invoice->setCurrentTime('01:01:01');
+ $invoice->setTransactions([]);
+ $invoice->setExceptionStatus('Exception status');
+ $invoice->setTargetConfirmations(6);
+ $invoice->setRefundAddressRequestPending(false);
+ $invoice->setBuyerProvidedEmail('test@email.com');
+ $invoice->setBillId('34');
+ $invoice->setExtendedNotifications(true);
+ $invoice->setTransactionCurrency('BTC');
+ $invoice->setAmountPaid(12);
+ $invoice->setExchangeRates($this->getExampleExchangeRates());
+ $invoice->setMerchantName('Merchant name');
+ $invoice->setSelectedTransactionCurrency('BTC');
+ $invoice->setBitpayIdRequired(true);
+ $invoice->setForcedBuyerSelectedWallet('Forced Buyer Selected Wallet');
+ $invoice->setIsCancelled(true);
+ $invoice->setBuyerEmail('test@email.com');
+ $invoice->setBuyerSms('Buyer sms');
+ $invoice->setForcedBuyerSelectedTransactionCurrency('BTC');
+ }
+
+ /**
+ * @return array
+ */
+ private function getExampleExchangeRates(): array
+ {
+ return [
+ "BTC" => [
+ "USD" => 17120.09,
+ "BCH" => 163.84429131974352,
+ "ETH" => 13.299739755292292,
+ "GUSD" => 17120.09,
+ "PAX" => 17120.09,
+ "BUSD" => 17120.09,
+ "USDC" => 17120.09,
+ "DOGE" => 188443.27083844703,
+ "LTC" => 289.92531752751904,
+ "MATIC" => 17878.1223893066,
+ "USDC_m" => 17120.09
+ ],
+ "BCH" => [
+ "USD" => 104.38999999999999,
+ "BTC" => 0.006097902914889888,
+ "ETH" => 0.08109535832200428,
+ "GUSD" => 104.38999999999999,
+ "PAX" => 104.38999999999999,
+ "BUSD" => 104.38999999999999,
+ "USDC" => 104.38999999999999,
+ "DOGE" => 1149.0356092068141,
+ "LTC" => 1.7678238780694326,
+ "MATIC" => 109.01211361737676,
+ "USDC_m" => 104.38999999999999
+ ],
+ "ETH" => [
+ "USD" => 1286.54,
+ "BTC" => 0.07515275424966411,
+ "BCH" => 12.312565795769931,
+ "GUSD" => 1286.54,
+ "PAX" => 1286.54,
+ "BUSD" => 1286.54,
+ "USDC" => 1286.54,
+ "DOGE" => 14161.129156709787,
+ "LTC" => 21.787298899237936,
+ "MATIC" => 1343.5045948203842,
+ "USDC_m" => 1286.54
+ ],
+ "GUSD" => [
+ "USD" => 1,
+ "BTC" => 5.8414627022606464E-5,
+ "BCH" => 0.009570293808019907,
+ "ETH" => 7.768498737618955E-4,
+ "PAX" => 1,
+ "BUSD" => 1,
+ "USDC" => 1,
+ "DOGE" => 11.007142534790825,
+ "LTC" => 0.01693480101608806,
+ "MATIC" => 1.0442773600668336,
+ "USDC_m" => 1
+ ],
+ "PAX" => [
+ "USD" => 1,
+ "BTC" => 5.8414627022606464E-5,
+ "BCH" => 0.009570293808019907,
+ "ETH" => 7.768498737618955E-4,
+ "GUSD" => 1,
+ "BUSD" => 1,
+ "USDC" => 1,
+ "DOGE" => 11.007142534790825,
+ "LTC" => 0.01693480101608806,
+ "MATIC" => 1.0442773600668336,
+ "USDC_m" => 1
+ ],
+ "BUSD" => [
+ "USD" => 1,
+ "BTC" => 5.8414627022606464E-5,
+ "BCH" => 0.009570293808019907,
+ "ETH" => 7.768498737618955E-4,
+ "GUSD" => 1,
+ "PAX" => 1,
+ "USDC" => 1,
+ "DOGE" => 11.007142534790825,
+ "LTC" => 0.01693480101608806,
+ "MATIC" => 1.0442773600668336,
+ "USDC_m" => 1
+ ],
+ "USDC" => [
+ "USD" => 1,
+ "BTC" => 5.8414627022606464E-5,
+ "BCH" => 0.009570293808019907,
+ "ETH" => 7.768498737618955E-4,
+ "GUSD" => 1,
+ "PAX" => 1,
+ "BUSD" => 1,
+ "DOGE" => 11.007142534790825,
+ "LTC" => 0.01693480101608806,
+ "MATIC" => 1.0442773600668336,
+ "USDC_m" => 1
+ ],
+ "DOGE" => [
+ "USD" => 0.09077389999999999,
+ "BTC" => 5.302523511887377E-6,
+ "BCH" => 8.687328930998182E-4,
+ "ETH" => 7.051769275587492E-5,
+ "GUSD" => 0.09077389999999999,
+ "PAX" => 0.09077389999999999,
+ "BUSD" => 0.09077389999999999,
+ "USDC" => 0.09077389999999999,
+ "LTC" => 0.0015372379339542762,
+ "MATIC" => 0.09479312865497075,
+ "USDC_m" => 0.09077389999999999
+ ],
+ "LTC" => [
+ "USD" => 59.02,
+ "BTC" => 0.0034476312868742336,
+ "BCH" => 0.5648387405493349,
+ "ETH" => 0.04584967954942708,
+ "GUSD" => 59.02,
+ "PAX" => 59.02,
+ "BUSD" => 59.02,
+ "USDC" => 59.02,
+ "DOGE" => 649.6415524033546,
+ "MATIC" => 61.63324979114453,
+ "USDC_m" => 59.02
+ ],
+ "MATIC" => [
+ "USD" => 0.9597999999999999,
+ "BTC" => 5.6066359016297676E-5,
+ "BCH" => 0.009185567996937507,
+ "ETH" => 7.456205088366673E-4,
+ "GUSD" => 0.9597999999999999,
+ "PAX" => 0.9597999999999999,
+ "BUSD" => 0.9597999999999999,
+ "USDC" => 0.9597999999999999,
+ "DOGE" => 10.564655404892232,
+ "LTC" => 0.016254022015241322,
+ "USDC_m" => 0.9597999999999999
+ ],
+ "USDC_m" => [
+ "USD" => 1,
+ "BTC" => 5.8414627022606464E-5,
+ "BCH" => 0.009570293808019907,
+ "ETH" => 7.768498737618955E-4,
+ "GUSD" => 1,
+ "PAX" => 1,
+ "BUSD" => 1,
+ "USDC" => 1,
+ "DOGE" => 11.007142534790825,
+ "LTC" => 0.01693480101608806,
+ "MATIC" => 1.0442773600668336
+ ]
+ ];
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/ItemizedDetailsTest.php b/test/unit/BitPaySDK/Model/Invoice/ItemizedDetailsTest.php
new file mode 100644
index 00000000..e2be088c
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/ItemizedDetailsTest.php
@@ -0,0 +1,70 @@
+createClassObject();
+ self::assertInstanceOf(ItemizedDetails::class, $itemizedDetails);
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 15.5;
+
+ $itemizedDetails = $this->createClassObject();
+ $itemizedDetails->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $itemizedDetails->getAmount());
+ }
+
+ public function testGetDescription()
+ {
+ $expectedDescription = 'Test description';
+
+ $itemizedDetails = $this->createClassObject();
+ $itemizedDetails->setDescription($expectedDescription);
+ self::assertEquals($expectedDescription, $itemizedDetails->getDescription());
+ }
+
+ public function testGetIsFee()
+ {
+ $itemizedDetails = $this->createClassObject();
+ $itemizedDetails->setIsFee(true);
+ self::assertTrue($itemizedDetails->getIsFee());
+ }
+
+ public function testToArray()
+ {
+ $itemizedDetails = $this->createClassObject();
+ $this->setSetters($itemizedDetails);
+ $itemizedDetailsArray = $itemizedDetails->toArray();
+
+ self::assertNotNull($itemizedDetailsArray);
+ self::assertIsArray($itemizedDetailsArray);
+
+ self::assertArrayHasKey('amount', $itemizedDetailsArray);
+ self::assertArrayHasKey('description', $itemizedDetailsArray);
+ self::assertArrayHasKey('isFee', $itemizedDetailsArray);
+
+ self::assertEquals(15.5, $itemizedDetailsArray['amount']);
+ self::assertEquals('Test description', $itemizedDetailsArray['description']);
+ self::assertEquals(true, $itemizedDetailsArray['isFee']);
+ }
+
+ private function createClassObject(): ItemizedDetails
+ {
+ return new ItemizedDetails();
+ }
+
+ private function setSetters(ItemizedDetails $itemizedDetails)
+ {
+ $itemizedDetails->setAmount(15.5);
+ $itemizedDetails->setDescription('Test description');
+ $itemizedDetails->setIsFee(true);
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/MinerFeesItemTest.php b/test/unit/BitPaySDK/Model/Invoice/MinerFeesItemTest.php
new file mode 100644
index 00000000..eca59875
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/MinerFeesItemTest.php
@@ -0,0 +1,67 @@
+createClassObject();
+ self::assertInstanceOf(MinerFeesItem::class, $minerFeesItem);
+ }
+
+ public function testGetSatoshisPerByte()
+ {
+ $expectedSatoshiPerByte = 1.1;
+
+ $minerFeesItem = $this->createClassObject();
+ $minerFeesItem->setSatoshisPerByte($expectedSatoshiPerByte);
+ self::assertEquals($expectedSatoshiPerByte, $minerFeesItem->getSatoshisPerByte());
+ }
+
+ public function testGetTotalFee()
+ {
+ $expectedTotalFee = 1.1;
+
+ $minerFeesItem = $this->createClassObject();
+ $minerFeesItem->setTotalFee($expectedTotalFee);
+ self::assertEquals($expectedTotalFee, $minerFeesItem->getTotalFee());
+ }
+
+ public function testGetFiatAmount()
+ {
+ $expectedFiatAmount = 1.1;
+
+ $minerFeesItem = $this->createClassObject();
+ $minerFeesItem->setFiatAmount($expectedFiatAmount);
+ self::assertEquals($expectedFiatAmount, $minerFeesItem->getFiatAmount());
+ }
+
+ public function testToArray()
+ {
+ $minerFeesItem = $this->createClassObject();
+ $minerFeesItem->setSatoshisPerByte(1.1);
+ $minerFeesItem->setTotalFee(1.1);
+ $minerFeesItem->setFiatAmount(null);
+
+ $minerFeesItemArray = $minerFeesItem->toArray();
+
+ self::assertNotNull($minerFeesItemArray);
+ self::assertIsArray($minerFeesItemArray);
+
+ self::assertArrayHasKey('satoshisPerByte', $minerFeesItemArray);
+ self::assertArrayHasKey('totalFee', $minerFeesItemArray);
+ self::assertArrayNotHasKey('fiatAmount', $minerFeesItemArray);
+
+ self::assertEquals(1.1, $minerFeesItemArray['satoshisPerByte']);
+ self::assertEquals(1.1, $minerFeesItemArray['totalFee']);
+ }
+
+ private function createClassObject(): MinerFeesItem
+ {
+ return new MinerFeesItem();
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/MinerFeesTest.php b/test/unit/BitPaySDK/Model/Invoice/MinerFeesTest.php
new file mode 100644
index 00000000..26aa6d7c
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/MinerFeesTest.php
@@ -0,0 +1,139 @@
+createClassObject();
+ self::assertInstanceOf(MinerFees::class, $minesFees);
+ }
+
+ public function testGetBTC()
+ {
+ $expectedBTC = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setBTC($expectedBTC);
+ self::assertEquals($expectedBTC, $minesFees->getBTC());
+ }
+
+ public function testGetBCH()
+ {
+ $expectedBCH = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setBCH($expectedBCH);
+ self::assertEquals($expectedBCH, $minesFees->getBCH());
+ }
+
+ public function testGetETH()
+ {
+ $expectedETH = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setETH($expectedETH);
+ self::assertEquals($expectedETH, $minesFees->getETH());
+ }
+
+ public function testGetUSDC()
+ {
+ $expectedUSDC = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setUSDC($expectedUSDC);
+ self::assertEquals($expectedUSDC, $minesFees->getUSDC());
+ }
+
+ public function testGetGUSD()
+ {
+ $expectedGUSD = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setGUSD($expectedGUSD);
+ self::assertEquals($expectedGUSD, $minesFees->getGUSD());
+ }
+
+ public function testGetPAX()
+ {
+ $expectedPAX = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setPAX($expectedPAX);
+ self::assertEquals($expectedPAX, $minesFees->getPAX());
+ }
+
+ public function testGetBUSD()
+ {
+ $expectedBUSD = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setBUSD($expectedBUSD);
+ self::assertEquals($expectedBUSD, $minesFees->getBUSD());
+ }
+
+ public function testGetXRP()
+ {
+ $expectedXRP = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setXRP($expectedXRP);
+ self::assertEquals($expectedXRP, $minesFees->getXRP());
+ }
+
+ public function testGetDOGE()
+ {
+ $expectedDOGE = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setDOGE($expectedDOGE);
+ self::assertEquals($expectedDOGE, $minesFees->getDOGE());
+ }
+
+ public function testGetLTC()
+ {
+ $expectedLTC = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+
+ $minesFees = $this->createClassObject();
+ $minesFees->setLTC($expectedLTC);
+ self::assertEquals($expectedLTC, $minesFees->getLTC());
+ }
+
+ public function testToArray()
+ {
+ $expectedMinerFeesItem = $this->getMockBuilder(MinerFeesItem::class)->getMock();
+ $expectedMinerFeesItem->expects(self::once())->method('toArray')->willReturn(['satoshisPerByte' => 1.1, 'totalFee' => 1.1, 'fiatAmount' => 1.1]);
+ $minesFees = $this->createClassObject();
+ $minesFees->setBTC($expectedMinerFeesItem);
+ $minesFeesArray = $minesFees->toArray();
+
+ self::assertNotNull($minesFeesArray);
+ self::assertIsArray($minesFeesArray);
+
+ self::assertArrayHasKey('btc', $minesFeesArray);
+ self::assertArrayNotHasKey('bch', $minesFeesArray);
+ self::assertEquals(['btc' => ['satoshisPerByte' => 1.1, 'totalFee' => 1.1, 'fiatAmount' => 1.1]], $minesFeesArray);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $minesFees = $this->createClassObject();
+
+ $minesFeesArray = $minesFees->toArray();
+
+ self::assertNotNull($minesFeesArray);
+ self::assertIsArray($minesFeesArray);
+
+ self::assertArrayNotHasKey('btc', $minesFeesArray);
+ }
+
+ private function createClassObject(): MinerFees
+ {
+ return new MinerFees();
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/RefundInfoTest.php b/test/unit/BitPaySDK/Model/Invoice/RefundInfoTest.php
new file mode 100644
index 00000000..25902485
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/RefundInfoTest.php
@@ -0,0 +1,71 @@
+createClassObject();
+ self::assertInstanceOf(RefundInfo::class, $refundInfo);
+ }
+
+ public function testGetSupportRequest()
+ {
+ $expectedSupportRequest = 'Test support request';
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setSupportRequest($expectedSupportRequest);
+ self::assertEquals($expectedSupportRequest, $refundInfo->getSupportRequest());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $refundInfo->getCurrency());
+ }
+
+ public function testGetAmounts()
+ {
+ $expectedAmount = ['test amount'];
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setAmounts($expectedAmount);
+ self::assertEquals($expectedAmount, $refundInfo->getAmounts());
+ }
+
+ public function testToArray()
+ {
+ $refundInfo = $this->createClassObject();
+ $this->setSetters($refundInfo);
+ $refundInfoArray = $refundInfo->toArray();
+
+ self::assertNotNull($refundInfoArray);
+ self::assertIsArray($refundInfoArray);
+
+ self::assertArrayHasKey('supportRequest', $refundInfoArray);
+ self::assertArrayHasKey('currency', $refundInfoArray);
+ self::assertArrayNotHasKey('amounts', $refundInfoArray);
+
+ self::assertEquals('Test support request', $refundInfoArray['supportRequest']);
+ self::assertEquals('BTC', $refundInfoArray['currency']);
+ }
+
+ private function createClassObject(): RefundInfo
+ {
+ return new RefundInfo();
+ }
+
+ private function setSetters(RefundInfo $refundInfo)
+ {
+ $refundInfo->setSupportRequest('Test support request');
+ $refundInfo->setCurrency('BTC');
+ $refundInfo->setAmounts([]);
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/RefundTest.php b/test/unit/BitPaySDK/Model/Invoice/RefundTest.php
new file mode 100644
index 00000000..9914a145
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/RefundTest.php
@@ -0,0 +1,210 @@
+createClassObject();
+ self::assertInstanceOf(Refund::class, $refund);
+ }
+
+ public function testGetGuid()
+ {
+ $expectedGuid = 'Test guid';
+
+ $refund = $this->createClassObject();
+ $refund->setGuid($expectedGuid);
+ self::assertEquals($expectedGuid, $refund->getGuid());
+ }
+
+ public function testGetReference()
+ {
+ $expectedReference = 'Test reference';
+
+ $refund = $this->createClassObject();
+ $refund->setReference($expectedReference);
+ self::assertEquals($expectedReference, $refund->getReference());
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 15.0;
+
+ $refund = $this->createClassObject();
+ $refund->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $refund->getAmount());
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = 'Test token';
+
+ $refund = $this->createClassObject();
+ $refund->setToken($expectedToken);
+ self::assertEquals($expectedToken, $refund->getToken());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $refund = $this->createClassObject();
+ $refund->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $refund->getCurrency());
+ }
+
+ public function testGetPreview()
+ {
+ $refund = $this->createClassObject();
+ $refund->setPreview(true);
+ self::assertTrue($refund->getPreview());
+ }
+
+ public function testGetInvoiceId()
+ {
+ $expectedInvoiceId = '15';
+
+ $refund = $this->createClassObject();
+ $refund->setInvoiceId($expectedInvoiceId);
+ self::assertEquals($expectedInvoiceId, $refund->getInvoiceId());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = '10';
+
+ $refund = $this->createClassObject();
+ $refund->setId($expectedId);
+ self::assertEquals($expectedId, $refund->getId());
+ }
+
+ public function testGetRequestDate()
+ {
+ $expectedRequestDate = '2022-01-01';
+
+ $refund = $this->createClassObject();
+ $refund->setRequestDate($expectedRequestDate);
+ self::assertEquals($expectedRequestDate, $refund->getRequestDate());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'pending';
+
+ $refund = $this->createClassObject();
+ $refund->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $refund->getStatus());
+ }
+
+ public function testGetImmediate()
+ {
+ $refund = $this->createClassObject();
+ $refund->setImmediate(true);
+ self::assertTrue($refund->getImmediate());
+ }
+
+ public function testGetRefundFee()
+ {
+ $expectedRefundFee = 1.0;
+
+ $refund = $this->createClassObject();
+ $refund->setRefundFee($expectedRefundFee);
+ self::assertEquals($expectedRefundFee, $refund->getRefundFee());
+ }
+
+ public function testGetLastRefundNotification()
+ {
+ $expectedLastRefundNotification = 'Test last refund notification';
+
+ $refund = $this->createClassObject();
+ $refund->setLastRefundNotification($expectedLastRefundNotification);
+ self::assertEquals($expectedLastRefundNotification, $refund->getLastRefundNotification());
+ }
+
+ public function testGetInvoice()
+ {
+ $expectedInvoice = 'Test invoice';
+
+ $refund = $this->createClassObject();
+ $refund->setInvoice($expectedInvoice);
+ self::assertEquals($expectedInvoice, $refund->getInvoice());
+ }
+
+ public function testGetBuyerPaysRefundFee()
+ {
+ $refund = $this->createClassObject();
+ $refund->setBuyerPaysRefundFee(true);
+ self::assertTrue($refund->getBuyerPaysRefundFee());
+ }
+
+ public function testToArray()
+ {
+ $refund = $this->createClassObject();
+ $this->prepareRefund($refund);
+ $refundArray = $refund->toArray();
+
+ self::assertNotNull($refundArray);
+ self::assertIsArray($refundArray);
+
+ self::assertArrayHasKey('guid', $refundArray);
+ self::assertArrayHasKey('amount', $refundArray);
+ self::assertArrayHasKey('currency', $refundArray);
+ self::assertArrayHasKey('token', $refundArray);
+ self::assertArrayHasKey('id', $refundArray);
+ self::assertArrayHasKey('requestDate', $refundArray);
+ self::assertArrayHasKey('status', $refundArray);
+ self::assertArrayHasKey('invoiceId', $refundArray);
+ self::assertArrayHasKey('preview', $refundArray);
+ self::assertArrayHasKey('immediate', $refundArray);
+ self::assertArrayHasKey('refundFee', $refundArray);
+ self::assertArrayHasKey('invoice', $refundArray);
+ self::assertArrayHasKey('buyerPaysRefundFee', $refundArray);
+ self::assertArrayHasKey('reference', $refundArray);
+ self::assertArrayHasKey('lastRefundNotification', $refundArray);
+
+ self::assertEquals('Guid', $refundArray['guid']);
+ self::assertEquals(11.1, $refundArray['amount']);
+ self::assertEquals('BTC', $refundArray['currency']);
+ self::assertEquals('Token', $refundArray['token']);
+ self::assertEquals('1', $refundArray['id']);
+ self::assertEquals('2022-01-01', $refundArray['requestDate']);
+ self::assertEquals('pending', $refundArray['status']);
+ self::assertEquals('11', $refundArray['invoiceId']);
+ self::assertEquals(true, $refundArray['preview']);
+ self::assertEquals(true, $refundArray['immediate']);
+ self::assertEquals(1.0, $refundArray['refundFee']);
+ self::assertEquals('Invoice', $refundArray['invoice']);
+ self::assertEquals(true, $refundArray['buyerPaysRefundFee']);
+ self::assertEquals('Reference', $refundArray['reference']);
+ self::assertEquals('Last refunded notification', $refundArray['lastRefundNotification']);
+ }
+
+ private function createClassObject(): Refund
+ {
+ return new Refund();
+ }
+
+ private function prepareRefund(Refund $refund): void
+ {
+ $refund->setGuid('Guid');
+ $refund->setAmount(11.1);
+ $refund->setCurrency('BTC');
+ $refund->setToken('Token');
+ $refund->setId('1');
+ $refund->setRequestDate('2022-01-01');
+ $refund->setStatus('pending');
+ $refund->setInvoiceId('11');
+ $refund->setPreview(true);
+ $refund->setImmediate(true);
+ $refund->setRefundFee(1.0);
+ $refund->setInvoice('Invoice');
+ $refund->setBuyerPaysRefundFee(true);
+ $refund->setReference('Reference');
+ $refund->setLastRefundNotification('Last refunded notification');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Invoice/RefundWebhookTest.php b/test/unit/BitPaySDK/Model/Invoice/RefundWebhookTest.php
new file mode 100644
index 00000000..81ddbc74
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/RefundWebhookTest.php
@@ -0,0 +1,165 @@
+createClassObject();
+ self::assertInstanceOf(RefundWebhook::class, $refundWebhook);
+ }
+
+ public function testGetId()
+ {
+ $expectedId = 'GZBBLcsgQamua3PN8GX92s';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setId($expectedId);
+ self::assertEquals($expectedId, $refundWebhook->getId());
+ }
+
+ public function testGetInvoice()
+ {
+ $expectedInvoice = 'Wp9cpGphCz7cSeFh6MSYpb';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setInvoice($expectedInvoice);
+ self::assertEquals($expectedInvoice, $refundWebhook->getInvoice());
+ }
+
+ public function testGetSupportRequest()
+ {
+ $expectedSupportRequest = 'XuuYtZfTw7G99Ws3z38kWZ';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setSupportRequest($expectedSupportRequest);
+ self::assertEquals($expectedSupportRequest, $refundWebhook->getSupportRequest());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'pending';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $refundWebhook->getStatus());
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 6;
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $refundWebhook->getAmount());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'USD';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $refundWebhook->getCurrency());
+ }
+
+ public function testGetLastRefundNotification()
+ {
+ $expectedLastRefundNotification = '2022-01-11T16:58:23.967Z';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setLastRefundNotification($expectedLastRefundNotification);
+ self::assertEquals($expectedLastRefundNotification, $refundWebhook->getLastRefundNotification());
+ }
+
+ public function testGetRefundFee()
+ {
+ $expectedRefundFee = 2.31;
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setRefundFee($expectedRefundFee);
+ self::assertEquals($expectedRefundFee, $refundWebhook->getRefundFee());
+ }
+
+ public function testImmediate()
+ {
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setImmediate(false);
+ self::assertFalse($refundWebhook->getImmediate());
+ }
+
+ public function testGetBuyerPaysRefundFee()
+ {
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setBuyerPaysRefundFee(true);
+ self::assertTrue($refundWebhook->getBuyerPaysRefundFee());
+ }
+
+ public function testGetRequestDate()
+ {
+ $expectedRequestDate = '2022-01-11T16:58:23.000Z';
+
+ $refundWebhook = $this->createClassObject();
+ $refundWebhook->setRequestDate($expectedRequestDate);
+ self::assertEquals($expectedRequestDate, $refundWebhook->getRequestDate());
+ }
+
+ public function testToArray()
+ {
+ $refundWebhook = $this->createClassObject();
+ $this->objectSetters($refundWebhook);
+
+ $refundWebhookArray = $refundWebhook->toArray();
+
+ self::assertNotNull($refundWebhookArray);
+ self::assertIsArray($refundWebhookArray);
+
+ self::assertArrayHasKey('id', $refundWebhookArray);
+ self::assertArrayHasKey('invoice', $refundWebhookArray);
+ self::assertArrayHasKey('supportRequest', $refundWebhookArray);
+ self::assertArrayHasKey('status', $refundWebhookArray);
+ self::assertArrayHasKey('amount', $refundWebhookArray);
+ self::assertArrayHasKey('currency', $refundWebhookArray);
+ self::assertArrayHasKey('lastRefundNotification', $refundWebhookArray);
+ self::assertArrayHasKey('refundFee', $refundWebhookArray);
+ self::assertArrayHasKey('immediate', $refundWebhookArray);
+ self::assertArrayHasKey('buyerPaysRefundFee', $refundWebhookArray);
+ self::assertArrayHasKey('requestDate', $refundWebhookArray);
+
+ self::assertEquals('GZBBLcsgQamua3PN8GX92s', $refundWebhookArray['id']);
+ self::assertEquals('Wp9cpGphCz7cSeFh6MSYpb', $refundWebhookArray['invoice']);
+ self::assertEquals('XuuYtZfTw7G99Ws3z38kWZ', $refundWebhookArray['supportRequest']);
+ self::assertEquals('pending', $refundWebhookArray['status']);
+ self::assertEquals(6, $refundWebhookArray['amount']);
+ self::assertEquals('USD', $refundWebhookArray['currency']);
+ self::assertEquals('2022-01-11T16:58:23.967Z', $refundWebhookArray['lastRefundNotification']);
+ self::assertEquals(2.31, $refundWebhookArray['refundFee']);
+ self::assertEquals(false, $refundWebhookArray['immediate']);
+ self::assertEquals(true, $refundWebhookArray['buyerPaysRefundFee']);
+ self::assertEquals('2022-01-11T16:58:23.000Z', $refundWebhookArray['requestDate']);
+ }
+
+ private function createClassObject(): RefundWebhook
+ {
+ return new RefundWebhook();
+ }
+
+ private function objectSetters(RefundWebhook $refundWebhook): void
+ {
+ $refundWebhook->setId('GZBBLcsgQamua3PN8GX92s');
+ $refundWebhook->setInvoice('Wp9cpGphCz7cSeFh6MSYpb');
+ $refundWebhook->setSupportRequest('XuuYtZfTw7G99Ws3z38kWZ');
+ $refundWebhook->setStatus('pending');
+ $refundWebhook->setAmount(6);
+ $refundWebhook->setCurrency('USD');
+ $refundWebhook->setLastRefundNotification('2022-01-11T16:58:23.967Z');
+ $refundWebhook->setRefundFee(2.31);
+ $refundWebhook->setImmediate(false);
+ $refundWebhook->setBuyerPaysRefundFee(true);
+ $refundWebhook->setRequestDate('2022-01-11T16:58:23.000Z');
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Invoice/ShopperTest.php b/test/unit/BitPaySDK/Model/Invoice/ShopperTest.php
new file mode 100644
index 00000000..9fd259d1
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/ShopperTest.php
@@ -0,0 +1,49 @@
+createClassObject();
+ self::assertInstanceOf(Shopper::class, $shopper);
+ }
+
+ public function testGetUser()
+ {
+ $expectedUser = 'Test user';
+
+ $shopper = $this->createClassObject();
+ $shopper->setUser($expectedUser);
+ self::assertEquals($expectedUser, $shopper->getUser());
+ }
+
+ public function testToArray()
+ {
+ $shopper = $this->createClassObject();
+ $shopper->setUser('Test user');
+ $shopperArray = $shopper->toArray();
+
+ self::assertNotNull($shopperArray);
+ self::assertIsArray($shopperArray);
+
+ self::assertArrayHasKey('user', $shopperArray);
+ self::assertEquals('Test user', $shopperArray['user']);
+ }
+
+ public function testToArrayEmptyUser()
+ {
+ $shopper = $this->createClassObject();
+ $shopperArray = $shopper->toArray();
+ self::assertArrayNotHasKey('user', $shopperArray);
+ }
+
+ private function createClassObject(): Shopper
+ {
+ return new Shopper();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrenciesTest.php b/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrenciesTest.php
new file mode 100644
index 00000000..d525c8fb
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrenciesTest.php
@@ -0,0 +1,104 @@
+createClassObject();
+ self::assertInstanceOf(SupportedTransactionCurrencies::class, $supportedTransactionCurrencies);
+ }
+
+ public function testGetBTC()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setBTC($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getBTC());
+ }
+
+ public function testGetBCH()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setBCH($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getBCH());
+ }
+
+ public function testGetETH()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setETH($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getETH());
+ }
+
+ public function testGetUSDC()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setUSDC($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getUSDC());
+ }
+
+ public function testGetGUSD()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setGUSD($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getGUSD());
+ }
+
+ public function testGetPAX()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setPAX($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getPAX());
+ }
+
+ public function testGetXRP()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setXRP($expectedSupportedTransactionCurrency);
+ self::assertEquals($expectedSupportedTransactionCurrency, $supportedTransactionCurrencies->getXRP());
+ }
+
+ public function testToArray()
+ {
+ $expectedSupportedTransactionCurrency = $this->getMockBuilder(SupportedTransactionCurrency::class)->getMock();
+ $expectedSupportedTransactionCurrency->expects(self::once())->method('toArray')->willReturn(['enabled' => true, 'reason' => 'test']);
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrencies->setBTC($expectedSupportedTransactionCurrency);
+ $supportedTransactionCurrenciesArray = $supportedTransactionCurrencies->toArray();
+
+ self::assertNotNull($supportedTransactionCurrenciesArray);
+ self::assertIsArray($supportedTransactionCurrenciesArray);
+
+ self::assertArrayHasKey('btc', $supportedTransactionCurrenciesArray);
+ self::assertArrayNotHasKey('bch', $supportedTransactionCurrenciesArray);
+ self::assertEquals(['btc' => ['enabled' => true, 'reason' => 'test']], $supportedTransactionCurrenciesArray);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $supportedTransactionCurrencies = $this->createClassObject();
+ $supportedTransactionCurrenciesArray = $supportedTransactionCurrencies->toArray();
+
+ self::assertNotNull($supportedTransactionCurrenciesArray);
+ self::assertIsArray($supportedTransactionCurrenciesArray);
+
+ self::assertArrayNotHasKey('btc', $supportedTransactionCurrenciesArray);
+ }
+
+ private function createClassObject(): SupportedTransactionCurrencies
+ {
+ return new SupportedTransactionCurrencies();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrencyTest.php b/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrencyTest.php
new file mode 100644
index 00000000..70d93953
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/SupportedTransactionCurrencyTest.php
@@ -0,0 +1,71 @@
+createClassObject();
+ self::assertInstanceOf(SupportedTransactionCurrency::class, $supportedTransactionCurrency);
+ }
+
+ public function testGetEnabled()
+ {
+ $supportedTransactionCurrency = $this->createClassObject();
+ $supportedTransactionCurrency->setEnabled(true);
+ self::assertTrue($supportedTransactionCurrency->getEnabled());
+ }
+
+ public function testGetReason()
+ {
+ $expectedReason = "My reason";
+
+ $supportedTransactionCurrency = $this->createClassObject();
+ $supportedTransactionCurrency->setReason($expectedReason);
+ self::assertEquals($expectedReason, $supportedTransactionCurrency->getReason());
+ }
+
+ public function testToArray()
+ {
+ $supportedTransactionCurrency = $this->createClassObject();
+ $this->objectSetters($supportedTransactionCurrency);
+
+ $supportedTransactionCurrencyArray = $supportedTransactionCurrency->toArray();
+
+ self::assertNotNull($supportedTransactionCurrencyArray);
+ self::assertIsArray($supportedTransactionCurrencyArray);
+
+ self::assertArrayHasKey('enabled', $supportedTransactionCurrencyArray);
+ self::assertArrayHasKey('reason', $supportedTransactionCurrencyArray);
+
+ self::assertEquals(true, $supportedTransactionCurrencyArray['enabled']);
+ self::assertEquals("My reason", $supportedTransactionCurrencyArray['reason']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $supportedTransactionCurrency = $this->createClassObject();
+
+ $supportedTransactionCurrencyArray = $supportedTransactionCurrency->toArray();
+
+ self::assertNotNull($supportedTransactionCurrencyArray);
+ self::assertIsArray($supportedTransactionCurrencyArray);
+
+ self::assertArrayNotHasKey('enabled', $supportedTransactionCurrencyArray);
+ }
+
+ private function createClassObject(): SupportedTransactionCurrency
+ {
+ return new SupportedTransactionCurrency();
+ }
+
+ private function objectSetters(SupportedTransactionCurrency $supportedTransactionCurrency): void
+ {
+ $supportedTransactionCurrency->setEnabled(true);
+ $supportedTransactionCurrency->setReason("My reason");
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Invoice/UniversalCodesTest.php b/test/unit/BitPaySDK/Model/Invoice/UniversalCodesTest.php
new file mode 100644
index 00000000..ba3ac7fc
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Invoice/UniversalCodesTest.php
@@ -0,0 +1,60 @@
+createClassObject();
+ self::assertInstanceOf(UniversalCodes::class, $universalCodes);
+ }
+
+ public function testGetPaymentString()
+ {
+ $expectedPaymentString = 'Test payment string';
+
+ $universalCodes = $this->createClassObject();
+ $universalCodes->setPaymentString($expectedPaymentString);
+ self::assertEquals($expectedPaymentString, $universalCodes->getPaymentString());
+ }
+
+ public function testGetVerificationLink()
+ {
+ $expectedVerificationLink = 'http://test.com/';
+
+ $universalCodes = $this->createClassObject();
+ $universalCodes->setVerificationLink($expectedVerificationLink);
+ self::assertEquals($expectedVerificationLink, $universalCodes->getVerificationLink());
+ }
+
+ public function testToArray()
+ {
+ $universalCodes = $this->createClassObject();
+ $this->setSetters($universalCodes);
+ $universalCodesArray = $universalCodes->toArray();
+
+ self::assertNotNull($universalCodesArray);
+ self::assertIsArray($universalCodesArray);
+
+ self::assertArrayHasKey('paymentString', $universalCodesArray);
+ self::assertArrayHasKey('verificationLink', $universalCodesArray);
+
+ self::assertEquals('Test payment string', $universalCodesArray['paymentString']);
+ self::assertEquals('http://test.com/', $universalCodesArray['verificationLink']);
+ }
+
+ private function createClassObject(): UniversalCodes
+ {
+ return new UniversalCodes();
+ }
+
+ private function setSetters(UniversalCodes $universalCodes)
+ {
+ $universalCodes->setPaymentString('Test payment string');
+ $universalCodes->setVerificationLink('http://test.com/');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Ledger/BuyerTest.php b/test/unit/BitPaySDK/Model/Ledger/BuyerTest.php
new file mode 100644
index 00000000..d3711f4f
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Ledger/BuyerTest.php
@@ -0,0 +1,158 @@
+createClassObject();
+ self::assertInstanceOf(Buyer::class, $buyer);
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'Test Name';
+
+ $buyer = $this->createClassObject();
+ $buyer->setName($expectedName);
+ self::assertEquals($expectedName, $buyer->getName());
+ }
+
+ public function testGetAddress1()
+ {
+ $expectedAddress1 = 'Address 1';
+
+ $buyer = $this->createClassObject();
+ $buyer->setAddress1($expectedAddress1);
+ self::assertEquals($expectedAddress1, $buyer->getAddress1());
+ }
+
+ public function testGetAddress2()
+ {
+ $expectedAddress2 = 'Address 2';
+
+ $buyer = $this->createClassObject();
+ $buyer->setAddress2($expectedAddress2);
+ self::assertEquals($expectedAddress2, $buyer->getAddress2());
+ }
+
+ public function testGetCity()
+ {
+ $expectedCity = 'Miami';
+
+ $buyer = $this->createClassObject();
+ $buyer->setCity($expectedCity);
+ self::assertEquals($expectedCity, $buyer->getCity());
+ }
+
+ public function testGetState()
+ {
+ $expectedState = 'AB';
+
+ $buyer = $this->createClassObject();
+ $buyer->setState($expectedState);
+ self::assertEquals($expectedState, $buyer->getState());
+ }
+
+ public function testGetZip()
+ {
+ $expectedZip = '12345';
+
+ $buyer = $this->createClassObject();
+ $buyer->setZip($expectedZip);
+ self::assertEquals($expectedZip, $buyer->getZip());
+ }
+
+ public function testGetCountry()
+ {
+ $expectedCountry = 'Canada';
+
+ $buyer = $this->createClassObject();
+ $buyer->setCountry($expectedCountry);
+ self::assertEquals($expectedCountry, $buyer->getCountry());
+ }
+
+ public function testGetEmail()
+ {
+ $expectedEmail = 'test@email.com';
+
+ $buyer = $this->createClassObject();
+ $buyer->setEmail($expectedEmail);
+ self::assertEquals($expectedEmail, $buyer->getEmail());
+ }
+
+ public function testGetPhone()
+ {
+ $expectedPhone = '123456789';
+
+ $buyer = $this->createClassObject();
+ $buyer->setPhone($expectedPhone);
+ self::assertEquals($expectedPhone, $buyer->getPhone());
+ }
+
+ public function testGetNotify()
+ {
+ $buyer = $this->createClassObject();
+ $buyer->setNotify(true);
+ self::assertTrue($buyer->getNotify());
+
+ $buyer->setNotify(false);
+ self::assertFalse($buyer->getNotify());
+ }
+
+ public function testToArray()
+ {
+ $buyer = $this->createClassObject();
+ $this->setSetters($buyer);
+
+ $buyerArray = $buyer->toArray();
+
+ self::assertNotNull($buyerArray);
+ self::assertIsArray($buyerArray);
+
+ self::assertArrayHasKey('name', $buyerArray);
+ self::assertArrayHasKey('address1', $buyerArray);
+ self::assertArrayHasKey('address2', $buyerArray);
+ self::assertArrayHasKey('city', $buyerArray);
+ self::assertArrayHasKey('state', $buyerArray);
+ self::assertArrayHasKey('zip', $buyerArray);
+ self::assertArrayHasKey('country', $buyerArray);
+ self::assertArrayHasKey('phone', $buyerArray);
+ self::assertArrayHasKey('notify', $buyerArray);
+ self::assertArrayHasKey('email', $buyerArray);
+
+ self::assertEquals('TestName', $buyerArray['name']);
+ self::assertEquals('Address1', $buyerArray['address1']);
+ self::assertEquals('Address2', $buyerArray['address2']);
+ self::assertEquals('Miami', $buyerArray['city']);
+ self::assertEquals('AB', $buyerArray['state']);
+ self::assertEquals('12345', $buyerArray['zip']);
+ self::assertEquals('USA', $buyerArray['country']);
+ self::assertEquals('123456789', $buyerArray['phone']);
+ self::assertTrue($buyerArray['notify']);
+ self::assertEquals('test@email.com', $buyerArray['email']);
+ }
+
+ private function createClassObject(): Buyer
+ {
+ return new Buyer();
+ }
+
+ private function setSetters(Buyer $buyer)
+ {
+ $buyer->setName('TestName');
+ $buyer->setAddress1('Address1');
+ $buyer->setAddress2('Address2');
+ $buyer->setCity('Miami');
+ $buyer->setState('AB');
+ $buyer->setZip('12345');
+ $buyer->setCountry('USA');
+ $buyer->setPhone('123456789');
+ $buyer->setNotify(true);
+ $buyer->setEmail('test@email.com');
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Ledger/LedgerEntryTest.php b/test/unit/BitPaySDK/Model/Ledger/LedgerEntryTest.php
new file mode 100644
index 00000000..4d3768e7
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Ledger/LedgerEntryTest.php
@@ -0,0 +1,215 @@
+createClassObject();
+ self::assertInstanceOf(LedgerEntry::class, $ledgerEntry);
+ }
+
+ public function testGetType()
+ {
+ $expectedType = 'TestType';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setType($expectedType);
+ self::assertEquals($expectedType, $ledgerEntry->getType());
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = '1';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $ledgerEntry->getAmount());
+ }
+
+ public function testGetCode()
+ {
+ $expectedCode = 'abc123';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setCode($expectedCode);
+ self::assertEquals($expectedCode, $ledgerEntry->getCode());
+ }
+
+ public function testGetTimestamp()
+ {
+ $expectedTimestamp = '2020-01-01 18:10:10';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setTimestamp($expectedTimestamp);
+ self::assertEquals($expectedTimestamp, $ledgerEntry->getTimestamp());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $ledgerEntry->getCurrency());
+ }
+
+ public function testGetTxType()
+ {
+ $expectedTxType = 'TxType';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setTxType($expectedTxType);
+ self::assertEquals($expectedTxType, $ledgerEntry->getTxType());
+ }
+
+ public function testGetScale()
+ {
+ $expectedScale = 'TestScale';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setScale($expectedScale);
+ self::assertEquals($expectedScale, $ledgerEntry->getScale());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = '1';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setId($expectedId);
+ self::assertEquals($expectedId, $ledgerEntry->getId());
+ }
+
+ public function testGetSupportRequest()
+ {
+ $expectedSupportRequest = 'Test support request';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setSupportRequest($expectedSupportRequest);
+ self::assertEquals($expectedSupportRequest, $ledgerEntry->getSupportRequest());
+ }
+
+ public function testGetDescription()
+ {
+ $expectedDescription = 'Test description';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setDescription($expectedDescription);
+ self::assertEquals($expectedDescription, $ledgerEntry->getDescription());
+ }
+
+ public function testGetInvoiceId()
+ {
+ $expectedInvoiceId = '1';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setInvoiceId($expectedInvoiceId);
+ self::assertEquals($expectedInvoiceId, $ledgerEntry->getInvoiceId());
+ }
+
+ public function testGetBuyerFields()
+ {
+ $expectedBuyerField = new Buyer();
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setBuyerFields($expectedBuyerField);
+ self::assertEquals($expectedBuyerField, $ledgerEntry->getBuyerFields());
+ }
+
+ public function testGetInvoiceAmount()
+ {
+ $expectedInvoiceAmount = 20.7;
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setInvoiceAmount($expectedInvoiceAmount);
+ self::assertEquals($expectedInvoiceAmount, $ledgerEntry->getInvoiceAmount());
+ }
+
+ public function testGetInvoiceCurrency()
+ {
+ $expectedInvoiceCurrency = 'BTC';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setInvoiceCurrency($expectedInvoiceCurrency);
+ self::assertEquals($expectedInvoiceCurrency, $ledgerEntry->getInvoiceCurrency());
+ }
+
+ public function testGetTransactionCurrency()
+ {
+ $expectedTransactionCurrency = 'BTC';
+
+ $ledgerEntry = $this->createClassObject();
+ $ledgerEntry->setTransactionCurrency($expectedTransactionCurrency);
+ self::assertEquals($expectedTransactionCurrency, $ledgerEntry->getTransactionCurrency());
+ }
+
+ public function testToArray()
+ {
+ $ledgerEntry = $this->createClassObject();
+ $this->setSetters($ledgerEntry);
+ $ledgerEntryArray = $ledgerEntry->toArray();
+
+ self::assertNotNull($ledgerEntryArray);
+ self::assertIsArray($ledgerEntryArray);
+
+ self::assertArrayHasKey('type', $ledgerEntryArray);
+ self::assertArrayHasKey('amount', $ledgerEntryArray);
+ self::assertArrayHasKey('code', $ledgerEntryArray);
+ self::assertArrayHasKey('timestamp', $ledgerEntryArray);
+ self::assertArrayHasKey('currency', $ledgerEntryArray);
+ self::assertArrayHasKey('txType', $ledgerEntryArray);
+ self::assertArrayHasKey('scale', $ledgerEntryArray);
+ self::assertArrayHasKey('id', $ledgerEntryArray);
+ self::assertArrayHasKey('supportRequest', $ledgerEntryArray);
+ self::assertArrayHasKey('description', $ledgerEntryArray);
+ self::assertArrayHasKey('invoiceId', $ledgerEntryArray);
+ self::assertArrayHasKey('invoiceAmount', $ledgerEntryArray);
+ self::assertArrayHasKey('invoiceCurrency', $ledgerEntryArray);
+ self::assertArrayHasKey('transactionCurrency', $ledgerEntryArray);
+
+ self::assertEquals('TestType', $ledgerEntryArray['type']);
+ self::assertEquals('1', $ledgerEntryArray['amount']);
+ self::assertEquals('abc123', $ledgerEntryArray['code']);
+ self::assertEquals('2020-01-01 18:10:10', $ledgerEntryArray['timestamp']);
+ self::assertEquals('BTC', $ledgerEntryArray['currency']);
+ self::assertEquals('TxType', $ledgerEntryArray['txType']);
+ self::assertEquals('Test scale', $ledgerEntryArray['scale']);
+ self::assertEquals('1', $ledgerEntryArray['id']);
+ self::assertEquals('Test support request', $ledgerEntryArray['supportRequest']);
+ self::assertEquals('Test description', $ledgerEntryArray['description']);
+ self::assertEquals('1', $ledgerEntryArray['invoiceId']);
+ self::assertEquals(20.7, $ledgerEntryArray['invoiceAmount']);
+ self::assertEquals('BTC', $ledgerEntryArray['invoiceCurrency']);
+ self::assertEquals('BTC', $ledgerEntryArray['transactionCurrency']);
+ }
+
+ private function createClassObject(): LedgerEntry
+ {
+ return new LedgerEntry();
+ }
+
+ private function setSetters(LedgerEntry $ledgerEntry)
+ {
+ $ledgerEntry->setType('TestType');
+ $ledgerEntry->setAmount('1');
+ $ledgerEntry->setCode('abc123');
+ $ledgerEntry->setTimestamp('2020-01-01 18:10:10');
+ $ledgerEntry->setCurrency('BTC');
+ $ledgerEntry->setTxType('TxType');
+ $ledgerEntry->setScale('Test scale');
+ $ledgerEntry->setId('1');
+ $ledgerEntry->setSupportRequest('Test support request');
+ $ledgerEntry->setDescription('Test description');
+ $ledgerEntry->setInvoiceId('1');
+ $ledgerEntry->setBuyerFields(new Buyer());
+ $ledgerEntry->setInvoiceAmount(20.7);
+ $ledgerEntry->setInvoiceCurrency('BTC');
+ $ledgerEntry->setTransactionCurrency('BTC');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Ledger/LedgerTest.php b/test/unit/BitPaySDK/Model/Ledger/LedgerTest.php
new file mode 100644
index 00000000..3898f84f
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Ledger/LedgerTest.php
@@ -0,0 +1,57 @@
+createClassObject();
+ self::assertInstanceOf(Ledger::class, $ledger);
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $ledger = $this->createClassObject();
+ $ledger->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $ledger->getCurrency());
+ }
+
+ public function testGetBalance()
+ {
+ $expectedBalance = 1.1;
+
+ $ledger = $this->createClassObject();
+ $ledger->setBalance($expectedBalance);
+ self::assertEquals($expectedBalance, $ledger->getBalance());
+ }
+
+ public function testToArray()
+ {
+ $ledger = $this->createClassObject();
+
+ $ledger->setCurrency('BTC');
+ $ledger->setBalance(1.1);
+
+ $ledgerArray = $ledger->toArray();
+
+ self::assertNotNull($ledgerArray);
+ self::assertIsArray($ledgerArray);
+
+ self::assertArrayHasKey('currency', $ledgerArray);
+ self::assertArrayHasKey('balance', $ledgerArray);
+
+ self::assertEquals('BTC', $ledgerArray['currency']);
+ self::assertEquals(1.1, $ledgerArray['balance']);
+ }
+
+ private function createClassObject(): Ledger
+ {
+ return new Ledger();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Payout/PayoutRecipientTest.php b/test/unit/BitPaySDK/Model/Payout/PayoutRecipientTest.php
new file mode 100644
index 00000000..f69b6678
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Payout/PayoutRecipientTest.php
@@ -0,0 +1,130 @@
+createClassObject();
+ self::assertInstanceOf(PayoutRecipient::class, $payoutRecipient);
+ }
+
+ public function testGetEmail()
+ {
+ $expectedEmail = 'john@doe.com';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setEmail($expectedEmail);
+
+ self::assertEquals($expectedEmail, $payoutRecipient->getEmail());
+ }
+
+ public function testGetLabel()
+ {
+ $expectedLabel = 'My Label';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setLabel($expectedLabel);
+
+ self::assertEquals($expectedLabel, $payoutRecipient->getLabel());
+ }
+
+ public function testGetNotificationURL()
+ {
+ $expectedNotificationURL = 'https://www.example.com/';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setNotificationURL($expectedNotificationURL);
+
+ self::assertEquals($expectedNotificationURL, $payoutRecipient->getNotificationURL());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'success';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setStatus($expectedStatus);
+
+ self::assertEquals($expectedStatus, $payoutRecipient->getStatus());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = 'abcd123';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setId($expectedId);
+
+ self::assertEquals($expectedId, $payoutRecipient->getId());
+ }
+
+ public function testGetShopperId()
+ {
+ $expectedShopperId = 'efgh456';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setShopperId($expectedShopperId);
+
+ self::assertEquals($expectedShopperId, $payoutRecipient->getShopperId());
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = '6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL';
+
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setToken($expectedToken);
+
+ self::assertEquals($expectedToken, $payoutRecipient->getToken());
+ }
+
+ public function testToArray()
+ {
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipient->setEmail('john@doe.com');
+ $payoutRecipient->setLabel('My Label');
+ $payoutRecipient->setNotificationURL('https://www.example.com/');
+ $payoutRecipient->setStatus('success');
+ $payoutRecipient->setId('abcd123');
+ $payoutRecipient->setShopperId('efgh456');
+ $payoutRecipient->setToken('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL');
+ $payoutRecipientArray = $payoutRecipient->toArray();
+
+ self::assertNotNull($payoutRecipientArray);
+ self::assertIsArray($payoutRecipientArray);
+
+ self::assertArrayHasKey('email', $payoutRecipientArray);
+ self::assertArrayHasKey('label', $payoutRecipientArray);
+ self::assertArrayHasKey('notificationURL', $payoutRecipientArray);
+ self::assertArrayHasKey('status', $payoutRecipientArray);
+ self::assertArrayHasKey('id', $payoutRecipientArray);
+ self::assertArrayHasKey('shopperId', $payoutRecipientArray);
+ self::assertArrayHasKey('token', $payoutRecipientArray);
+
+ self::assertEquals('john@doe.com', $payoutRecipientArray['email']);
+ self::assertEquals('My Label', $payoutRecipientArray['label']);
+ self::assertEquals('https://www.example.com/', $payoutRecipientArray['notificationURL']);
+ self::assertEquals('success', $payoutRecipientArray['status']);
+ self::assertEquals('abcd123', $payoutRecipientArray['id']);
+ self::assertEquals('efgh456', $payoutRecipientArray['shopperId']);
+ self::assertEquals('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL', $payoutRecipientArray['token']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $payoutRecipient = $this->createClassObject();
+ $payoutRecipientArray = $payoutRecipient->toArray();
+
+ self::assertArrayNotHasKey('email', $payoutRecipientArray);
+ }
+
+ private function createClassObject(): PayoutRecipient
+ {
+ return new PayoutRecipient();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Payout/PayoutRecipientsTest.php b/test/unit/BitPaySDK/Model/Payout/PayoutRecipientsTest.php
new file mode 100644
index 00000000..d245f68e
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Payout/PayoutRecipientsTest.php
@@ -0,0 +1,119 @@
+createClassObject();
+ self::assertInstanceOf(PayoutRecipients::class, $payoutRecipients);
+ }
+
+ public function testGetGuid()
+ {
+ $expectedGuid = 'cd47864e-374b-4a92-8592-4357fcbc6a89';
+
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipients->setGuid($expectedGuid);
+ self::assertEquals($expectedGuid, $payoutRecipients->getGuid());
+ }
+
+ public function testGetRecipientsObject()
+ {
+ $expectedPayoutRecipients = [];
+ $payoutRecipient = new PayoutRecipient();
+ $payoutRecipient->setEmail('john@doe.com');
+ $payoutRecipient->setLabel('My Label');
+ $payoutRecipient->setNotificationURL('https://www.example.com/');
+ $payoutRecipient->setStatus('success');
+ $payoutRecipient->setId('abcd123');
+ $payoutRecipient->setShopperId('efgh456');
+ $payoutRecipient->setToken('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL');
+ $expectedPayoutRecipients[] = $payoutRecipient;
+
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipients->setRecipients($expectedPayoutRecipients);
+ self::assertEquals($expectedPayoutRecipients[0]->toArray(), $payoutRecipients->getRecipients()[0]->toArray());
+ }
+
+ /**
+ * @throws \BitPaySDK\Exceptions\PayoutRecipientException
+ */
+ public function testGetRecipientsArray()
+ {
+ $payoutRecipient = new PayoutRecipient();
+ $payoutRecipient->setNotificationURL('https://www.example.com/');
+ $payoutRecipient->setEmail('john@doe.com');
+ $payoutRecipient->setLabel('My Label');
+ $payoutRecipient->setStatus('success');
+ $payoutRecipient->setId('abcd123');
+ $payoutRecipient->setShopperId('efgh456');
+
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipients->setRecipients([$payoutRecipient]);
+ self::assertEquals([$payoutRecipient], $payoutRecipients->getRecipients());
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = '6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL';
+
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipients->setToken($expectedToken);
+ self::assertEquals($expectedToken, $payoutRecipients->getToken());
+ }
+
+ public function testToArray()
+ {
+ $expectedPayoutRecipients = [];
+ $payoutRecipient = new PayoutRecipient();
+ $payoutRecipient->setEmail('john@doe.com');
+ $payoutRecipient->setLabel('My Label');
+ $payoutRecipient->setNotificationURL('https://www.example.com/');
+ $payoutRecipient->setStatus('success');
+ $payoutRecipient->setId('abcd123');
+ $payoutRecipient->setShopperId('efgh456');
+ $payoutRecipient->setToken('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL');
+ $expectedPayoutRecipients[] = $payoutRecipient;
+
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipients->setGuid('cd47864e-374b-4a92-8592-4357fcbc6a89');
+ $payoutRecipients->setRecipients($expectedPayoutRecipients);
+ $payoutRecipients->setToken('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL');
+ $payoutRecipientsArray = $payoutRecipients->toArray();
+
+ self::assertNotNull($payoutRecipientsArray);
+ self::assertIsArray($payoutRecipientsArray);
+
+ self::assertArrayHasKey('guid', $payoutRecipientsArray);
+ self::assertArrayHasKey('recipients', $payoutRecipientsArray);
+ self::assertArrayHasKey('token', $payoutRecipientsArray);
+
+ self::assertEquals('cd47864e-374b-4a92-8592-4357fcbc6a89', $payoutRecipientsArray['guid']);
+ self::assertEquals('john@doe.com', $payoutRecipientsArray['recipients'][0]['email']);
+ self::assertEquals('My Label', $payoutRecipientsArray['recipients'][0]['label']);
+ self::assertEquals('https://www.example.com/', $payoutRecipientsArray['recipients'][0]['notificationURL']);
+ self::assertEquals('success', $payoutRecipientsArray['recipients'][0]['status']);
+ self::assertEquals('abcd123', $payoutRecipientsArray['recipients'][0]['id']);
+ self::assertEquals('efgh456', $payoutRecipientsArray['recipients'][0]['shopperId']);
+ self::assertEquals('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL', $payoutRecipientsArray['recipients'][0]['token']);
+ self::assertEquals('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL', $payoutRecipientsArray['token']);
+ }
+
+ public function testToArrayEmptyKey()
+ {
+ $payoutRecipients = $this->createClassObject();
+ $payoutRecipientsArray = $payoutRecipients->toArray();
+ self::assertArrayNotHasKey('guid', $payoutRecipientsArray);
+ }
+
+ private function createClassObject(): PayoutRecipients
+ {
+ return new PayoutRecipients();
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Payout/PayoutTest.php b/test/unit/BitPaySDK/Model/Payout/PayoutTest.php
new file mode 100644
index 00000000..156ce4ae
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Payout/PayoutTest.php
@@ -0,0 +1,357 @@
+createClassObject();
+ self::assertInstanceOf(Payout::class, $payout);
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = '6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL';
+
+ $payout = $this->createClassObject();
+ $payout->setToken($expectedToken);
+ self::assertEquals($expectedToken, $payout->getToken());
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 10.0;
+
+ $payout = $this->createClassObject();
+ $payout->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $payout->getAmount());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetCurrency()
+ {
+ $expectedCurrency = Currency::USD;
+
+ $payout = $this->createClassObject();
+ $payout->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $payout->getCurrency());
+ }
+
+ public function testGetCurrencyException()
+ {
+ $expectedCurrency = 'ZZZ';
+
+ $payout = $this->createClassObject();
+ $this->expectException(BitPayException::class);
+ $this->expectExceptionMessage('currency code must be a type of Model.Currency');
+ $payout->setCurrency($expectedCurrency);
+ }
+
+ public function testGetEffectiveDate()
+ {
+ $expectedEffectiveDate = '2021-05-27T09:00:00.000Z';
+
+ $payout = $this->createClassObject();
+ $payout->setEffectiveDate($expectedEffectiveDate);
+ self::assertEquals($expectedEffectiveDate, $payout->getEffectiveDate());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetLedgerCurrency()
+ {
+ $expectedLedgerCurrency = 'GBP';
+
+ $payout = $this->createClassObject();
+ $payout->setLedgerCurrency($expectedLedgerCurrency);
+ self::assertEquals($expectedLedgerCurrency, $payout->getLedgerCurrency());
+ }
+
+ public function testGetLedgerCurrencyException()
+ {
+ $expectedLedgerCurrency = 'ZZZ';
+
+ $payout = $this->createClassObject();
+ $this->expectException(BitPayException::class);
+ $this->expectExceptionMessage('currency code must be a type of Model.Currency');
+ $payout->setLedgerCurrency($expectedLedgerCurrency);
+ }
+
+ public function testGetReference()
+ {
+ $expectedReference = 'payout_20210527';
+
+ $payout = $this->createClassObject();
+ $payout->setReference($expectedReference);
+ self::assertEquals($expectedReference, $payout->getReference());
+ }
+
+ public function testGetNotificationUrl()
+ {
+ $expectedNotificationUrl = 'https://example.com/';
+
+ $bill = $this->createClassObject();
+ $bill->setNotificationUrl($expectedNotificationUrl);
+ self::assertEquals($expectedNotificationUrl, $bill->getNotificationUrl());
+ }
+
+ public function testGetNotificationEmail()
+ {
+ $expectedNotificationEmail = 'test@test.com';
+
+ $payout = $this->createClassObject();
+ $payout->setNotificationEmail($expectedNotificationEmail);
+ self::assertEquals($expectedNotificationEmail, $payout->getNotificationEmail());
+ }
+
+ public function testGetEmail()
+ {
+ $expectedEmail = 'test@test.com';
+
+ $payout = $this->createClassObject();
+ $payout->setEmail($expectedEmail);
+ self::assertEquals($expectedEmail, $payout->getEmail());
+ }
+
+ public function testGetRecipientId()
+ {
+ $expectedRecipientId = 'LDxRZCGq174SF8AnQpdBPB';
+
+ $payout = $this->createClassObject();
+ $payout->setRecipientId($expectedRecipientId);
+ self::assertEquals($expectedRecipientId, $payout->getRecipientId());
+ }
+
+ public function testGetShopperId()
+ {
+ $expectedShopperId = '7qohDf2zZnQK5Qanj8oyC2';
+
+ $payout = $this->createClassObject();
+ $payout->setShopperId($expectedShopperId);
+ self::assertEquals($expectedShopperId, $payout->getShopperId());
+ }
+
+ public function testGetLabel()
+ {
+ $expectedLabel = 'My label';
+
+ $payout = $this->createClassObject();
+ $payout->setLabel($expectedLabel);
+ self::assertEquals($expectedLabel, $payout->getLabel());
+ }
+
+ public function testGetMessage()
+ {
+ $expectedMessage = 'My message';
+
+ $payout = $this->createClassObject();
+ $payout->setMessage($expectedMessage);
+ self::assertEquals($expectedMessage, $payout->getMessage());
+ }
+
+ public function testGetId()
+ {
+ $expectedId = 'abcd123';
+
+ $payout = $this->createClassObject();
+ $payout->setId($expectedId);
+ self::assertEquals($expectedId, $payout->getId());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'success';
+
+ $payout = $this->createClassObject();
+ $payout->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $payout->getStatus());
+ }
+
+ public function testGetRequestDate()
+ {
+ $expectedRequestDate = '2021-05-27T10:47:37.834Z';
+
+ $payout = $this->createClassObject();
+ $payout->setRequestDate($expectedRequestDate);
+ self::assertEquals($expectedRequestDate, $payout->getRequestDate());
+ }
+
+ public function testGetExchangeRates()
+ {
+ $expectedExchangeRates = [
+ 'BTC' => [
+ 'USD' => 39390.47,
+ 'GBP' => 27883.962246420004
+ ]
+ ];
+
+ $payout = $this->createClassObject();
+ $payout->setExchangeRates($expectedExchangeRates);
+ self::assertEquals($expectedExchangeRates, $payout->getExchangeRates());
+ }
+
+ public function testGetTransactions()
+ {
+ $expectedTransaction = new PayoutTransaction();
+ $expectedTransaction->setTxid('db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057');
+ $expectedTransaction->setAmount(0.000254);
+ $expectedTransaction->setDate('2021-05-27T11:04:23.155Z');
+
+ $expectedItemizedDetails = $this->getMockBuilder(PayoutTransaction::class)
+ ->disableOriginalConstructor()
+ ->getMock();
+ $expectedItemizedDetails->method('toArray')->willReturn([$expectedTransaction]);
+
+ $payout = $this->createClassObject();
+ $payout->setTransactions([$expectedTransaction]);
+ self::assertIsArray($payout->getTransactions());
+ self::assertNotNull($payout->getTransactions());
+ self::assertInstanceOf(PayoutTransaction::class, $payout->getTransactions()[0]);
+ }
+
+ public function testFormatAmount()
+ {
+ $amount = 12.3456789;
+ $expectedFormattedAmount = 12.35;
+
+ $payout = $this->createClassObject();
+ $payout->setAmount($amount);
+ $payout->formatAmount(2);
+ self::assertEquals($expectedFormattedAmount, $payout->getAmount());
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testToArray()
+ {
+ $payout = $this->createClassObject();
+ $this->objectSetters($payout);
+ $payoutArray = $payout->toArray();
+
+ $payoutTransaction = new PayoutTransaction();
+ $payoutTransaction->setTxid('db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057');
+ $payoutTransaction->setAmount(0.000254);
+ $payoutTransaction->setDate('2021-05-27T11:04:23.155Z');
+
+ self::assertNotNull($payoutArray);
+ self::assertIsArray($payoutArray);
+
+ self::assertArrayHasKey('token', $payoutArray);
+ self::assertArrayHasKey('amount', $payoutArray);
+ self::assertArrayHasKey('currency', $payoutArray);
+ self::assertArrayHasKey('effectiveDate', $payoutArray);
+ self::assertArrayHasKey('ledgerCurrency', $payoutArray);
+ self::assertArrayHasKey('reference', $payoutArray);
+ self::assertArrayHasKey('notificationURL', $payoutArray);
+ self::assertArrayHasKey('notificationEmail', $payoutArray);
+ self::assertArrayHasKey('email', $payoutArray);
+ self::assertArrayHasKey('recipientId', $payoutArray);
+ self::assertArrayHasKey('shopperId', $payoutArray);
+ self::assertArrayHasKey('label', $payoutArray);
+ self::assertArrayHasKey('message', $payoutArray);
+ self::assertArrayHasKey('id', $payoutArray);
+ self::assertArrayHasKey('status', $payoutArray);
+ self::assertArrayHasKey('requestDate', $payoutArray);
+ self::assertArrayHasKey('exchangeRates', $payoutArray);
+ self::assertArrayHasKey('transactions', $payoutArray);
+
+ self::assertEquals(
+ '6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL',
+ $payoutArray['token']
+ );
+ self::assertEquals(10.0, $payoutArray['amount']);
+ self::assertEquals(Currency::USD, $payoutArray['currency']);
+ self::assertEquals('2021-05-27T09:00:00.000Z', $payoutArray['effectiveDate']);
+ self::assertEquals(Currency::GBP, $payoutArray['ledgerCurrency']);
+ self::assertEquals('payout_20210527', $payoutArray['reference']);
+ self::assertEquals('https://example.com/', $payoutArray['notificationURL']);
+ self::assertEquals('test@test.com', $payoutArray['notificationEmail']);
+ self::assertEquals('test@test.com', $payoutArray['email']);
+ self::assertEquals('LDxRZCGq174SF8AnQpdBPB', $payoutArray['recipientId']);
+ self::assertEquals('7qohDf2zZnQK5Qanj8oyC2', $payoutArray['shopperId']);
+ self::assertEquals('My label', $payoutArray['label']);
+ self::assertEquals('My message', $payoutArray['message']);
+ self::assertEquals('JMwv8wQCXANoU2ZZQ9a9GH', $payoutArray['id']);
+ self::assertEquals('success', $payoutArray['status']);
+ self::assertEquals('2021-05-27T10:47:37.834Z', $payoutArray['requestDate']);
+ self::assertEquals([
+ 'BTC' => [
+ 'USD' => 39390.47,
+ 'GBP' => 27883.962246420004
+ ]
+ ], $payoutArray['exchangeRates']);
+ self::assertInstanceOf(PayoutTransaction::class, $payoutArray['transactions'][0]);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testToArrayEmptyKey()
+ {
+ $payout = $this->createClassObject();
+ $this->objectSetters($payout);
+ $payoutArray = $payout->toArray();
+
+ self::assertNotNull($payoutArray);
+ self::assertIsArray($payoutArray);
+
+ self::assertArrayNotHasKey('supportPhone', $payoutArray);
+ }
+
+ private function createClassObject(): Payout
+ {
+ return new Payout();
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ private function objectSetters(Payout $payout)
+ {
+ $payoutTransaction = new PayoutTransaction();
+ $payoutTransaction->setTxid('db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057');
+ $payoutTransaction->setAmount(0.000254);
+ $payoutTransaction->setDate('2021-05-27T11:04:23.155Z');
+
+ $transactions = [];
+ $transactions[] = $payoutTransaction;
+
+ $payout->setToken('6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL');
+ $payout->setAmount(10.0);
+ $payout->setCurrency(Currency::USD);
+ $payout->setEffectiveDate('2021-05-27T09:00:00.000Z');
+ try {
+ $payout->setLedgerCurrency(Currency::GBP);
+ } catch (BitPayException) {
+ }
+ $payout->setReference('payout_20210527');
+ $payout->setNotificationURL('https://example.com/');
+ $payout->setNotificationEmail('test@test.com');
+ $payout->setEmail('test@test.com');
+ $payout->setRecipientId('LDxRZCGq174SF8AnQpdBPB');
+ $payout->setShopperId('7qohDf2zZnQK5Qanj8oyC2');
+ $payout->setLabel('My label');
+ $payout->setMessage('My message');
+ $payout->setId('JMwv8wQCXANoU2ZZQ9a9GH');
+ $payout->setStatus('success');
+ $payout->setRequestDate('2021-05-27T10:47:37.834Z');
+ $payout->setExchangeRates([
+ 'BTC' => [
+ 'USD' => 39390.47,
+ 'GBP' => 27883.962246420004
+ ]
+ ]);
+ $payout->setTransactions($transactions);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Rate/RateTest.php b/test/unit/BitPaySDK/Model/Rate/RateTest.php
new file mode 100644
index 00000000..29d2e766
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Rate/RateTest.php
@@ -0,0 +1,72 @@
+createClassObject();
+ self::assertInstanceOf(Rate::class, $rate);
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'Bitcoin';
+
+ $rate = $this->createClassObject();
+ $rate->setName($expectedName);
+ self::assertEquals($expectedName, $rate->getName());
+ }
+
+ public function testGetCode()
+ {
+ $expectedCode = 'BTC';
+
+ $rate = $this->createClassObject();
+ $rate->setCode($expectedCode);
+ self::assertEquals($expectedCode, $rate->getCode());
+ }
+
+ public function testGetRate()
+ {
+ $expectedRate = 1.0;
+
+ $rate = $this->createClassObject();
+ $rate->setRate($expectedRate);
+ self::assertEquals($expectedRate, $rate->getRate());
+ }
+
+ public function testToArray()
+ {
+ $rate = $this->createClassObject();
+ $this->setSetters($rate);
+ $rateArray = $rate->toArray();
+
+ self::assertNotNull($rateArray);
+ self::assertIsArray($rateArray);
+
+ self::assertArrayHasKey('name', $rateArray);
+ self::assertArrayHasKey('code', $rateArray);
+ self::assertArrayHasKey('rate', $rateArray);
+
+ self::assertEquals('Bitcoin', $rateArray['name']);
+ self::assertEquals('BTC', $rateArray['code']);
+ self::assertEquals(1.0, $rateArray['rate']);
+ }
+
+ private function createClassObject(): Rate
+ {
+ return new Rate();
+ }
+
+ private function setSetters(Rate $rate)
+ {
+ $rate->setName('Bitcoin');
+ $rate->setCode('BTC');
+ $rate->setRate(1.0);
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Rate/RatesTest.php b/test/unit/BitPaySDK/Model/Rate/RatesTest.php
new file mode 100644
index 00000000..9a86c980
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Rate/RatesTest.php
@@ -0,0 +1,112 @@
+createClassObject();
+ self::assertInstanceOf(Rates::class, $rates);
+ }
+
+ public function testGetRates()
+ {
+ $rates = $this->createClassObject();
+
+ $ratesArray = $rates->getRates();
+ self::assertIsArray($ratesArray);
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testUpdate(): void
+ {
+ $bch = new Rate();
+ $bch->setName('Bitcoin Cash');
+ $bch->setCode('BCH');
+ $bch->setRate(229.19);
+
+ $expectedRatesArray = [$bch];
+ $expectedRates = new Rates($expectedRatesArray);
+ $bp = $this->getMockBuilder(Client::class)->disableOriginalConstructor()->getMock();
+ $bp->method('getRates')->willReturn($expectedRates);
+
+ $rates = new Rates([]);
+ self::assertEquals([], $rates->getRates());
+
+ $rates->update($bp);
+
+ self::assertEquals($expectedRatesArray, $rates->getRates());
+ }
+
+ public function testUpdateShouldThrowsExceptionsForInvalidRateFormat(): void
+ {
+ $rates = $this->createClassObject();
+ $this->expectException(BitPayException::class);
+
+ $clientApiResponse = [
+ [
+ 'name' => 'Bitcoin Cash',
+ 'code' => 'BCH',
+ 'rate' => 229.19
+ ]
+ ];
+ $expectedRates = new Rates($clientApiResponse);
+ $bp = $this->getMockBuilder(Client::class)->disableOriginalConstructor()->getMock();
+ $bp->method('getRates')->willReturn($expectedRates);
+
+ $rates->update($bp);
+ }
+
+ public function testGetRateException()
+ {
+ $rates = $this->createClassObject();
+ $this->expectException(BitPayException::class);
+ $this->expectExceptionMessage('currency code must be a type of Model.Currency');
+ $rates->getRate('ELO');
+ }
+
+ /**
+ * @throws BitPayException
+ */
+ public function testGetRate()
+ {
+ $expectedValue = 12;
+
+ $rateMock = $this->getMockBuilder(Rate::class)->disableOriginalConstructor()->getMock();
+ $rateMock->method('getCode')->willReturn('BTC');
+ $rateMock->method('getRate')->willReturn(12.0);
+
+ $rates = [$rateMock];
+ $rates = new Rates($rates);
+
+ self::assertEquals($expectedValue, $rates->getRate('BTC'));
+ }
+
+ public function testToArray()
+ {
+ $rates = $this->createClassObject();
+ $ratesEmpty = new Rates([]);
+ $ratesArray = $rates->toArray();
+
+ $ratesEmptyArray = $ratesEmpty->toArray();
+
+ self::assertIsArray($ratesArray);
+ self::assertArrayNotHasKey('rates', $ratesEmptyArray);
+ }
+
+ private function createClassObject(): Rates
+ {
+ $rates = [new Rate()];
+
+ return new Rates($rates);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Settlement/InvoiceDataTest.php b/test/unit/BitPaySDK/Model/Settlement/InvoiceDataTest.php
new file mode 100644
index 00000000..0550c914
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/InvoiceDataTest.php
@@ -0,0 +1,130 @@
+createClassObject();
+ self::assertInstanceOf(InvoiceData::class, $invoiceData);
+ }
+
+ public function testGetOrderId()
+ {
+ $expectedOrderId = '1';
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setOrderId($expectedOrderId);
+ self::assertEquals($expectedOrderId, $invoiceData->getOrderId());
+ }
+
+ public function testGetDate()
+ {
+ $expectedDate = '2022-01-01';
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setDate($expectedDate);
+ self::assertEquals($expectedDate, $invoiceData->getDate());
+ }
+
+ public function testGetPrice()
+ {
+ $expectedPrice = 12.9;
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setPrice($expectedPrice);
+ self::assertEquals($expectedPrice, $invoiceData->getPrice());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $invoiceData->getCurrency());
+ }
+
+ public function testGetTransactionCurrency()
+ {
+ $expectedTransactionCurrency = 'BTC';
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setTransactionCurrency($expectedTransactionCurrency);
+ self::assertEquals($expectedTransactionCurrency, $invoiceData->getTransactionCurrency());
+ }
+
+ public function testGetOverPaidAmount()
+ {
+ $expectedOverPaidAmount = 11.1;
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setOverPaidAmount($expectedOverPaidAmount);
+ self::assertEquals($expectedOverPaidAmount, $invoiceData->getOverPaidAmount());
+ }
+
+ public function testGetPayoutPercentage()
+ {
+ $expectedPayoutPercentage = 15;
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setPayoutPercentage($expectedPayoutPercentage);
+ self::assertEquals($expectedPayoutPercentage, $invoiceData->getPayoutPercentage());
+ }
+
+ public function testGetRefundInfo()
+ {
+ $expectedRefundInfo = $this->getMockBuilder(RefundInfo::class)->getMock();
+
+ $invoiceData = $this->createClassObject();
+ $invoiceData->setRefundInfo($expectedRefundInfo);
+ self::assertEquals($expectedRefundInfo, $invoiceData->getRefundInfo());
+ }
+
+ public function testToArray()
+ {
+ $invoiceData = $this->createClassObject();
+ $this->setSetters($invoiceData);
+ $invoiceDataArray = $invoiceData->toArray();
+
+ self::assertNotNull($invoiceDataArray);
+ self::assertIsArray($invoiceDataArray);
+
+ self::assertArrayHasKey('orderId', $invoiceDataArray);
+ self::assertArrayHasKey('date', $invoiceDataArray);
+ self::assertArrayHasKey('price', $invoiceDataArray);
+ self::assertArrayHasKey('currency', $invoiceDataArray);
+ self::assertArrayHasKey('transactionCurrency', $invoiceDataArray);
+ self::assertArrayHasKey('payoutPercentage', $invoiceDataArray);
+ self::assertArrayHasKey('refundInfo', $invoiceDataArray);
+
+ self::assertEquals('1', $invoiceDataArray['orderId']);
+ self::assertEquals('2022-01-01', $invoiceDataArray['date']);
+ self::assertEquals(12.9, $invoiceDataArray['price']);
+ self::assertEquals('BTC', $invoiceDataArray['currency']);
+ self::assertEquals('BTC', $invoiceDataArray['transactionCurrency']);
+ self::assertEquals(15, $invoiceDataArray['payoutPercentage']);
+ self::assertEquals([], $invoiceDataArray['refundInfo']);
+ }
+
+ private function createClassObject(): InvoiceData
+ {
+ return new InvoiceData();
+ }
+
+ private function setSetters(InvoiceData $invoiceData)
+ {
+ $invoiceData->setOrderId('1');
+ $invoiceData->setDate('2022-01-01');
+ $invoiceData->setPrice(12.9);
+ $invoiceData->setCurrency('BTC');
+ $invoiceData->setTransactionCurrency('BTC');
+ $invoiceData->setPayoutPercentage(15);
+ $invoiceData->setRefundInfo($this->getMockBuilder(RefundInfo::class)->getMock());
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Settlement/PayoutInfoTest.php b/test/unit/BitPaySDK/Model/Settlement/PayoutInfoTest.php
new file mode 100644
index 00000000..96fc758c
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/PayoutInfoTest.php
@@ -0,0 +1,312 @@
+createClassObject();
+ self::assertInstanceOf(PayoutInfo::class, $payoutInfo);
+ }
+
+ public function testGetAccount()
+ {
+ $expectedAccount = 'Test account';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccount($expectedAccount);
+ self::assertEquals($expectedAccount, $payoutInfo->getAccount());
+ }
+
+ public function testGetRouting()
+ {
+ $expectedRouting = 'Test routing';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setRouting($expectedRouting);
+ self::assertEquals($expectedRouting, $payoutInfo->getRouting());
+ }
+
+ public function testGetMerchantEin()
+ {
+ $expectedMerchantEin = 'Test MerchantEin';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setMerchantEin($expectedMerchantEin);
+ self::assertEquals($expectedMerchantEin, $payoutInfo->getMerchantEin());
+ }
+
+ public function testGetLabel()
+ {
+ $expectedLabel = 'Test label';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setLabel($expectedLabel);
+ self::assertEquals($expectedLabel, $payoutInfo->getLabel());
+ }
+
+ public function testGetBankCountry()
+ {
+ $expectedBankCountry = 'USA';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setBankCountry($expectedBankCountry);
+ self::assertEquals($expectedBankCountry, $payoutInfo->getBankCountry());
+ }
+
+ public function testGetName()
+ {
+ $expectedName = 'Test Name';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setName($expectedName);
+ self::assertEquals($expectedName, $payoutInfo->getName());
+ }
+
+ public function testGetBank()
+ {
+ $expectedBank = 'Test bank';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setBank($expectedBank);
+ self::assertEquals($expectedBank, $payoutInfo->getBank());
+ }
+
+ public function testGetSwift()
+ {
+ $expectedSwift = 'Test swift';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setSwift($expectedSwift);
+ self::assertEquals($expectedSwift, $payoutInfo->getSwift());
+ }
+
+ public function testGetAddress()
+ {
+ $expectedAddress = 'Test address';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAddress($expectedAddress);
+ self::assertEquals($expectedAddress, $payoutInfo->getAddress());
+ }
+
+ public function testGetCity()
+ {
+ $expectedCity = 'Miami';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setCity($expectedCity);
+ self::assertEquals($expectedCity, $payoutInfo->getCity());
+ }
+
+ public function testGetPostal()
+ {
+ $expectedPostal = 'Test postal';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setPostal($expectedPostal);
+ self::assertEquals($expectedPostal, $payoutInfo->getPostal());
+ }
+
+ public function testGetSort()
+ {
+ $expectedSort = 'Test sort';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setSort($expectedSort);
+ self::assertEquals($expectedSort, $payoutInfo->getSort());
+ }
+
+ public function testGetWire()
+ {
+ $expectedWire = 'Test wire';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setWire($expectedWire);
+ self::assertEquals($expectedWire, $payoutInfo->getWire());
+ }
+
+ public function testGetBankName()
+ {
+ $expectedBankName = 'Test bank name';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setBankName($expectedBankName);
+ self::assertEquals($expectedBankName, $payoutInfo->getBankName());
+ }
+
+ public function testGetBankAddress()
+ {
+ $expectedBankAddress = 'Test bank address';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setBankAddress($expectedBankAddress);
+ self::assertEquals($expectedBankAddress, $payoutInfo->getBankAddress());
+ }
+
+ public function testGetBankAddress2()
+ {
+ $expectedBankAddress2 = 'Test bank address';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setBankAddress2($expectedBankAddress2);
+ self::assertEquals($expectedBankAddress2, $payoutInfo->getBankAddress2());
+ }
+
+ public function testGetIban()
+ {
+ $expectedIban = 'KW81CBKU00000000000012345601013';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setIban($expectedIban);
+ self::assertEquals($expectedIban, $payoutInfo->getIban());
+ }
+
+ public function testGetAdditionalInformation()
+ {
+ $expectedAdditionalInformation = 'Test additional information';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAdditionalInformation($expectedAdditionalInformation);
+ self::assertEquals($expectedAdditionalInformation, $payoutInfo->getAdditionalInformation());
+ }
+
+ public function testGetAccountHolderName()
+ {
+ $expectedAccountHolderName = 'Test account holder name';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderName($expectedAccountHolderName);
+ self::assertEquals($expectedAccountHolderName, $payoutInfo->getAccountHolderName());
+ }
+
+ public function testGetAccountHolderAddress()
+ {
+ $expectedAccountHolderAddress = 'Test account holder address';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderAddress($expectedAccountHolderAddress);
+ self::assertEquals($expectedAccountHolderAddress, $payoutInfo->getAccountHolderAddress());
+ }
+
+ public function testGetAccountHolderAddress2()
+ {
+ $expectedAccountHolderAddress2 = 'Test account holder address2';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderAddress2($expectedAccountHolderAddress2);
+ self::assertEquals($expectedAccountHolderAddress2, $payoutInfo->getAccountHolderAddress2());
+ }
+
+ public function testGetAccountHolderPostalCode()
+ {
+ $expectedAccountHolderPostalCode = '12345';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderPostalCode($expectedAccountHolderPostalCode);
+ self::assertEquals($expectedAccountHolderPostalCode, $payoutInfo->getAccountHolderPostalCode());
+ }
+
+ public function testGetAccountHolderCity()
+ {
+ $expectedAccountHolderCity = 'Miami';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderCity($expectedAccountHolderCity);
+ self::assertEquals($expectedAccountHolderCity, $payoutInfo->getAccountHolderCity());
+ }
+
+ public function testGetAccountHolderCountry()
+ {
+ $expectedAccountHolderCountry = 'USA';
+
+ $payoutInfo = $this->createClassObject();
+ $payoutInfo->setAccountHolderCountry($expectedAccountHolderCountry);
+ self::assertEquals($expectedAccountHolderCountry, $payoutInfo->getAccountHolderCountry());
+ }
+
+ public function testToArray()
+ {
+ $payoutInfo = $this->createClassObject();
+ $this->setSetters($payoutInfo);
+ $payoutInfoArray = $payoutInfo->toArray();
+
+ self::assertNotNull($payoutInfoArray);
+ self::assertIsArray($payoutInfoArray);
+
+ self::assertArrayHasKey('label', $payoutInfoArray);
+ self::assertArrayHasKey('bankCountry', $payoutInfoArray);
+ self::assertArrayHasKey('name', $payoutInfoArray);
+ self::assertArrayHasKey('bank', $payoutInfoArray);
+ self::assertArrayHasKey('swift', $payoutInfoArray);
+ self::assertArrayHasKey('address', $payoutInfoArray);
+ self::assertArrayHasKey('city', $payoutInfoArray);
+ self::assertArrayHasKey('postal', $payoutInfoArray);
+ self::assertArrayHasKey('sort', $payoutInfoArray);
+ self::assertArrayHasKey('wire', $payoutInfoArray);
+ self::assertArrayHasKey('bankName', $payoutInfoArray);
+ self::assertArrayHasKey('bankAddress', $payoutInfoArray);
+ self::assertArrayHasKey('iban', $payoutInfoArray);
+ self::assertArrayHasKey('additionalInformation', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderName', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderAddress', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderAddress2', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderPostalCode', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderCity', $payoutInfoArray);
+ self::assertArrayHasKey('accountHolderCountry', $payoutInfoArray);
+
+ self::assertEquals('Label', $payoutInfoArray['label']);
+ self::assertEquals('USA', $payoutInfoArray['bankCountry']);
+ self::assertEquals('Name', $payoutInfoArray['name']);
+ self::assertEquals('Bank', $payoutInfoArray['bank']);
+ self::assertEquals('Swift', $payoutInfoArray['swift']);
+ self::assertEquals('Address', $payoutInfoArray['address']);
+ self::assertEquals('Miami', $payoutInfoArray['city']);
+ self::assertEquals('12345', $payoutInfoArray['postal']);
+ self::assertEquals('Sort', $payoutInfoArray['sort']);
+ self::assertEquals('Wire', $payoutInfoArray['wire']);
+ self::assertEquals('Bank name', $payoutInfoArray['bankName']);
+ self::assertEquals('Bank address', $payoutInfoArray['bankAddress']);
+ self::assertEquals('KW81CBKU00000000000012345601013', $payoutInfoArray['iban']);
+ self::assertEquals('Additional information', $payoutInfoArray['additionalInformation']);
+ self::assertEquals('Account holder name', $payoutInfoArray['accountHolderName']);
+ self::assertEquals('Account holder address', $payoutInfoArray['accountHolderAddress']);
+ self::assertEquals('Account holder address2', $payoutInfoArray['accountHolderAddress2']);
+ self::assertEquals('Account holder postal code', $payoutInfoArray['accountHolderPostalCode']);
+ self::assertEquals('Account holder city', $payoutInfoArray['accountHolderCity']);
+ self::assertEquals('Account holder country', $payoutInfoArray['accountHolderCountry']);
+ }
+
+ private function createClassObject(): PayoutInfo
+ {
+ return new PayoutInfo();
+ }
+
+ private function setSetters(PayoutInfo $payoutInfo)
+ {
+ $payoutInfo->setLabel('Label');
+ $payoutInfo->setBankCountry('USA');
+ $payoutInfo->setName('Name');
+ $payoutInfo->setBank('Bank');
+ $payoutInfo->setSwift('Swift');
+ $payoutInfo->setAddress('Address');
+ $payoutInfo->setCity('Miami');
+ $payoutInfo->setPostal('12345');
+ $payoutInfo->setSort('Sort');
+ $payoutInfo->setWire('Wire');
+ $payoutInfo->setBankName('Bank name');
+ $payoutInfo->setBankAddress('Bank address');
+ $payoutInfo->setIban('KW81CBKU00000000000012345601013');
+ $payoutInfo->setAdditionalInformation('Additional information');
+ $payoutInfo->setAccountHolderName('Account holder name');
+ $payoutInfo->setAccountHolderAddress('Account holder address');
+ $payoutInfo->setAccountHolderAddress2('Account holder address2');
+ $payoutInfo->setAccountHolderPostalCode('Account holder postal code');
+ $payoutInfo->setAccountHolderCity('Account holder city');
+ $payoutInfo->setAccountHolderCountry('Account holder country');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Settlement/RefundInfoTest.php b/test/unit/BitPaySDK/Model/Settlement/RefundInfoTest.php
new file mode 100644
index 00000000..1032aca5
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/RefundInfoTest.php
@@ -0,0 +1,81 @@
+createClassObject();
+ self::assertInstanceOf(RefundInfo::class, $refundInfo);
+ }
+
+ public function testGetSupportRequest()
+ {
+ $expectedSupportRequest = 'Test support request';
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setSupportRequest($expectedSupportRequest);
+ self::assertEquals($expectedSupportRequest, $refundInfo->getSupportRequest());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $refundInfo->getCurrency());
+ }
+
+ public function testGetAmounts()
+ {
+ $expectedAmounts = [25];
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setAmounts($expectedAmounts);
+ self::assertEquals($expectedAmounts, $refundInfo->getAmounts());
+ }
+
+ public function testGetRefundRequestEid()
+ {
+ $expectedRefundRequestEid = 'abcd123';
+
+ $refundInfo = $this->createClassObject();
+ $refundInfo->setRefundRequestEid($expectedRefundRequestEid);
+ $this->assertEquals($expectedRefundRequestEid, $refundInfo->getRefundRequestEid());
+ }
+
+ public function testToArray()
+ {
+ $refundInfo = $this->createClassObject();
+ $this->setSetters($refundInfo);
+ $refundInfoArray = $refundInfo->toArray();
+
+ self::assertNotNull($refundInfoArray);
+ self::assertIsArray($refundInfoArray);
+
+ self::assertArrayHasKey('supportRequest', $refundInfoArray);
+ self::assertArrayHasKey('currency', $refundInfoArray);
+ self::assertArrayHasKey('amounts', $refundInfoArray);
+
+ self::assertEquals('Test support request', $refundInfoArray['supportRequest']);
+ self::assertEquals('BTC', $refundInfoArray['currency']);
+ self::assertEquals([25], $refundInfoArray['amounts']);
+ }
+
+ private function createClassObject(): RefundInfo
+ {
+ return new RefundInfo();
+ }
+
+ private function setSetters(RefundInfo $refundInfo)
+ {
+ $refundInfo->setSupportRequest('Test support request');
+ $refundInfo->setCurrency('BTC');
+ $refundInfo->setAmounts([25]);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Settlement/SettlementLedgerEntryTest.php b/test/unit/BitPaySDK/Model/Settlement/SettlementLedgerEntryTest.php
new file mode 100644
index 00000000..5763e0ea
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/SettlementLedgerEntryTest.php
@@ -0,0 +1,120 @@
+createClassObject();
+ self::assertInstanceOf(SettlementLedgerEntry::class, $settlementLedgerEntry);
+ }
+
+ public function testGetCode()
+ {
+ $expectedCode = 583;
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setCode($expectedCode);
+ self::assertEquals($expectedCode, $settlementLedgerEntry->getCode());
+ }
+
+ public function testGetInvoiceId()
+ {
+ $expectedInvoiceId = '1';
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setInvoiceId($expectedInvoiceId);
+ self::assertEquals($expectedInvoiceId, $settlementLedgerEntry->getInvoiceId());
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 20.3;
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $settlementLedgerEntry->getAmount());
+ }
+
+ public function testGetTimestamp()
+ {
+ $expectedTimestamp = '2022-01-11 01:01:01';
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setTimestamp($expectedTimestamp);
+ self::assertEquals($expectedTimestamp, $settlementLedgerEntry->getTimestamp());
+ }
+
+ public function testGetDescription()
+ {
+ $expectedDescription = 'Test description';
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setDescription($expectedDescription);
+ self::assertEquals($expectedDescription, $settlementLedgerEntry->getDescription());
+ }
+
+ public function testGetReference()
+ {
+ $expectedReference = 'Test reference';
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setReference($expectedReference);
+ self::assertEquals($expectedReference, $settlementLedgerEntry->getReference());
+ }
+
+ public function testGetInvoiceData()
+ {
+ $expectedInvoiceData = $this->getMockBuilder(InvoiceData::class)->getMock();
+
+ $settlementLedgerEntry = $this->createClassObject();
+ $settlementLedgerEntry->setInvoiceData($expectedInvoiceData);
+ self::assertEquals($expectedInvoiceData, $settlementLedgerEntry->getInvoiceData());
+ }
+
+ public function testToArray()
+ {
+ $settlementLedgerEntry = $this->createClassObject();
+ $this->setSetters($settlementLedgerEntry);
+ $settlementLedgerEntryArray = $settlementLedgerEntry->toArray();
+
+ self::assertNotNull($settlementLedgerEntryArray);
+ self::assertIsArray($settlementLedgerEntryArray);
+
+ self::assertArrayHasKey('code', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('invoiceId', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('amount', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('timestamp', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('description', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('reference', $settlementLedgerEntryArray);
+ self::assertArrayHasKey('invoiceData', $settlementLedgerEntryArray);
+
+ self::assertEquals(567, $settlementLedgerEntryArray['code']);
+ self::assertEquals('14', $settlementLedgerEntryArray['invoiceId']);
+ self::assertEquals(55.5, $settlementLedgerEntryArray['amount']);
+ self::assertEquals('2022-01-11 01:01:01', $settlementLedgerEntryArray['timestamp']);
+ self::assertEquals('Description', $settlementLedgerEntryArray['description']);
+ self::assertEquals('Reference', $settlementLedgerEntryArray['reference']);
+ }
+
+ private function createClassObject(): SettlementLedgerEntry
+ {
+ return new SettlementLedgerEntry();
+ }
+
+ private function setSetters(SettlementLedgerEntry $settlementLedgerEntry)
+ {
+ $settlementLedgerEntry->setCode(567);
+ $settlementLedgerEntry->setInvoiceId('14');
+ $settlementLedgerEntry->setAmount(55.5);
+ $settlementLedgerEntry->setTimestamp('2022-01-11 01:01:01');
+ $settlementLedgerEntry->setDescription('Description');
+ $settlementLedgerEntry->setReference('Reference');
+ $settlementLedgerEntry->setInvoiceData($this->getMockBuilder(InvoiceData::class)->getMock());
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Settlement/SettlementTest.php b/test/unit/BitPaySDK/Model/Settlement/SettlementTest.php
new file mode 100644
index 00000000..f9e28685
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/SettlementTest.php
@@ -0,0 +1,262 @@
+createClassObject();
+ self::assertInstanceOf(Settlement::class, $settlement);
+ }
+
+ public function testGetId()
+ {
+ $expectedId = '22';
+
+ $settlement = $this->createClassObject();
+ $settlement->setId($expectedId);
+ self::assertEquals($expectedId, $settlement->getId());
+ }
+
+ public function testGetAccountId()
+ {
+ $expectedAccountId = '15';
+
+ $settlement = $this->createClassObject();
+ $settlement->setAccountId($expectedAccountId);
+ self::assertEquals($expectedAccountId, $settlement->getAccountId());
+ }
+
+ public function testGetCurrency()
+ {
+ $expectedCurrency = 'BTC';
+
+ $settlement = $this->createClassObject();
+ $settlement->setCurrency($expectedCurrency);
+ self::assertEquals($expectedCurrency, $settlement->getCurrency());
+ }
+
+ public function testGetPayoutInfo()
+ {
+ $expectedPayoutInfo = $this->getMockBuilder(PayoutInfo::class)->getMock();
+
+ $settlement = $this->createClassObject();
+ $settlement->setPayoutInfo($expectedPayoutInfo);
+ self::assertEquals($expectedPayoutInfo, $settlement->getPayoutInfo());
+ }
+
+ public function testGetStatus()
+ {
+ $expectedStatus = 'pending';
+
+ $settlement = $this->createClassObject();
+ $settlement->setStatus($expectedStatus);
+ self::assertEquals($expectedStatus, $settlement->getStatus());
+ }
+
+ public function testGetDateCreated()
+ {
+ $expectedDateCreated = '2022-01-01';
+
+ $settlement = $this->createClassObject();
+ $settlement->setDateCreated($expectedDateCreated);
+ self::assertEquals($expectedDateCreated, $settlement->getDateCreated());
+ }
+
+ public function testGetDateExecuted()
+ {
+ $expectedDateExecuted = '2022-01-01';
+
+ $settlement = $this->createClassObject();
+ $settlement->setDateExecuted($expectedDateExecuted);
+ self::assertEquals($expectedDateExecuted, $settlement->getDateExecuted());
+ }
+
+ public function testGetDateCompleted()
+ {
+ $expectedDateCompleted = '2022-01-01';
+
+ $settlement = $this->createClassObject();
+ $settlement->setDateCompleted($expectedDateCompleted);
+ self::assertEquals($expectedDateCompleted, $settlement->getDateCompleted());
+ }
+
+ public function testGetOpeningDate()
+ {
+ $expectedDateCompleted = '2022-01-01';
+
+ $settlement = $this->createClassObject();
+ $settlement->setOpeningDate($expectedDateCompleted);
+ self::assertEquals($expectedDateCompleted, $settlement->getOpeningDate());
+ }
+
+ public function testGetClosingDate()
+ {
+ $expectedClosingDate = '2022-01-01';
+
+ $settlement = $this->createClassObject();
+ $settlement->setClosingDate($expectedClosingDate);
+ self::assertEquals($expectedClosingDate, $settlement->getClosingDate());
+ }
+
+ public function testGetOpeningBalance()
+ {
+ $expectedOpeningBalance = 20.0;
+
+ $settlement = $this->createClassObject();
+ $settlement->setOpeningBalance($expectedOpeningBalance);
+ self::assertEquals($expectedOpeningBalance, $settlement->getOpeningBalance());
+ }
+
+ public function testGetLedgerEntriesSum()
+ {
+ $expectedLedgerEntriesSum = 20.0;
+
+ $settlement = $this->createClassObject();
+ $settlement->setLedgerEntriesSum($expectedLedgerEntriesSum);
+ self::assertEquals($expectedLedgerEntriesSum, $settlement->getLedgerEntriesSum());
+ }
+
+ public function testGetWithHoldings()
+ {
+ $settlement = $this->createClassObject();
+ $withHolding = new WithHoldings();
+
+ $settlement->setWithHoldings([$withHolding]);
+
+ self::assertSame([$withHolding], $settlement->getWithHoldings());
+ }
+
+ public function testGetWithHoldingsSum()
+ {
+ $expectedWithHoldingsSum = 15.2;
+
+ $settlement = $this->createClassObject();
+ $settlement->setWithHoldingsSum($expectedWithHoldingsSum);
+ self::assertEquals($expectedWithHoldingsSum, $settlement->getWithHoldingsSum());
+ }
+
+ public function testGetTotalAmount()
+ {
+ $expectedTotalAmount = 20.0;
+
+ $settlement = $this->createClassObject();
+ $settlement->setTotalAmount($expectedTotalAmount);
+ self::assertEquals($expectedTotalAmount, $settlement->getTotalAmount());
+ }
+
+ /**
+ * @throws \BitPaySDK\Exceptions\SettlementException
+ */
+ public function testGetLedgerEntries()
+ {
+ $settlement = $this->createClassObject();
+ $ledgerEntry = new SettlementLedgerEntry();
+
+ $settlement->setLedgerEntries([$ledgerEntry]);
+
+ self::assertEquals([$ledgerEntry], $settlement->getLedgerEntries());
+ }
+
+ public function testGetToken()
+ {
+ $expectedToken = 'she73j92nv83';
+
+ $settlement = $this->createClassObject();
+ $settlement->setToken($expectedToken);
+ self::assertEquals($expectedToken, $settlement->getToken());
+ }
+
+ /**
+ * @throws \BitPaySDK\Exceptions\SettlementException
+ */
+ public function testToArray()
+ {
+ $settlement = $this->createClassObject();
+ $this->prepareSettlementForTests($settlement);
+ $settlementArray = $settlement->toArray();
+
+ self::assertNotNull($settlementArray);
+ self::assertIsArray($settlementArray);
+
+ self::assertArrayHasKey('id', $settlementArray);
+ self::assertArrayHasKey('accountId', $settlementArray);
+ self::assertArrayHasKey('currency', $settlementArray);
+ self::assertArrayHasKey('payoutInfo', $settlementArray);
+ self::assertArrayHasKey('status', $settlementArray);
+ self::assertArrayHasKey('dateCreated', $settlementArray);
+ self::assertArrayHasKey('dateExecuted', $settlementArray);
+ self::assertArrayHasKey('dateCompleted', $settlementArray);
+ self::assertArrayHasKey('openingDate', $settlementArray);
+ self::assertArrayHasKey('closingDate', $settlementArray);
+ self::assertArrayHasKey('openingBalance', $settlementArray);
+ self::assertArrayHasKey('ledgerEntriesSum', $settlementArray);
+ self::assertArrayHasKey('withHoldings', $settlementArray);
+ self::assertArrayHasKey('withHoldingsSum', $settlementArray);
+ self::assertArrayHasKey('totalAmount', $settlementArray);
+ self::assertArrayHasKey('ledgerEntries', $settlementArray);
+ self::assertArrayHasKey('token', $settlementArray);
+
+ self::assertEquals('11', $settlementArray['id']);
+ self::assertEquals('12', $settlementArray['accountId']);
+ self::assertEquals('BTC', $settlementArray['currency']);
+ self::assertEquals($settlementArray['payoutInfo'], new PayoutInfo());
+ self::assertEquals('pending', $settlementArray['status']);
+ self::assertEquals('2022-01-01', $settlementArray['dateCreated']);
+ self::assertEquals('2022-01-01', $settlementArray['dateExecuted']);
+ self::assertEquals('2022-01-01', $settlementArray['dateCompleted']);
+ self::assertEquals('2022-01-01', $settlementArray['openingDate']);
+ self::assertEquals('2022-01-01', $settlementArray['closingDate']);
+ self::assertEquals(15.0, $settlementArray['openingBalance']);
+ self::assertEquals(12.2, $settlementArray['ledgerEntriesSum']);
+ self::assertEquals(self::WITH_HOLDINGS_AMOUNT, $settlementArray['withHoldings'][0]['amount']);
+ self::assertEquals(15, $settlementArray['withHoldingsSum']);
+ self::assertEquals(30, $settlementArray['totalAmount']);
+ self::assertEquals(self::LEDGER_ENTRY_AMOUNT, $settlementArray['ledgerEntries'][0]['amount']);
+ self::assertEquals('5u3cc2c7b', $settlementArray['token']);
+ }
+
+ private function createClassObject(): Settlement
+ {
+ return new Settlement();
+ }
+
+ /**
+ * @throws \BitPaySDK\Exceptions\SettlementException
+ */
+ private function prepareSettlementForTests(Settlement $settlement)
+ {
+ $withHoldings = new WithHoldings();
+ $withHoldings->setAmount(self::WITH_HOLDINGS_AMOUNT);
+ $settlementLedgerEntry = new SettlementLedgerEntry();
+ $settlementLedgerEntry->setAmount(self::LEDGER_ENTRY_AMOUNT);
+
+ $settlement->setId('11');
+ $settlement->setAccountId('12');
+ $settlement->setCurrency('BTC');
+ $settlement->setPayoutInfo(new PayoutInfo());
+ $settlement->setStatus('pending');
+ $settlement->setDateCreated('2022-01-01');
+ $settlement->setDateExecuted('2022-01-01');
+ $settlement->setDateCompleted('2022-01-01');
+ $settlement->setOpeningDate('2022-01-01');
+ $settlement->setClosingDate('2022-01-01');
+ $settlement->setOpeningBalance(15);
+ $settlement->setLedgerEntriesSum(12.2);
+ $settlement->setWithHoldings([$withHoldings]);
+ $settlement->setWithHoldingsSum(15);
+ $settlement->setTotalAmount(30.0);
+ $settlement->setLedgerEntries([$settlementLedgerEntry]);
+ $settlement->setToken('5u3cc2c7b');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Settlement/WithHoldingsTest.php b/test/unit/BitPaySDK/Model/Settlement/WithHoldingsTest.php
new file mode 100644
index 00000000..c543e9b9
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Settlement/WithHoldingsTest.php
@@ -0,0 +1,108 @@
+createClassObject();
+ self::assertInstanceOf(WithHoldings::class, $withHoldings);
+ }
+
+ public function testGetAmount()
+ {
+ $expectedAmount = 12.5;
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setAmount($expectedAmount);
+ self::assertEquals($expectedAmount, $withHoldings->getAmount());
+ }
+
+ public function testGetCode()
+ {
+ $expectedCode = 'BTC';
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setCode($expectedCode);
+ self::assertEquals($expectedCode, $withHoldings->getCode());
+ }
+
+ public function testGetDescription()
+ {
+ $expectedDescription = 'Test description';
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setDescription($expectedDescription);
+ self::assertEquals($expectedDescription, $withHoldings->getDescription());
+ }
+
+ public function testGetNotes()
+ {
+ $expectedNotes = 'Test note';
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setNotes($expectedNotes);
+ self::assertEquals($expectedNotes, $withHoldings->getNotes());
+ }
+
+ public function testGetLabel()
+ {
+ $expectedLabel = 'Test label';
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setLabel($expectedLabel);
+ self::assertEquals($expectedLabel, $withHoldings->getLabel());
+ }
+
+ public function testGetBankCountry()
+ {
+ $expectedBankCountry = 'USA';
+
+ $withHoldings = $this->createClassObject();
+ $withHoldings->setBankCountry($expectedBankCountry);
+ self::assertEquals($expectedBankCountry, $withHoldings->getBankCountry());
+ }
+
+ public function testToArray()
+ {
+ $withHoldings = $this->createClassObject();
+ $this->setSetters($withHoldings);
+ $withHoldingsArray = $withHoldings->toArray();
+
+ self::assertNotNull($withHoldingsArray);
+ self::assertIsArray($withHoldingsArray);
+
+ self::assertArrayHasKey('amount', $withHoldingsArray);
+ self::assertArrayHasKey('code', $withHoldingsArray);
+ self::assertArrayHasKey('description', $withHoldingsArray);
+ self::assertArrayHasKey('notes', $withHoldingsArray);
+ self::assertArrayHasKey('label', $withHoldingsArray);
+ self::assertArrayHasKey('bankCountry', $withHoldingsArray);
+
+ self::assertEquals(10.5, $withHoldingsArray['amount']);
+ self::assertEquals('BTC', $withHoldingsArray['code']);
+ self::assertEquals('Description', $withHoldingsArray['description']);
+ self::assertEquals('Note', $withHoldingsArray['notes']);
+ self::assertEquals('Label', $withHoldingsArray['label']);
+ self::assertEquals('USA', $withHoldingsArray['bankCountry']);
+ }
+
+ private function createClassObject(): WithHoldings
+ {
+ return new WithHoldings();
+ }
+
+ private function setSetters(WithHoldings $withHoldings)
+ {
+ $withHoldings->setAmount(10.5);
+ $withHoldings->setCode('BTC');
+ $withHoldings->setDescription('Description');
+ $withHoldings->setNotes('Note');
+ $withHoldings->setLabel('Label');
+ $withHoldings->setBankCountry('USA');
+ }
+}
diff --git a/test/unit/BitPaySDK/Model/Wallet/CurrenciesTest.php b/test/unit/BitPaySDK/Model/Wallet/CurrenciesTest.php
new file mode 100644
index 00000000..1503b8cb
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Wallet/CurrenciesTest.php
@@ -0,0 +1,133 @@
+createClassObject();
+ self::assertInstanceOf(Currencies::class, $currencies);
+ }
+
+ public function testGetCode()
+ {
+ $expectedCode = 'BTH';
+
+ $currencies = $this->createClassObject();
+ $currencies->setCode($expectedCode);
+ self::assertEquals($expectedCode, $currencies->getCode());
+ }
+
+ public function testGetP2p()
+ {
+ $currencies = $this->createClassObject();
+ $currencies->setP2p(true);
+ self::assertTrue($currencies->getP2p());
+ }
+
+ public function testGetDappBrowser()
+ {
+ $currencies = $this->createClassObject();
+ $currencies->setDappBrowser(true);
+ self::assertTrue($currencies->getDappBrowser());
+ }
+
+ public function testGetImage()
+ {
+ $expectedImage = 'https://bitpay.com/api/images/logo-6fa5404d.svg';
+
+ $currencies = $this->createClassObject();
+ $currencies->setImage($expectedImage);
+ self::assertEquals($expectedImage, $currencies->getImage());
+ }
+
+ public function testGetPayPro()
+ {
+ $currencies = $this->createClassObject();
+ $currencies->setPayPro(true);
+ self::assertTrue($currencies->getPayPro());
+ }
+
+ public function testGetQr()
+ {
+ $expectedCurrencyQr = new CurrencyQr;
+ $expectedCurrencyQr->setType('BIP21');
+ $expectedCurrencyQr->setCollapsed(false);
+
+ $currencies = $this->createClassObject();
+ $currencies->setQr($expectedCurrencyQr);
+
+ self::assertEquals($expectedCurrencyQr, $currencies->getQr());
+ }
+
+ public function testGetWithdrawalFee()
+ {
+ $expectedWithdrawalFee = '1.23';
+
+ $currencies = $this->createClassObject();
+ $currencies->setWithdrawalFee($expectedWithdrawalFee);
+ self::assertEquals($expectedWithdrawalFee, $currencies->getWithdrawalFee());
+ }
+
+ public function testGetWalletConnect()
+ {
+ $currencies = $this->createClassObject();
+ $currencies->setWalletConnect(true);
+ self::assertTrue($currencies->getWalletConnect());
+ }
+
+ public function testToArray()
+ {
+ $currencies = $this->createClassObject();
+ $this->objectSetters($currencies);
+ $currenciesArray = $currencies->toArray();
+
+ self::assertNotNull($currenciesArray);
+ self::assertIsArray($currenciesArray);
+
+ self::assertArrayHasKey('code', $currenciesArray);
+ self::assertArrayHasKey('p2p', $currenciesArray);
+ self::assertArrayHasKey('dappBrowser', $currenciesArray);
+ self::assertArrayHasKey('image', $currenciesArray);
+ self::assertArrayHasKey('paypro', $currenciesArray);
+ self::assertArrayHasKey('qr', $currenciesArray);
+ self::assertArrayHasKey('withdrawalFee', $currenciesArray);
+ self::assertArrayHasKey('walletConnect', $currenciesArray);
+
+ self::assertEquals('BTH', $currenciesArray['code']);
+ self::assertEquals(true, $currenciesArray['p2p']);
+ self::assertEquals(true, $currenciesArray['dappBrowser']);
+ self::assertEquals('https://bitpay.com/api/images/logo-6fa5404d.svg', $currenciesArray['image']);
+ self::assertEquals(true, $currenciesArray['paypro']);
+ self::assertEquals('BIP21', $currenciesArray['qr']['type']);
+ self::assertEquals(false, $currenciesArray['qr']['collapsed']);
+ self::assertEquals('1.23', $currenciesArray['withdrawalFee']);
+ self::assertEquals(true, $currenciesArray['walletConnect']);
+ }
+
+ private function createClassObject(): Currencies
+ {
+ return new Currencies();
+ }
+
+ private function objectSetters(Currencies $currencies): void
+ {
+ $currencyQr = new CurrencyQr;
+ $currencyQr->setType('BIP21');
+ $currencyQr->setCollapsed(false);
+
+ $currencies->setCode('BTH');
+ $currencies->setP2p(true);
+ $currencies->setDappBrowser(true);
+ $currencies->setImage('https://bitpay.com/api/images/logo-6fa5404d.svg');
+ $currencies->setPayPro(true);
+ $currencies->setQr($currencyQr);
+ $currencies->setWithdrawalFee('1.23');
+ $currencies->setWalletConnect(true);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Wallet/CurrencyQrTest.php b/test/unit/BitPaySDK/Model/Wallet/CurrencyQrTest.php
new file mode 100644
index 00000000..9d62b402
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Wallet/CurrencyQrTest.php
@@ -0,0 +1,58 @@
+createClassObject();
+ self::assertInstanceOf(CurrencyQr::class, $currencyQr);
+ }
+
+ public function testGetType()
+ {
+ $expectedType = 'BIP21';
+
+ $currencyQr = $this->createClassObject();
+ $currencyQr->setType($expectedType);
+ self::assertEquals($expectedType, $currencyQr->getType());
+ }
+
+ public function testGetCollapsed()
+ {
+ $currencyQr = $this->createClassObject();
+ $currencyQr->setCollapsed(false);
+ self::assertFalse($currencyQr->getCollapsed());
+ }
+
+ public function testToArray()
+ {
+ $currencyQr = $this->createClassObject();
+ $this->objectSetters($currencyQr);
+ $currencyQrArray = $currencyQr->toArray();
+
+ self::assertNotNull($currencyQrArray);
+ self::assertIsArray($currencyQrArray);
+
+ self::assertArrayHasKey('type', $currencyQrArray);
+ self::assertArrayHasKey('collapsed', $currencyQrArray);
+
+ self::assertEquals('BIP21', $currencyQrArray['type']);
+ self::assertEquals(false, $currencyQrArray['collapsed']);
+ }
+
+ private function createClassObject(): CurrencyQr
+ {
+ return new CurrencyQr();
+ }
+
+ private function objectSetters(CurrencyQr $currencyQr): void
+ {
+ $currencyQr->setType('BIP21');
+ $currencyQr->setCollapsed(false);
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/Model/Wallet/WalletTest.php b/test/unit/BitPaySDK/Model/Wallet/WalletTest.php
new file mode 100644
index 00000000..066d030d
--- /dev/null
+++ b/test/unit/BitPaySDK/Model/Wallet/WalletTest.php
@@ -0,0 +1,142 @@
+createClassObject();
+ self::assertInstanceOf(Wallet::class, $wallet);
+ }
+
+ public function testGetKey()
+ {
+ $expectedKey = 'abcd123';
+
+ $wallet = $this->createClassObject();
+ $wallet->setKey($expectedKey);
+ self::assertEquals($expectedKey, $wallet->getKey());
+ }
+
+ public function testGetDisplayName()
+ {
+ $expectedDisplayName = 'My Wallet';
+
+ $wallet = $this->createClassObject();
+ $wallet->setDisplayName($expectedDisplayName);
+ self::assertEquals($expectedDisplayName, $wallet->getDisplayName());
+ }
+
+ public function testGetAvatar()
+ {
+ $expectedAvatar = 'image.png';
+
+ $wallet = $this->createClassObject();
+ $wallet->setAvatar($expectedAvatar);
+ self::assertEquals($expectedAvatar, $wallet->getAvatar());
+ }
+
+ public function testGetPayPro()
+ {
+ $wallet = $this->createClassObject();
+ $wallet->setPayPro(true);
+ self::assertTrue($wallet->getPayPro());
+ }
+
+ public function testGetCurrencies()
+ {
+ $currencyQr = new CurrencyQr;
+ $currencyQr->setType('BIP21');
+ $currencyQr->setCollapsed(false);
+
+ $expectedCurrencies = new Currencies();
+ $expectedCurrencies->setCode('BTH');
+ $expectedCurrencies->setP2p(true);
+ $expectedCurrencies->setDappBrowser(true);
+ $expectedCurrencies->setImage('https://bitpay.com/api/images/logo-6fa5404d.svg');
+ $expectedCurrencies->setPayPro(true);
+ $expectedCurrencies->setQr($currencyQr);
+ $expectedCurrencies->setWithdrawalFee('1.23');
+ $expectedCurrencies->setWalletConnect(true);
+
+ $wallet = $this->createClassObject();
+ $wallet->setCurrencies($expectedCurrencies);
+ self::assertEquals($expectedCurrencies, $wallet->getCurrencies());
+ }
+
+ public function testGetImage()
+ {
+ $expectedImage = 'https://bitpay.com/api/images/logo-6fa5404d.svg';
+
+ $wallet = $this->createClassObject();
+ $wallet->setImage($expectedImage);
+ self::assertEquals($expectedImage, $wallet->getImage());
+ }
+
+ public function testToArray()
+ {
+ $wallet = $this->createClassObject();
+ $this->objectSetters($wallet);
+ $walletArray = $wallet->toArray();
+
+ self::assertNotNull($walletArray);
+ self::assertIsArray($walletArray);
+
+ self::assertArrayHasKey('key', $walletArray);
+ self::assertArrayHasKey('displayName', $walletArray);
+ self::assertArrayHasKey('avatar', $walletArray);
+ self::assertArrayHasKey('paypro', $walletArray);
+ self::assertArrayHasKey('currencies', $walletArray);
+ self::assertArrayHasKey('image', $walletArray);
+
+ self::assertEquals('abcd123', $walletArray['key']);
+ self::assertEquals('My Wallet', $walletArray['displayName']);
+ self::assertEquals('image.png', $walletArray['avatar']);
+ self::assertTrue($walletArray['paypro']);
+ self::assertEquals('BTH', $walletArray['currencies']['code']);
+ self::assertTrue($walletArray['currencies']['p2p']);
+ self::assertTrue($walletArray['currencies']['dappBrowser']);
+ self::assertEquals('https://bitpay.com/api/images/logo-6fa5404d.svg', $walletArray['currencies']['image']);
+ self::assertTrue($walletArray['currencies']['paypro']);
+ self::assertEquals('BIP21', $walletArray['currencies']['qr']['type']);
+ self::assertFalse($walletArray['currencies']['qr']['collapsed']);
+ self::assertEquals('1.23', $walletArray['currencies']['withdrawalFee']);
+ self::assertTrue($walletArray['currencies']['walletConnect']);
+ self::assertEquals('https://bitpay.com/api/images/logo-6fa5404d.svg', $walletArray['image']);
+ }
+
+ private function createClassObject(): Wallet
+ {
+ return new Wallet();
+ }
+
+ private function objectSetters(Wallet $wallet): void
+ {
+ $currencyQr = new CurrencyQr;
+ $currencyQr->setType('BIP21');
+ $currencyQr->setCollapsed(false);
+
+ $currencies = new Currencies();
+ $currencies->setCode('BTH');
+ $currencies->setP2p(true);
+ $currencies->setDappBrowser(true);
+ $currencies->setImage('https://bitpay.com/api/images/logo-6fa5404d.svg');
+ $currencies->setPayPro(true);
+ $currencies->setQr($currencyQr);
+ $currencies->setWithdrawalFee('1.23');
+ $currencies->setWalletConnect(true);
+
+ $wallet->setKey('abcd123');
+ $wallet->setDisplayName('My Wallet');
+ $wallet->setAvatar('image.png');
+ $wallet->setPayPro(true);
+ $wallet->setCurrencies($currencies);
+ $wallet->setImage('https://bitpay.com/api/images/logo-6fa5404d.svg');
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/PrivateKeyNameUnit.key b/test/unit/BitPaySDK/PrivateKeyNameUnit.key
new file mode 100644
index 00000000..5ea3954a
--- /dev/null
+++ b/test/unit/BitPaySDK/PrivateKeyNameUnit.key
@@ -0,0 +1 @@
+8f8645c755bc39033f56c3940f4455a3adf348ff8cea3e14298b4c2d40b3cb8a2a1ab5f0b4740a33d3a35f71bf2de621bb648777911e3365391efa0b46eee341e035c68b0b0d00074e22b5c3aa533c29922ca8c1d14ab1f1426f81f1bde38e7f5a89915a747092ce04e969fd5e12522ce8e30f2e0aef9e271423679f7395b83c5830c53fd2996945afe8ce59b2d409d285c8e9738eeab0f7251de3f550d4723c9b65f56750445b979d9ef36c8f90e82db410c34ed10bb32c127fce955ab8293d7991864c3bccecc0b1005f8eb94a0b598e8f8b287226d738729991216f4aadf22aa656576d5c5936e33e1d737fd869d40ddde16afd6b417312d068989f40f84c0c42d2a7036753b18cae9bec2c88580f7a4b09dd34c776d44ecaa0bff980b5371fb43512d1f53125f88c9b8279eba709
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/TokensTest.php b/test/unit/BitPaySDK/TokensTest.php
new file mode 100644
index 00000000..3a912146
--- /dev/null
+++ b/test/unit/BitPaySDK/TokensTest.php
@@ -0,0 +1,59 @@
+ 'test1', 'payout' => 'test2']);
+ self::assertEquals('test1', $tokens->getTokenByFacade(Facade::MERCHANT));
+ self::assertEquals('test2', $tokens->getTokenByFacade(Facade::PAYOUT));
+ self::assertEquals('test2', $tokens->getPayoutToken());
+ }
+
+ public function testGetTokenByFacadeException()
+ {
+ $instance = new Tokens();
+ $this->expectException(Exception::class);
+ $this->expectExceptionMessage("given facade does not exist or no token defined for the given facade");
+ $instance->getTokenByFacade(null);
+ }
+
+ /**
+ * @throws ReflectionException
+ * @throws Exception
+ */
+ public function testGetTokenByFacade()
+ {
+ $instance = new Tokens(Facade::MERCHANT, Facade::PAYOUT);
+ self::assertEquals(
+ $this->accessProtected($instance, 'merchant'),
+ $instance->getTokenByFacade(Facade::MERCHANT)
+ );
+
+ self::assertEquals($instance->getPayoutToken(), $instance->getTokenByFacade(Facade::PAYOUT));
+ }
+
+ /**
+ * @throws ReflectionException
+ */
+ private function accessProtected($obj, $prop)
+ {
+ $reflection = new ReflectionClass($obj);
+ $property = $reflection->getProperty($prop);
+ $property->setAccessible(true);
+
+ return $property->getValue($obj);
+ }
+}
diff --git a/examples/bitpay_private_test.key b/test/unit/BitPaySDK/bitpay_private_test.key
similarity index 100%
rename from examples/bitpay_private_test.key
rename to test/unit/BitPaySDK/bitpay_private_test.key
diff --git a/test/unit/BitPaySDK/json/cancelPayoutGroupResponse.json b/test/unit/BitPaySDK/json/cancelPayoutGroupResponse.json
new file mode 100644
index 00000000..846e9419
--- /dev/null
+++ b/test/unit/BitPaySDK/json/cancelPayoutGroupResponse.json
@@ -0,0 +1,46 @@
+{
+ "cancelled": [
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "2tRxwvX5JkVbhqBLGyanmF",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "cancelled",
+ "transactions": []
+ },
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "2tRxwvX5JkVbhqBLGyanmF",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 20,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe 2",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "cancelled",
+ "transactions": []
+ }
+ ],
+ "failed": [
+ {
+ "errMessage": "PayoutId is missing or invalid",
+ "payoutId": "D8tgWzn1psUua4NYWW1vYo"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/createPayoutGroupRequest.json b/test/unit/BitPaySDK/json/createPayoutGroupRequest.json
new file mode 100644
index 00000000..bd863870
--- /dev/null
+++ b/test/unit/BitPaySDK/json/createPayoutGroupRequest.json
@@ -0,0 +1 @@
+{"instructions":[{"amount":10,"currency":"USD","ledgerCurrency":"USD","reference":"payout_20210527","notificationURL":"https:\/\/yournotiticationURL.com\/wed3sa0wx1rz5bg0bv97851eqx","notificationEmail":"merchant@email.com","email":"john@doe.com","recipientId":"LDxRZCGq174SF8AnQpdBPB","shopperId":"7qohDf2zZnQK5Qanj8oyC2"}],"token":"kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/createPayoutGroupResponse.json b/test/unit/BitPaySDK/json/createPayoutGroupResponse.json
new file mode 100644
index 00000000..e58ea459
--- /dev/null
+++ b/test/unit/BitPaySDK/json/createPayoutGroupResponse.json
@@ -0,0 +1,29 @@
+{
+ "created": [
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "SJcWZCFq344DL8QnXpdBNM",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "new",
+ "groupId": "SxKRk4MdW8Ae3vsoR6UPQE",
+ "transactions": []
+ }
+ ],
+ "failed": [
+ {
+ "errMessage": "Ledger currency is required",
+ "payee": "john@doe.com"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/createRefundResponse.json b/test/unit/BitPaySDK/json/createRefundResponse.json
new file mode 100644
index 00000000..4f93e7a6
--- /dev/null
+++ b/test/unit/BitPaySDK/json/createRefundResponse.json
@@ -0,0 +1,16 @@
+{
+ "guid":"37bd36bd-6fcb-409c-a907-47f9244302aa",
+ "id": "Eso8srxKJR5U71ahCspAAA",
+ "invoice": "UZjwcYkWAKfTMn9J1yyfs4",
+ "reference": "someReference",
+ "status": "preview",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 7.19E-4,
+ "transactionRefundFee": 2.0E-6,
+ "currency": "USD",
+ "refundFee": 0.03,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2022-11-14T12:20:47.000Z"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/getInvoice.json b/test/unit/BitPaySDK/json/getInvoice.json
new file mode 100644
index 00000000..3048bcf3
--- /dev/null
+++ b/test/unit/BitPaySDK/json/getInvoice.json
@@ -0,0 +1,407 @@
+{
+ "url": "https://test.bitpay.com/invoice?id=UZjwcYkWAKfTMn9J1yyfs4",
+ "status": "new",
+ "price": 12,
+ "currency": "USD",
+ "itemDesc": "Example",
+ "orderId": "084a86b6-68aa-47bc-b435-e64d122391d1",
+ "invoiceTime": 1668432675975,
+ "rateRefreshTime": 1668432675975,
+ "expirationTime": 1668433575975,
+ "currentTime": 1668432734661,
+ "guid": "chc9kj52-04g0-4b6f-941d-3a844e352758",
+ "id": "UZjwcYkWAKfTMn9J1yyfs4",
+ "lowFeeDetected": false,
+ "amountPaid": 0,
+ "displayAmountPaid": "0",
+ "exceptionStatus": false,
+ "targetConfirmations": 6,
+ "guaranteedPaymentTargetConfirmations": 6,
+ "transactions": [],
+ "transactionSpeed": "medium",
+ "buyer": {
+ "name": "Marcin",
+ "address1": "street",
+ "address2": "911",
+ "locality": "Washington",
+ "region": "District of Columbia",
+ "postalCode": "20000",
+ "country": "USA",
+ "email": "satoshi@buyeremaildomain.com",
+ "notify": true
+ },
+ "autoRedirect": true,
+ "refundAddresses": [],
+ "refundAddressRequestPending": false,
+ "buyerProvidedEmail": "satoshi@buyeremaildomain.com",
+ "buyerProvidedInfo": {
+ "name": "Marcin",
+ "selectedWallet": "bitpay",
+ "emailAddress": "satoshi@buyeremaildomain.com"
+ },
+ "paymentSubtotals": {
+ "BTC": 70100,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentTotals": {
+ "BTC": 70200,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentDisplayTotals": {
+ "BTC": "0.000702",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "paymentDisplaySubTotals": {
+ "BTC": "0.000701",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "exchangeRates": {
+ "BTC": {
+ "USD": 17120.09,
+ "BCH": 163.84429131974352,
+ "ETH": 13.299739755292292,
+ "GUSD": 17120.09,
+ "PAX": 17120.09,
+ "BUSD": 17120.09,
+ "USDC": 17120.09,
+ "DOGE": 188443.27083844703,
+ "LTC": 289.92531752751904,
+ "MATIC": 17878.1223893066,
+ "USDC_m": 17120.09
+ },
+ "BCH": {
+ "USD": 104.38999999999999,
+ "BTC": 0.006097902914889888,
+ "ETH": 0.08109535832200428,
+ "GUSD": 104.38999999999999,
+ "PAX": 104.38999999999999,
+ "BUSD": 104.38999999999999,
+ "USDC": 104.38999999999999,
+ "DOGE": 1149.0356092068141,
+ "LTC": 1.7678238780694326,
+ "MATIC": 109.01211361737676,
+ "USDC_m": 104.38999999999999
+ },
+ "ETH": {
+ "USD": 1286.54,
+ "BTC": 0.07515275424966411,
+ "BCH": 12.312565795769931,
+ "GUSD": 1286.54,
+ "PAX": 1286.54,
+ "BUSD": 1286.54,
+ "USDC": 1286.54,
+ "DOGE": 14161.129156709787,
+ "LTC": 21.787298899237936,
+ "MATIC": 1343.5045948203842,
+ "USDC_m": 1286.54
+ },
+ "GUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "PAX": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "BUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "USDC": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "DOGE": {
+ "USD": 0.09077389999999999,
+ "BTC": 5.302523511887377E-6,
+ "BCH": 8.687328930998182E-4,
+ "ETH": 7.051769275587492E-5,
+ "GUSD": 0.09077389999999999,
+ "PAX": 0.09077389999999999,
+ "BUSD": 0.09077389999999999,
+ "USDC": 0.09077389999999999,
+ "LTC": 0.0015372379339542762,
+ "MATIC": 0.09479312865497075,
+ "USDC_m": 0.09077389999999999
+ },
+ "LTC": {
+ "USD": 59.02,
+ "BTC": 0.0034476312868742336,
+ "BCH": 0.5648387405493349,
+ "ETH": 0.04584967954942708,
+ "GUSD": 59.02,
+ "PAX": 59.02,
+ "BUSD": 59.02,
+ "USDC": 59.02,
+ "DOGE": 649.6415524033546,
+ "MATIC": 61.63324979114453,
+ "USDC_m": 59.02
+ },
+ "MATIC": {
+ "USD": 0.9597999999999999,
+ "BTC": 5.6066359016297676E-5,
+ "BCH": 0.009185567996937507,
+ "ETH": 7.456205088366673E-4,
+ "GUSD": 0.9597999999999999,
+ "PAX": 0.9597999999999999,
+ "BUSD": 0.9597999999999999,
+ "USDC": 0.9597999999999999,
+ "DOGE": 10.564655404892232,
+ "LTC": 0.016254022015241322,
+ "USDC_m": 0.9597999999999999
+ },
+ "USDC_m": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336
+ }
+ },
+ "minerFees": {
+ "BTC": {
+ "satoshisPerByte": 1,
+ "totalFee": 100,
+ "fiatAmount": 0.02
+ },
+ "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": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "LTC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "MATIC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "USDC_m": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ }
+ },
+ "shopper": {},
+ "jsonPayProRequired": false,
+ "merchantName": "SUMO Heavy Industries 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
+ },
+ "DOGE": {
+ "enabled": true
+ },
+ "LTC": {
+ "enabled": true
+ },
+ "APE": {
+ "enabled": false
+ },
+ "EUROC": {
+ "enabled": false
+ },
+ "MATIC": {
+ "enabled": true
+ },
+ "MATIC_e": {
+ "enabled": false
+ },
+ "ETH_m": {
+ "enabled": false
+ },
+ "USDC_m": {
+ "enabled": true
+ },
+ "BUSD_m": {
+ "enabled": false
+ },
+ "DAI_m": {
+ "enabled": false
+ },
+ "WBTC_m": {
+ "enabled": false
+ },
+ "SHIB_m": {
+ "enabled": false
+ }
+ },
+ "paymentCodes": {
+ "BTC": {
+ "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BCH": {
+ "BIP72b": "bitcoincash:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "ETH": {
+ "EIP681": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "GUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "PAX": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "DOGE": {
+ "BIP72b": "dogecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "LTC": {
+ "BIP72b": "litecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "MATIC": {
+ "EIP681": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC_m": {
+ "EIP681b": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ }
+ },
+ "universalCodes": {
+ "paymentString": "https://link.test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "token": "4qS4CzeRlGRu9VvUfVvuESfQXWTAQuFLjhj6osrGexKWZoadBPe1eiScsvTX99dkYi"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/getPayoutBatchResponse.json b/test/unit/BitPaySDK/json/getPayoutBatchResponse.json
new file mode 100644
index 00000000..e778fa36
--- /dev/null
+++ b/test/unit/BitPaySDK/json/getPayoutBatchResponse.json
@@ -0,0 +1,33 @@
+{
+ "id": "LRNmxyjRN1e2JUc6fhgfd",
+ "account": "6iyfXz1dU54Ntrdtr4ez3ch",
+ "status": "new",
+ "amount": 12,
+ "currency": "USD",
+ "ledgerCurrency": "USD",
+ "requestDate": "2023-05-04T11:10:26.032Z",
+ "effectiveDate": "2023-05-04T09:00:00.000Z",
+ "ignoreEmails": false,
+ "supportPhone": "1-855-4-BITPAY",
+ "instructions": [
+ {
+ "id": "XB85mxDdaYkj24hrgs",
+ "payoutId": "Mfdgu5S589birhug24hj23",
+ "amount": 12,
+ "email": "any@email.com",
+ "recipientId": "VeZgfxdgfc687tg34jk",
+ "shopperId": "2toTAVjhkh2dgf65x",
+ "transactions": []
+ },
+ {
+ "id": "XB85mxDdaghj24hrgs",
+ "payoutId": "Mfdgu5S589bifghg24hj23",
+ "amount": 12,
+ "email": "any2@email.com",
+ "recipientId": "VeZgfxdgddfg4jk",
+ "shopperId": "2toTAVjhksdfdgf65x",
+ "transactions": []
+ }
+ ],
+ "token": "8dJGJ65BhrKJmcgfChfg65dn6fuENkKzhgf3hg4hglkj675hn"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/json/getRefund.json b/test/unit/BitPaySDK/json/getRefund.json
new file mode 100644
index 00000000..3ff9e092
--- /dev/null
+++ b/test/unit/BitPaySDK/json/getRefund.json
@@ -0,0 +1,17 @@
+{
+ "guid": "payment#1234",
+ "id": "WoE46gSLkJQS48RJEiNw3L",
+ "invoice": "Hpqc63wvE1ZjzeeH4kEycF",
+ "reference": "Test refund",
+ "status": "created",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 0.000594,
+ "transactionRefundFee": 0.000002,
+ "currency": "USD",
+ "lastRefundNotification": "2021-08-29T20:45:35.368Z",
+ "refundFee": 0.04,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2021-08-29T20:45:34.000Z"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/badResponse.json b/test/unit/BitPaySDK/jsonResponse/badResponse.json
new file mode 100644
index 00000000..fe3a0735
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/badResponse.json
@@ -0,0 +1 @@
+NULL
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/cancelPayoutGroupResponse.json b/test/unit/BitPaySDK/jsonResponse/cancelPayoutGroupResponse.json
new file mode 100644
index 00000000..846e9419
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/cancelPayoutGroupResponse.json
@@ -0,0 +1,46 @@
+{
+ "cancelled": [
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "2tRxwvX5JkVbhqBLGyanmF",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "cancelled",
+ "transactions": []
+ },
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "2tRxwvX5JkVbhqBLGyanmF",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 20,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe 2",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "cancelled",
+ "transactions": []
+ }
+ ],
+ "failed": [
+ {
+ "errMessage": "PayoutId is missing or invalid",
+ "payoutId": "D8tgWzn1psUua4NYWW1vYo"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/createBillResponse.json b/test/unit/BitPaySDK/jsonResponse/createBillResponse.json
new file mode 100644
index 00000000..306136e3
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/createBillResponse.json
@@ -0,0 +1,29 @@
+{
+ "status": "draft",
+ "url": "https://bitpay.com/bill?id=X6KJbe9RxAGWNReCwd1xRw&resource=bills",
+ "number": "bill1234-ABCD",
+ "createdDate": "2021-05-21T09:48:02.373Z",
+ "dueDate": "2021-05-31T00:00:00.000Z",
+ "currency": "USD",
+ "email": "john@doe.com",
+ "cc": [
+ "jane@doe.com"
+ ],
+ "passProcessingFee": true,
+ "id": "X6KJbe9RxAGWNReCwd1xRw",
+ "items": [
+ {
+ "id": "EL4vx41Nxc5RYhbqDthjE",
+ "description": "Test Item 1",
+ "price": 6,
+ "quantity": 1
+ },
+ {
+ "id": "6spPADZ2h6MfADvnhfsuBt",
+ "description": "Test Item 2",
+ "price": 4,
+ "quantity": 1
+ }
+ ],
+ "token": "qVVgRARN6fKtNZ7Tcq6qpoPBBE3NxdrmdMD883RyMK4Pf8EHENKVxCXhRwyynWveo"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/createInvoiceResponse.json b/test/unit/BitPaySDK/jsonResponse/createInvoiceResponse.json
new file mode 100644
index 00000000..7eca8347
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/createInvoiceResponse.json
@@ -0,0 +1,418 @@
+{
+ "url": "https://test.bitpay.com/invoice?id=UZjwcYkWAKfTMn9J1yyfs4",
+ "status": "new",
+ "price": 12,
+ "currency": "USD",
+ "itemDesc": "Example",
+ "orderId": "084a86b6-68aa-47bc-b435-e64d122391d1",
+ "invoiceTime": 1668432675975,
+ "rateRefreshTime": 1668432675975,
+ "expirationTime": 1668433575975,
+ "currentTime": 1668432734661,
+ "guid": "chc9kj52-04g0-4b6f-941d-3a844e352758",
+ "id": "UZjwcYkWAKfTMn9J1yyfs4",
+ "lowFeeDetected": false,
+ "amountPaid": 0,
+ "displayAmountPaid": "0",
+ "exceptionStatus": false,
+ "targetConfirmations": 6,
+ "guaranteedPaymentTargetConfirmations": 6,
+ "transactions": [],
+ "transactionSpeed": "medium",
+ "buyer": {
+ "name": "Marcin",
+ "address1": "street",
+ "address2": "911",
+ "locality": "Washington",
+ "region": "District of Columbia",
+ "postalCode": "20000",
+ "country": "USA",
+ "email": "satoshi@buyeremaildomain.com",
+ "notify": true
+ },
+ "autoRedirect": true,
+ "refundAddresses": [],
+ "refundAddressRequestPending": false,
+ "buyerProvidedEmail": "satoshi@buyeremaildomain.com",
+ "buyerProvidedInfo": {
+ "name": "Marcin",
+ "selectedWallet": "bitpay",
+ "emailAddress": "satoshi@buyeremaildomain.com"
+ },
+ "paymentSubtotals": {
+ "BTC": 70100,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentTotals": {
+ "BTC": 70200,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentDisplayTotals": {
+ "BTC": "0.000702",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "paymentDisplaySubTotals": {
+ "BTC": "0.000701",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "exchangeRates": {
+ "BTC": {
+ "USD": 17120.09,
+ "BCH": 163.84429131974352,
+ "ETH": 13.299739755292292,
+ "GUSD": 17120.09,
+ "PAX": 17120.09,
+ "BUSD": 17120.09,
+ "USDC": 17120.09,
+ "DOGE": 188443.27083844703,
+ "LTC": 289.92531752751904,
+ "MATIC": 17878.1223893066,
+ "USDC_m": 17120.09
+ },
+ "BCH": {
+ "USD": 104.38999999999999,
+ "BTC": 0.006097902914889888,
+ "ETH": 0.08109535832200428,
+ "GUSD": 104.38999999999999,
+ "PAX": 104.38999999999999,
+ "BUSD": 104.38999999999999,
+ "USDC": 104.38999999999999,
+ "DOGE": 1149.0356092068141,
+ "LTC": 1.7678238780694326,
+ "MATIC": 109.01211361737676,
+ "USDC_m": 104.38999999999999
+ },
+ "ETH": {
+ "USD": 1286.54,
+ "BTC": 0.07515275424966411,
+ "BCH": 12.312565795769931,
+ "GUSD": 1286.54,
+ "PAX": 1286.54,
+ "BUSD": 1286.54,
+ "USDC": 1286.54,
+ "DOGE": 14161.129156709787,
+ "LTC": 21.787298899237936,
+ "MATIC": 1343.5045948203842,
+ "USDC_m": 1286.54
+ },
+ "GUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "PAX": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "BUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "USDC": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "DOGE": {
+ "USD": 0.09077389999999999,
+ "BTC": 5.302523511887377E-6,
+ "BCH": 8.687328930998182E-4,
+ "ETH": 7.051769275587492E-5,
+ "GUSD": 0.09077389999999999,
+ "PAX": 0.09077389999999999,
+ "BUSD": 0.09077389999999999,
+ "USDC": 0.09077389999999999,
+ "LTC": 0.0015372379339542762,
+ "MATIC": 0.09479312865497075,
+ "USDC_m": 0.09077389999999999
+ },
+ "LTC": {
+ "USD": 59.02,
+ "BTC": 0.0034476312868742336,
+ "BCH": 0.5648387405493349,
+ "ETH": 0.04584967954942708,
+ "GUSD": 59.02,
+ "PAX": 59.02,
+ "BUSD": 59.02,
+ "USDC": 59.02,
+ "DOGE": 649.6415524033546,
+ "MATIC": 61.63324979114453,
+ "USDC_m": 59.02
+ },
+ "MATIC": {
+ "USD": 0.9597999999999999,
+ "BTC": 5.6066359016297676E-5,
+ "BCH": 0.009185567996937507,
+ "ETH": 7.456205088366673E-4,
+ "GUSD": 0.9597999999999999,
+ "PAX": 0.9597999999999999,
+ "BUSD": 0.9597999999999999,
+ "USDC": 0.9597999999999999,
+ "DOGE": 10.564655404892232,
+ "LTC": 0.016254022015241322,
+ "USDC_m": 0.9597999999999999
+ },
+ "USDC_m": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336
+ }
+ },
+ "minerFees": {
+ "BTC": {
+ "satoshisPerByte": 1,
+ "totalFee": 100,
+ "fiatAmount": 0.02
+ },
+ "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": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "LTC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "MATIC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "USDC_m": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ }
+ },
+ "shopper": {},
+ "jsonPayProRequired": false,
+ "merchantName": "SUMO Heavy Industries LLC",
+ "bitpayIdRequired": false,
+ "itemizedDetails": [
+ {
+ "amount": 5,
+ "description": "Item 1",
+ "isFee": false
+ },
+ {
+ "amount": 15,
+ "description": "Item 2",
+ "isFee": false
+ }
+ ],
+ "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
+ },
+ "DOGE": {
+ "enabled": true
+ },
+ "LTC": {
+ "enabled": true
+ },
+ "APE": {
+ "enabled": false
+ },
+ "EUROC": {
+ "enabled": false
+ },
+ "MATIC": {
+ "enabled": true
+ },
+ "MATIC_e": {
+ "enabled": false
+ },
+ "ETH_m": {
+ "enabled": false
+ },
+ "USDC_m": {
+ "enabled": true
+ },
+ "BUSD_m": {
+ "enabled": false
+ },
+ "DAI_m": {
+ "enabled": false
+ },
+ "WBTC_m": {
+ "enabled": false
+ },
+ "SHIB_m": {
+ "enabled": false
+ }
+ },
+ "paymentCodes": {
+ "BTC": {
+ "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BCH": {
+ "BIP72b": "bitcoincash:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "ETH": {
+ "EIP681": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "GUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "PAX": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "DOGE": {
+ "BIP72b": "dogecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "LTC": {
+ "BIP72b": "litecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "MATIC": {
+ "EIP681": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC_m": {
+ "EIP681b": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ }
+ },
+ "universalCodes": {
+ "paymentString": "https://link.test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "token": "kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/createPayoutGroupRequest.json b/test/unit/BitPaySDK/jsonResponse/createPayoutGroupRequest.json
new file mode 100644
index 00000000..bd863870
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/createPayoutGroupRequest.json
@@ -0,0 +1 @@
+{"instructions":[{"amount":10,"currency":"USD","ledgerCurrency":"USD","reference":"payout_20210527","notificationURL":"https:\/\/yournotiticationURL.com\/wed3sa0wx1rz5bg0bv97851eqx","notificationEmail":"merchant@email.com","email":"john@doe.com","recipientId":"LDxRZCGq174SF8AnQpdBPB","shopperId":"7qohDf2zZnQK5Qanj8oyC2"}],"token":"kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/createPayoutGroupResponse.json b/test/unit/BitPaySDK/jsonResponse/createPayoutGroupResponse.json
new file mode 100644
index 00000000..e58ea459
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/createPayoutGroupResponse.json
@@ -0,0 +1,29 @@
+{
+ "created": [
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "accountId": "SJcWZCFq344DL8QnXpdBNM",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "new",
+ "groupId": "SxKRk4MdW8Ae3vsoR6UPQE",
+ "transactions": []
+ }
+ ],
+ "failed": [
+ {
+ "errMessage": "Ledger currency is required",
+ "payee": "john@doe.com"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/createRefundResponse.json b/test/unit/BitPaySDK/jsonResponse/createRefundResponse.json
new file mode 100644
index 00000000..4f93e7a6
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/createRefundResponse.json
@@ -0,0 +1,16 @@
+{
+ "guid":"37bd36bd-6fcb-409c-a907-47f9244302aa",
+ "id": "Eso8srxKJR5U71ahCspAAA",
+ "invoice": "UZjwcYkWAKfTMn9J1yyfs4",
+ "reference": "someReference",
+ "status": "preview",
+ "amount": 10,
+ "transactionCurrency": "BTC",
+ "transactionAmount": 7.19E-4,
+ "transactionRefundFee": 2.0E-6,
+ "currency": "USD",
+ "refundFee": 0.03,
+ "immediate": false,
+ "buyerPaysRefundFee": false,
+ "requestDate": "2022-11-14T12:20:47.000Z"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/false.json b/test/unit/BitPaySDK/jsonResponse/false.json
new file mode 100644
index 00000000..6134c595
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/false.json
@@ -0,0 +1,5 @@
+{
+ "status": "false",
+ "data": {},
+ "message": null
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getBill.json b/test/unit/BitPaySDK/jsonResponse/getBill.json
new file mode 100644
index 00000000..52b473b1
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getBill.json
@@ -0,0 +1,39 @@
+{
+ "status": "draft",
+ "url": "https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills",
+ "number": "bill1234-EFGH",
+ "createdDate": "2021-05-21T09:51:04.126Z",
+ "dueDate": "2021-05-31T00:00:00.000Z",
+ "currency": "USD",
+ "name": "John Doe",
+ "address1": "2630 Hegal Place",
+ "address2": "Apt 42",
+ "city": "Alexandria",
+ "state": "VA",
+ "zip": "23242",
+ "country": "US",
+ "email": "john@doe.com",
+ "cc": [
+ "jane@doe.com"
+ ],
+ "phone": "555-123-456",
+ "passProcessingFee": true,
+ "emailBill": true,
+ "id": "X6KJbe9RxAGWNReCwd1xRw",
+ "merchant": "7HyKWn3d4xdhAMQYAEVxVq",
+ "items": [
+ {
+ "id": "NV35GRWtrdB2cmGEjY4LKY",
+ "description": "Test Item 1",
+ "price": 6,
+ "quantity": 1
+ },
+ {
+ "id": "Apy3i2TpzHRYP8tJCkrZMT",
+ "description": "Test Item 2",
+ "price": 4,
+ "quantity": 1
+ }
+ ],
+ "token": "6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getBills.json b/test/unit/BitPaySDK/jsonResponse/getBills.json
new file mode 100644
index 00000000..72146262
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getBills.json
@@ -0,0 +1,80 @@
+[
+ {
+ "status": "draft",
+ "url": "https://bitpay.com/bill?id=X6KJbe9RxAGWNReCwd1xRw&resource=bills",
+ "number": "bill1234-ABCD",
+ "createdDate": "2021-05-21T09:48:02.373Z",
+ "dueDate": "2021-05-31T00:00:00.000Z",
+ "currency": "USD",
+ "name": "John Doe",
+ "address1": "2630 Hegal Place",
+ "address2": "Apt 42",
+ "city": "Alexandria",
+ "state": "VA",
+ "zip": "23242",
+ "country": "US",
+ "email": "john@doe.com",
+ "cc": [
+ "jane@doe.com"
+ ],
+ "phone": "555-123-456",
+ "passProcessingFee": true,
+ "emailBill": true,
+ "id": "X6KJbe9RxAGWNReCwd1xRw",
+ "merchant": "7HyKWn3d4xdhAMQYAEVxVq",
+ "items": [
+ {
+ "id": "EL4vx41Nxc5RYhbqDthjE",
+ "description": "Test Item 1",
+ "price": 6,
+ "quantity": 1
+ },
+ {
+ "id": "6spPADZ2h6MfADvnhfsuBt",
+ "description": "Test Item 2",
+ "price": 4,
+ "quantity": 1
+ }
+ ],
+ "token": "6EBQR37MgDJPfEiLY3jtRqBMYLg8XSDqhp2kp7VSDqCMHGHnsw4bqnnwQmtehzCvSo"
+ },
+ {
+ "status": "draft",
+ "url": "https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills",
+ "number": "bill1234-EFGH",
+ "createdDate": "2021-05-21T09:51:04.126Z",
+ "dueDate": "2021-05-31T00:00:00.000Z",
+ "currency": "USD",
+ "name": "John Doe",
+ "address1": "2630 Hegal Place",
+ "address2": "Apt 42",
+ "city": "Alexandria",
+ "state": "VA",
+ "zip": "23242",
+ "country": "US",
+ "email": "john@doe.com",
+ "cc": [
+ "jane@doe.com"
+ ],
+ "phone": "555-123-456",
+ "passProcessingFee": true,
+ "emailBill": true,
+ "id": "3Zpmji8bRKxWJo2NJbWX5H",
+ "merchant": "7HyKWn3d4xdhAMQYAEVxVq",
+ "items": [
+ {
+ "id": "NV35GRWtrdB2cmGEjY4LKY",
+ "description": "Test Item 1",
+ "price": 6,
+ "quantity": 1
+ },
+ {
+ "id": "Apy3i2TpzHRYP8tJCkrZMT",
+ "description": "Test Item 2",
+ "price": 4,
+ "quantity": 1
+ }
+ ],
+ "token": "6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getCurrencyPairRate.json b/test/unit/BitPaySDK/jsonResponse/getCurrencyPairRate.json
new file mode 100644
index 00000000..a68cf049
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getCurrencyPairRate.json
@@ -0,0 +1,5 @@
+{
+ "name":"US Dollar",
+ "code":"USD",
+ "rate":41154.05
+}
diff --git a/test/unit/BitPaySDK/jsonResponse/getCurrencyRates.json b/test/unit/BitPaySDK/jsonResponse/getCurrencyRates.json
new file mode 100644
index 00000000..8f387e1a
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getCurrencyRates.json
@@ -0,0 +1,47 @@
+[
+ {
+ "code":"BTC",
+ "name":"Bitcoin",
+ "rate":1
+ },
+ {
+ "code":"BCH",
+ "name":"Bitcoin Cash",
+ "rate":50.77
+ },
+ {
+ "code":"USD",
+ "name":"US Dollar",
+ "rate":41248.11
+ },
+ {
+ "code":"EUR",
+ "name":"Eurozone Euro",
+ "rate":33823.04
+ },
+ {
+ "code":"GBP",
+ "name":"Pound Sterling",
+ "rate":29011.49
+ },
+ {
+ "code":"JPY",
+ "name":"Japanese Yen",
+ "rate":4482741
+ },
+ {
+ "code":"CAD",
+ "name":"Canadian Dollar",
+ "rate":49670.85
+ },
+ {
+ "code":"AUD",
+ "name":"Australian Dollar",
+ "rate":53031.99
+ },
+ {
+ "code":"CNY",
+ "name":"Chinese Yuan",
+ "rate":265266.57
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getInvoice.json b/test/unit/BitPaySDK/jsonResponse/getInvoice.json
new file mode 100644
index 00000000..85bac7d9
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getInvoice.json
@@ -0,0 +1,407 @@
+{
+ "url": "https://test.bitpay.com/invoice?id=UZjwcYkWAKfTMn9J1yyfs4",
+ "status": "new",
+ "price": 12,
+ "currency": "USD",
+ "itemDesc": "Example",
+ "orderId": "084a86b6-68aa-47bc-b435-e64d122391d1",
+ "invoiceTime": 1668432675975,
+ "rateRefreshTime": 1668432675975,
+ "expirationTime": 1668433575975,
+ "currentTime": 1668432734661,
+ "guid": "chc9kj52-04g0-4b6f-941d-3a844e352758",
+ "id": "UZjwcYkWAKfTMn9J1yyfs4",
+ "lowFeeDetected": false,
+ "amountPaid": 0,
+ "displayAmountPaid": "0",
+ "exceptionStatus": false,
+ "targetConfirmations": 6,
+ "guaranteedPaymentTargetConfirmations": 6,
+ "transactions": [],
+ "transactionSpeed": "medium",
+ "buyer": {
+ "name": "Marcin",
+ "address1": "street",
+ "address2": "911",
+ "locality": "Washington",
+ "region": "District of Columbia",
+ "postalCode": "20000",
+ "country": "USA",
+ "email": "satoshi@buyeremaildomain.com",
+ "notify": true
+ },
+ "autoRedirect": true,
+ "refundAddresses": [],
+ "refundAddressRequestPending": false,
+ "buyerProvidedEmail": "satoshi@buyeremaildomain.com",
+ "buyerProvidedInfo": {
+ "name": "Marcin",
+ "selectedWallet": "bitpay",
+ "emailAddress": "satoshi@buyeremaildomain.com"
+ },
+ "paymentSubtotals": {
+ "BTC": 70100,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentTotals": {
+ "BTC": 70200,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentDisplayTotals": {
+ "BTC": "0.000702",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "paymentDisplaySubTotals": {
+ "BTC": "0.000701",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "exchangeRates": {
+ "BTC": {
+ "USD": 17120.09,
+ "BCH": 163.84429131974352,
+ "ETH": 13.299739755292292,
+ "GUSD": 17120.09,
+ "PAX": 17120.09,
+ "BUSD": 17120.09,
+ "USDC": 17120.09,
+ "DOGE": 188443.27083844703,
+ "LTC": 289.92531752751904,
+ "MATIC": 17878.1223893066,
+ "USDC_m": 17120.09
+ },
+ "BCH": {
+ "USD": 104.38999999999999,
+ "BTC": 0.006097902914889888,
+ "ETH": 0.08109535832200428,
+ "GUSD": 104.38999999999999,
+ "PAX": 104.38999999999999,
+ "BUSD": 104.38999999999999,
+ "USDC": 104.38999999999999,
+ "DOGE": 1149.0356092068141,
+ "LTC": 1.7678238780694326,
+ "MATIC": 109.01211361737676,
+ "USDC_m": 104.38999999999999
+ },
+ "ETH": {
+ "USD": 1286.54,
+ "BTC": 0.07515275424966411,
+ "BCH": 12.312565795769931,
+ "GUSD": 1286.54,
+ "PAX": 1286.54,
+ "BUSD": 1286.54,
+ "USDC": 1286.54,
+ "DOGE": 14161.129156709787,
+ "LTC": 21.787298899237936,
+ "MATIC": 1343.5045948203842,
+ "USDC_m": 1286.54
+ },
+ "GUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "PAX": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "BUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "USDC": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "DOGE": {
+ "USD": 0.09077389999999999,
+ "BTC": 5.302523511887377E-6,
+ "BCH": 8.687328930998182E-4,
+ "ETH": 7.051769275587492E-5,
+ "GUSD": 0.09077389999999999,
+ "PAX": 0.09077389999999999,
+ "BUSD": 0.09077389999999999,
+ "USDC": 0.09077389999999999,
+ "LTC": 0.0015372379339542762,
+ "MATIC": 0.09479312865497075,
+ "USDC_m": 0.09077389999999999
+ },
+ "LTC": {
+ "USD": 59.02,
+ "BTC": 0.0034476312868742336,
+ "BCH": 0.5648387405493349,
+ "ETH": 0.04584967954942708,
+ "GUSD": 59.02,
+ "PAX": 59.02,
+ "BUSD": 59.02,
+ "USDC": 59.02,
+ "DOGE": 649.6415524033546,
+ "MATIC": 61.63324979114453,
+ "USDC_m": 59.02
+ },
+ "MATIC": {
+ "USD": 0.9597999999999999,
+ "BTC": 5.6066359016297676E-5,
+ "BCH": 0.009185567996937507,
+ "ETH": 7.456205088366673E-4,
+ "GUSD": 0.9597999999999999,
+ "PAX": 0.9597999999999999,
+ "BUSD": 0.9597999999999999,
+ "USDC": 0.9597999999999999,
+ "DOGE": 10.564655404892232,
+ "LTC": 0.016254022015241322,
+ "USDC_m": 0.9597999999999999
+ },
+ "USDC_m": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336
+ }
+ },
+ "minerFees": {
+ "BTC": {
+ "satoshisPerByte": 1,
+ "totalFee": 100,
+ "fiatAmount": 0.02
+ },
+ "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": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "LTC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "MATIC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "USDC_m": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ }
+ },
+ "shopper": {},
+ "jsonPayProRequired": false,
+ "merchantName": "SUMO Heavy Industries 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
+ },
+ "DOGE": {
+ "enabled": true
+ },
+ "LTC": {
+ "enabled": true
+ },
+ "APE": {
+ "enabled": false
+ },
+ "EUROC": {
+ "enabled": false
+ },
+ "MATIC": {
+ "enabled": true
+ },
+ "MATIC_e": {
+ "enabled": false
+ },
+ "ETH_m": {
+ "enabled": false
+ },
+ "USDC_m": {
+ "enabled": true
+ },
+ "BUSD_m": {
+ "enabled": false
+ },
+ "DAI_m": {
+ "enabled": false
+ },
+ "WBTC_m": {
+ "enabled": false
+ },
+ "SHIB_m": {
+ "enabled": false
+ }
+ },
+ "paymentCodes": {
+ "BTC": {
+ "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BCH": {
+ "BIP72b": "bitcoincash:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "ETH": {
+ "EIP681": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "GUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "PAX": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "DOGE": {
+ "BIP72b": "dogecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "LTC": {
+ "BIP72b": "litecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "MATIC": {
+ "EIP681": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC_m": {
+ "EIP681b": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ }
+ },
+ "universalCodes": {
+ "paymentString": "https://link.test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "token": "kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getInvoices.json b/test/unit/BitPaySDK/jsonResponse/getInvoices.json
new file mode 100644
index 00000000..29668919
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getInvoices.json
@@ -0,0 +1,409 @@
+[
+ {
+ "url": "https://test.bitpay.com/invoice?id=UZjwcYkWAKfTMn9J1yyfs4",
+ "status": "new",
+ "price": 12,
+ "currency": "USD",
+ "itemDesc": "Example",
+ "orderId": "084a86b6-68aa-47bc-b435-e64d122391d1",
+ "invoiceTime": 1668432675975,
+ "rateRefreshTime": 1668432675975,
+ "expirationTime": 1668433575975,
+ "currentTime": 1668432734661,
+ "guid": "chc9kj52-04g0-4b6f-941d-3a844e352758",
+ "id": "UZjwcYkWAKfTMn9J1yyfs4",
+ "lowFeeDetected": false,
+ "amountPaid": 0,
+ "displayAmountPaid": "0",
+ "exceptionStatus": false,
+ "targetConfirmations": 6,
+ "guaranteedPaymentTargetConfirmations": 6,
+ "transactions": [],
+ "transactionSpeed": "medium",
+ "buyer": {
+ "name": "Marcin",
+ "address1": "street",
+ "address2": "911",
+ "locality": "Washington",
+ "region": "District of Columbia",
+ "postalCode": "20000",
+ "country": "USA",
+ "email": "satoshi@buyeremaildomain.com",
+ "notify": true
+ },
+ "autoRedirect": true,
+ "refundAddresses": [],
+ "refundAddressRequestPending": false,
+ "buyerProvidedEmail": "satoshi@buyeremaildomain.com",
+ "buyerProvidedInfo": {
+ "name": "Marcin",
+ "selectedWallet": "bitpay",
+ "emailAddress": "satoshi@buyeremaildomain.com"
+ },
+ "paymentSubtotals": {
+ "BTC": 70100,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentTotals": {
+ "BTC": 70200,
+ "BCH": 11495400,
+ "ETH": 9327000000000000,
+ "GUSD": 1200,
+ "PAX": 12000000000000000000,
+ "BUSD": 12000000000000000000,
+ "USDC": 12000000,
+ "DOGE": 13219659000,
+ "LTC": 20332100,
+ "MATIC": 12502605000000000000,
+ "USDC_m": 12000000
+ },
+ "paymentDisplayTotals": {
+ "BTC": "0.000702",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "paymentDisplaySubTotals": {
+ "BTC": "0.000701",
+ "BCH": "0.114954",
+ "ETH": "0.009327",
+ "GUSD": "12.00",
+ "PAX": "12.00",
+ "BUSD": "12.00",
+ "USDC": "12.00",
+ "DOGE": "132.196590",
+ "LTC": "0.203321",
+ "MATIC": "12.502605",
+ "USDC_m": "12.00"
+ },
+ "exchangeRates": {
+ "BTC": {
+ "USD": 17120.09,
+ "BCH": 163.84429131974352,
+ "ETH": 13.299739755292292,
+ "GUSD": 17120.09,
+ "PAX": 17120.09,
+ "BUSD": 17120.09,
+ "USDC": 17120.09,
+ "DOGE": 188443.27083844703,
+ "LTC": 289.92531752751904,
+ "MATIC": 17878.1223893066,
+ "USDC_m": 17120.09
+ },
+ "BCH": {
+ "USD": 104.38999999999999,
+ "BTC": 0.006097902914889888,
+ "ETH": 0.08109535832200428,
+ "GUSD": 104.38999999999999,
+ "PAX": 104.38999999999999,
+ "BUSD": 104.38999999999999,
+ "USDC": 104.38999999999999,
+ "DOGE": 1149.0356092068141,
+ "LTC": 1.7678238780694326,
+ "MATIC": 109.01211361737676,
+ "USDC_m": 104.38999999999999
+ },
+ "ETH": {
+ "USD": 1286.54,
+ "BTC": 0.07515275424966411,
+ "BCH": 12.312565795769931,
+ "GUSD": 1286.54,
+ "PAX": 1286.54,
+ "BUSD": 1286.54,
+ "USDC": 1286.54,
+ "DOGE": 14161.129156709787,
+ "LTC": 21.787298899237936,
+ "MATIC": 1343.5045948203842,
+ "USDC_m": 1286.54
+ },
+ "GUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "PAX": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "BUSD": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "USDC": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336,
+ "USDC_m": 1
+ },
+ "DOGE": {
+ "USD": 0.09077389999999999,
+ "BTC": 5.302523511887377E-6,
+ "BCH": 8.687328930998182E-4,
+ "ETH": 7.051769275587492E-5,
+ "GUSD": 0.09077389999999999,
+ "PAX": 0.09077389999999999,
+ "BUSD": 0.09077389999999999,
+ "USDC": 0.09077389999999999,
+ "LTC": 0.0015372379339542762,
+ "MATIC": 0.09479312865497075,
+ "USDC_m": 0.09077389999999999
+ },
+ "LTC": {
+ "USD": 59.02,
+ "BTC": 0.0034476312868742336,
+ "BCH": 0.5648387405493349,
+ "ETH": 0.04584967954942708,
+ "GUSD": 59.02,
+ "PAX": 59.02,
+ "BUSD": 59.02,
+ "USDC": 59.02,
+ "DOGE": 649.6415524033546,
+ "MATIC": 61.63324979114453,
+ "USDC_m": 59.02
+ },
+ "MATIC": {
+ "USD": 0.9597999999999999,
+ "BTC": 5.6066359016297676E-5,
+ "BCH": 0.009185567996937507,
+ "ETH": 7.456205088366673E-4,
+ "GUSD": 0.9597999999999999,
+ "PAX": 0.9597999999999999,
+ "BUSD": 0.9597999999999999,
+ "USDC": 0.9597999999999999,
+ "DOGE": 10.564655404892232,
+ "LTC": 0.016254022015241322,
+ "USDC_m": 0.9597999999999999
+ },
+ "USDC_m": {
+ "USD": 1,
+ "BTC": 5.8414627022606464E-5,
+ "BCH": 0.009570293808019907,
+ "ETH": 7.768498737618955E-4,
+ "GUSD": 1,
+ "PAX": 1,
+ "BUSD": 1,
+ "USDC": 1,
+ "DOGE": 11.007142534790825,
+ "LTC": 0.01693480101608806,
+ "MATIC": 1.0442773600668336
+ }
+ },
+ "minerFees": {
+ "BTC": {
+ "satoshisPerByte": 1,
+ "totalFee": 100,
+ "fiatAmount": 0.02
+ },
+ "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": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "LTC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "MATIC": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ },
+ "USDC_m": {
+ "satoshisPerByte": 0,
+ "totalFee": 0,
+ "fiatAmount": 0
+ }
+ },
+ "shopper": {},
+ "jsonPayProRequired": false,
+ "merchantName": "SUMO Heavy Industries 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
+ },
+ "DOGE": {
+ "enabled": true
+ },
+ "LTC": {
+ "enabled": true
+ },
+ "APE": {
+ "enabled": false
+ },
+ "EUROC": {
+ "enabled": false
+ },
+ "MATIC": {
+ "enabled": true
+ },
+ "MATIC_e": {
+ "enabled": false
+ },
+ "ETH_m": {
+ "enabled": false
+ },
+ "USDC_m": {
+ "enabled": true
+ },
+ "BUSD_m": {
+ "enabled": false
+ },
+ "DAI_m": {
+ "enabled": false
+ },
+ "WBTC_m": {
+ "enabled": false
+ },
+ "SHIB_m": {
+ "enabled": false
+ }
+ },
+ "paymentCodes": {
+ "BTC": {
+ "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BCH": {
+ "BIP72b": "bitcoincash:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "ETH": {
+ "EIP681": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "GUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "PAX": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "BUSD": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC": {
+ "EIP681b": "ethereum:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "DOGE": {
+ "BIP72b": "dogecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "LTC": {
+ "BIP72b": "litecoin:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4",
+ "BIP73": "https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "MATIC": {
+ "EIP681": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "USDC_m": {
+ "EIP681b": "matic:?r=https://test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ }
+ },
+ "universalCodes": {
+ "paymentString": "https://link.test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
+ },
+ "token": "kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getLedgerBalances.json b/test/unit/BitPaySDK/jsonResponse/getLedgerBalances.json
new file mode 100644
index 00000000..22bc6b28
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getLedgerBalances.json
@@ -0,0 +1,14 @@
+[
+ {
+ "currency": "EUR",
+ "amount": 0
+ },
+ {
+ "currency": "USD",
+ "balance": 2389.82
+ },
+ {
+ "currency": "BTC",
+ "balance": 0.000287
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getLedgers.json b/test/unit/BitPaySDK/jsonResponse/getLedgers.json
new file mode 100644
index 00000000..a1f6cea4
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getLedgers.json
@@ -0,0 +1,81 @@
+[
+ {
+ "type": "Invoice",
+ "amount": 823000000,
+ "code": 1000,
+ "description": "20210510_fghij",
+ "timestamp": "2021-05-10T20:08:52.919Z",
+ "txType": "sale",
+ "scale": 100000000,
+ "invoiceId": "Hpqc63wvE1ZjzeeH4kEycF",
+ "buyerFields": {
+ "buyerName": "John Doe",
+ "buyerAddress1": "2630 Hegal Place",
+ "buyerAddress2": "Apt 42",
+ "buyerCity": "Alexandria",
+ "buyerState": "VA",
+ "buyerZip": "23242",
+ "buyerCountry": "US",
+ "buyerPhone": "555-123-456",
+ "buyerNotify": true,
+ "buyerEmail": "john@doe.com"
+ },
+ "invoiceAmount": 10,
+ "invoiceCurrency": "USD",
+ "transactionCurrency": "BCH",
+ "id": "FR4rgfADCRNmAhtz1Ci4kU"
+ },
+ {
+ "type": "Invoice Fee",
+ "amount": -8000000,
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2021-05-10T20:08:52.919Z",
+ "txType": "Invoice Fee",
+ "scale": 100000000,
+ "invoiceId": "Hpqc63wvE1ZjzeeH4kEycF",
+ "buyerFields": {
+ "buyerName": "John Doe",
+ "buyerAddress1": "2630 Hegal Place",
+ "buyerAddress2": "Apt 42",
+ "buyerCity": "Alexandria",
+ "buyerState": "VA",
+ "buyerZip": "23242",
+ "buyerCountry": "US",
+ "buyerPhone": "555-123-456",
+ "buyerNotify": true,
+ "buyerEmail": "john@doe.com"
+ },
+ "invoiceAmount": 10,
+ "invoiceCurrency": "USD",
+ "transactionCurrency": "BCH",
+ "id": "XCkhgHKP2pSme4qszMpM3B"
+ },
+ {
+ "type": "Invoice Refund",
+ "supportRequest": "SYyrnbRCJ78V1DknHakKPo",
+ "amount": -823000000,
+ "code": 1020,
+ "description": "Invoice Refund",
+ "timestamp": "2021-05-12T13:00:45.063Z",
+ "txType": "Invoice Refund",
+ "scale": 100000000,
+ "invoiceId": "Hpqc63wvE1ZjzeeH4kEycF",
+ "buyerFields": {
+ "buyerName": "John Doe",
+ "buyerAddress1": "2630 Hegal Place",
+ "buyerAddress2": "Apt 42",
+ "buyerCity": "Alexandria",
+ "buyerState": "VA",
+ "buyerZip": "23242",
+ "buyerCountry": "US",
+ "buyerPhone": "555-123-456",
+ "buyerNotify": true,
+ "buyerEmail": "john@doe.com"
+ },
+ "invoiceAmount": 10,
+ "invoiceCurrency": "USD",
+ "transactionCurrency": "BCH",
+ "id": "PBqakmWMZ2H3RwhGq9vCsg"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getPayout.json b/test/unit/BitPaySDK/jsonResponse/getPayout.json
new file mode 100644
index 00000000..44257c42
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getPayout.json
@@ -0,0 +1,30 @@
+{
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "exchangeRates": {
+ "BTC": {
+ "USD": 39390.47,
+ "GBP": 27883.962246420004
+ }
+ },
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "complete",
+ "transactions": [
+ {
+ "txid": "db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057",
+ "amount": 0.000254,
+ "date": "2021-05-27T11:04:23.155Z"
+ }
+ ],
+ "token": "kQLZ7C9YKPSnMCC4EJwrqRHXuQkLzL1W8DfZCh37DHb"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getPayoutRecipient.json b/test/unit/BitPaySDK/jsonResponse/getPayoutRecipient.json
new file mode 100644
index 00000000..36c81731
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getPayoutRecipient.json
@@ -0,0 +1,11 @@
+{
+ "facade": "payout/recipient",
+ "data": {
+ "email": "john.smith@email.com",
+ "label": "John Smith",
+ "status": "invited",
+ "id": "JA4cEtmBxCp5cybtnh1rds",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf"
+ }
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getPayoutRecipients.json b/test/unit/BitPaySDK/jsonResponse/getPayoutRecipients.json
new file mode 100644
index 00000000..6d713893
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getPayoutRecipients.json
@@ -0,0 +1,18 @@
+[
+ {
+ "email": "alice@email.com",
+ "label": "Alice",
+ "status": "invited",
+ "id": "JA4cEtmBxCp5cybtnh1rds",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf"
+ },
+ {
+ "email": "bob@email.com",
+ "label": "Bob",
+ "status": "invited",
+ "id": "X3icwc4tE8KJ5hEPNPpDXW",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7"
+ }
+ ]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getPayouts.json b/test/unit/BitPaySDK/jsonResponse/getPayouts.json
new file mode 100644
index 00000000..9b4c2ee7
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getPayouts.json
@@ -0,0 +1,50 @@
+[
+ {
+ "id": "JMwv8wQCXANoU2ZZQ9a9GH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "exchangeRates": {
+ "BTC": {
+ "USD": 39390.47,
+ "GBP": 27883.962246420004
+ }
+ },
+ "email": "john@doe.com",
+ "reference": "payout_20210527",
+ "label": "John Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-27T09:00:00.000Z",
+ "requestDate": "2021-05-27T10:47:37.834Z",
+ "status": "complete",
+ "transactions": [
+ {
+ "txid": "db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057",
+ "amount": 0.000254,
+ "date": "2021-05-27T11:04:23.155Z"
+ }
+ ],
+ "token": "9pVLfvdjt59q1JiY2JEsf2uzeeEpSqDwwfRAzuFr9CcrxZX25rTnP6HdRhsMBGLArz"
+ },
+ {
+ "id": "KMXZeQigXG6T5abzCJmTcH",
+ "recipientId": "LDxRZCGq174SF8AnQpdBPB",
+ "shopperId": "7qohDf2zZnQK5Qanj8oyC2",
+ "amount": 10,
+ "currency": "USD",
+ "ledgerCurrency": "GBP",
+ "email": "jane@doe.com",
+ "reference": "payout_20210528",
+ "label": "Jane Doe",
+ "notificationURL": "https://yournotiticationurl.com/wed3sa0wx1rz5bg0bv97851eqx",
+ "notificationEmail": "merchant@email.com",
+ "effectiveDate": "2021-05-28T09:00:00.000Z",
+ "requestDate": "2021-05-28T10:23:43.765Z",
+ "status": "cancelled",
+ "transactions": [],
+ "token": "9pVLfvdjt59q1JiY2JEsf2hr5FsjimfY4qRLFi85tMiXSCkJ9mQ2oSQqYKVangKaro"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getRates.json b/test/unit/BitPaySDK/jsonResponse/getRates.json
new file mode 100644
index 00000000..8f387e1a
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getRates.json
@@ -0,0 +1,47 @@
+[
+ {
+ "code":"BTC",
+ "name":"Bitcoin",
+ "rate":1
+ },
+ {
+ "code":"BCH",
+ "name":"Bitcoin Cash",
+ "rate":50.77
+ },
+ {
+ "code":"USD",
+ "name":"US Dollar",
+ "rate":41248.11
+ },
+ {
+ "code":"EUR",
+ "name":"Eurozone Euro",
+ "rate":33823.04
+ },
+ {
+ "code":"GBP",
+ "name":"Pound Sterling",
+ "rate":29011.49
+ },
+ {
+ "code":"JPY",
+ "name":"Japanese Yen",
+ "rate":4482741
+ },
+ {
+ "code":"CAD",
+ "name":"Canadian Dollar",
+ "rate":49670.85
+ },
+ {
+ "code":"AUD",
+ "name":"Australian Dollar",
+ "rate":53031.99
+ },
+ {
+ "code":"CNY",
+ "name":"Chinese Yuan",
+ "rate":265266.57
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getSettlementReconciliationReportResponse.json b/test/unit/BitPaySDK/jsonResponse/getSettlementReconciliationReportResponse.json
new file mode 100644
index 00000000..7add237b
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getSettlementReconciliationReportResponse.json
@@ -0,0 +1,445 @@
+{
+ "id": "RvNuCTMAkURKimwgvSVEMP",
+ "accountId": "YJCgTf3jrXHkUVzLQ7y4eg",
+ "status": "processing",
+ "currency": "USD",
+ "payoutInfo": {
+ "label": "Test",
+ "bankCountry": "Netherlands",
+ "bankAddress": "test",
+ "bankAddress2": "test",
+ "bankName": "Test",
+ "iban": "NL85ABNA0000000000",
+ "swift": "RABONL2U",
+ "accountHolderCountry": "United States",
+ "accountHolderCity": "test",
+ "accountHolderPostalCode": "test",
+ "accountHolderAddress": "test",
+ "accountHolderAddress2": "test",
+ "accountHolderName": "test",
+ "wire": true
+ },
+ "dateCreated": "2018-08-23T20:45:22.742Z",
+ "dateExecuted": "2018-08-23T20:47:06.912Z",
+ "openingDate": "2018-08-01T13:00:00.000Z",
+ "closingDate": "2018-08-23T13:00:00.000Z",
+ "openingBalance": 23.13,
+ "ledgerEntriesSum": 2956.77,
+ "withholdings": [
+ {
+ "amount": 590.08,
+ "code": "W005",
+ "description": "Pending Refunds"
+ }
+ ],
+ "withholdingsSum": 590.08,
+ "totalAmount": 2389.82,
+ "ledgerEntries": [
+ {
+ "code": 1000,
+ "description": "Test invoice BCH",
+ "timestamp": "2018-08-01T20:16:03.742Z",
+ "amount": 5.83,
+ "invoiceId": "E1pJQNsHP2oHuMo2fagpe6",
+ "invoiceData": {
+ "orderId": "Test invoice BCH",
+ "date": "2018-08-01T19:24:42.789Z",
+ "price": 5,
+ "currency": "EUR",
+ "transactionCurrency": "BCH",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-01T20:16:03.742Z",
+ "amount": -0.06,
+ "invoiceId": "E1pJQNsHP2oHuMo2fagpe6"
+ },
+ {
+ "code": 1017,
+ "description": "Account Settlement XGJqZmdSGDwi5exXqQusJf",
+ "timestamp": "2018-08-01T20:19:54.394Z",
+ "amount": -23.13
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice BCH",
+ "timestamp": "2018-08-01T20:20:25.258Z",
+ "amount": 5.84,
+ "invoiceId": "PbPTukHvymCZYA8FGDa5wh",
+ "invoiceData": {
+ "orderId": "Test invoice BCH",
+ "date": "2018-08-01T19:37:52.790Z",
+ "price": 5,
+ "currency": "EUR",
+ "transactionCurrency": "BCH",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-01T20:20:25.258Z",
+ "amount": -0.06,
+ "invoiceId": "PbPTukHvymCZYA8FGDa5wh"
+ },
+ {
+ "code": 1000,
+ "description": "Bill 2",
+ "timestamp": "2018-08-02T13:54:16.656Z",
+ "amount": 1010.1,
+ "invoiceId": "GfcuUrvc2TAeCdSzAupbe8",
+ "invoiceData": {
+ "orderId": "Bill 2",
+ "date": "2018-08-02T12:11:15.760Z",
+ "price": 1010.1,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-02T13:54:16.656Z",
+ "amount": -10.1,
+ "invoiceId": "GfcuUrvc2TAeCdSzAupbe8"
+ },
+ {
+ "code": 1000,
+ "description": "Bill 2",
+ "timestamp": "2018-08-02T13:54:16.663Z",
+ "amount": 1010.1,
+ "invoiceId": "C3ak5sJD3k15nxTePgVYBv",
+ "invoiceData": {
+ "orderId": "Bill 2",
+ "date": "2018-08-02T12:01:44.613Z",
+ "price": 1010.1,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-02T13:54:16.663Z",
+ "amount": -10.1,
+ "invoiceId": "C3ak5sJD3k15nxTePgVYBv"
+ },
+ {
+ "code": 1000,
+ "description": "Test bill 1",
+ "timestamp": "2018-08-03T10:15:39.714Z",
+ "amount": 1311.81,
+ "invoiceId": "5Bfnr8eamNCAYjhVYfzJxs",
+ "invoiceData": {
+ "orderId": "Test bill 1",
+ "date": "2018-08-03T09:22:55.518Z",
+ "price": 1010.1,
+ "currency": "GBP",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-03T10:15:39.714Z",
+ "amount": -13.12,
+ "invoiceId": "5Bfnr8eamNCAYjhVYfzJxs"
+ },
+ {
+ "code": 1000,
+ "description": "test bill",
+ "timestamp": "2018-08-06T13:41:58.036Z",
+ "amount": 1010.1,
+ "invoiceId": "RMUkvBHVQnr9wLDHgD646u",
+ "invoiceData": {
+ "orderId": "test bill",
+ "date": "2018-08-06T13:24:43.826Z",
+ "price": 1010.1,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-06T13:41:58.036Z",
+ "amount": -10.1,
+ "invoiceId": "RMUkvBHVQnr9wLDHgD646u"
+ },
+ {
+ "code": 1020,
+ "description": "Invoice Refund",
+ "timestamp": "2018-08-07T08:34:49.842Z",
+ "amount": -1010.1,
+ "invoiceId": "RMUkvBHVQnr9wLDHgD646u",
+ "invoiceData": {
+ "orderId": "test bill",
+ "date": "2018-08-06T13:24:43.826Z",
+ "price": 1010.1,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ },
+ "refundInfo": {
+ "supportRequest": "Cw4dQ1wnEaL11EkfLrBQAC",
+ "currency": "USD",
+ "amounts": {
+ "USD": 1010.1,
+ "BTC": 0.145439
+ }
+ }
+ }
+ },
+ {
+ "code": 1039,
+ "description": "Refund Fee",
+ "timestamp": "2018-08-07T08:34:49.842Z",
+ "amount": -0.92
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice BCH",
+ "timestamp": "2018-08-07T10:06:35.804Z",
+ "amount": 5.8,
+ "invoiceId": "LWgqvm3CH47psfgy83DvLX",
+ "invoiceData": {
+ "orderId": "Test invoice BCH",
+ "date": "2018-08-07T09:14:09.106Z",
+ "price": 5,
+ "currency": "EUR",
+ "transactionCurrency": "BCH",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-07T10:06:35.804Z",
+ "amount": -0.06,
+ "invoiceId": "LWgqvm3CH47psfgy83DvLX"
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice BCH",
+ "timestamp": "2018-08-08T12:52:29.384Z",
+ "amount": 3.43,
+ "invoiceId": "932QfiTCd4ALwaLfqxH5ae",
+ "invoiceData": {
+ "orderId": "Test invoice BCH",
+ "date": "2018-08-08T12:40:00.622Z",
+ "price": 2.96,
+ "currency": "EUR",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-08T12:52:29.384Z",
+ "amount": -0.03,
+ "invoiceId": "932QfiTCd4ALwaLfqxH5ae"
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-09T13:04:49.607Z",
+ "amount": -340.19
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:14:25.311Z",
+ "amount": -1.06
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:15:09.605Z",
+ "amount": -1.33
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:15:18.557Z",
+ "amount": -1.06
+ },
+ {
+ "code": 1034,
+ "description": "PayoutRequest TDZZuBiqnsNnLjaX93ydcb",
+ "timestamp": "2018-08-13T14:17:01.081Z",
+ "amount": -1
+ },
+ {
+ "code": 1040,
+ "description": "Payout Fee",
+ "timestamp": "2018-08-13T14:17:01.081Z",
+ "amount": -0.01
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:17:21.617Z",
+ "amount": -1.11
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:17:30.296Z",
+ "amount": -1.29
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-13T14:29:52.473Z",
+ "amount": -1.09
+ },
+ {
+ "code": 1034,
+ "description": "PayoutRequest BhKWi3WPSoGmCQfvvzfV9B",
+ "timestamp": "2018-08-14T10:34:39.372Z",
+ "amount": -3000
+ },
+ {
+ "code": 1040,
+ "description": "Payout Fee",
+ "timestamp": "2018-08-14T10:34:39.372Z",
+ "amount": -30
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-14T10:34:39.434Z",
+ "amount": 69.78
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice",
+ "timestamp": "2018-08-14T11:13:38.374Z",
+ "amount": 582.49,
+ "invoiceId": "WxY7d2qUzJawZTTqpXUHov",
+ "invoiceData": {
+ "orderId": "Test invoice",
+ "date": "2018-08-14T10:32:11.015Z",
+ "price": 1000,
+ "currency": "BGN",
+ "transactionCurrency": "BCH",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-14T11:13:38.374Z",
+ "amount": -5.82,
+ "invoiceId": "WxY7d2qUzJawZTTqpXUHov"
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice",
+ "timestamp": "2018-08-14T11:22:12.577Z",
+ "amount": 3000,
+ "invoiceId": "76ZQGxLuKwKJ5vBMvjdAbh",
+ "invoiceData": {
+ "orderId": "Test invoice",
+ "date": "2018-08-14T10:37:06.348Z",
+ "price": 3000,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-14T11:22:12.577Z",
+ "amount": -30,
+ "invoiceId": "76ZQGxLuKwKJ5vBMvjdAbh"
+ },
+ {
+ "code": 1034,
+ "description": "PayoutRequest NkdbgovhHE8CED1ogUJ9Yg",
+ "timestamp": "2018-08-14T11:45:08.017Z",
+ "amount": -4502
+ },
+ {
+ "code": 1040,
+ "description": "Payout Fee",
+ "timestamp": "2018-08-14T11:45:08.017Z",
+ "amount": -45.02
+ },
+ {
+ "code": 1011,
+ "timestamp": "2018-08-14T11:45:08.073Z",
+ "amount": 1000.35
+ },
+ {
+ "code": 1000,
+ "description": "Test invoice",
+ "timestamp": "2018-08-14T13:10:18.890Z",
+ "amount": 3000,
+ "invoiceId": "RSPnAH9L5yDWUFNYTGDJmi",
+ "invoiceData": {
+ "orderId": "Test invoice",
+ "date": "2018-08-14T11:58:30.028Z",
+ "price": 3000,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-14T13:10:18.890Z",
+ "amount": -30,
+ "invoiceId": "RSPnAH9L5yDWUFNYTGDJmi"
+ },
+ {
+ "code": 1000,
+ "description": "Iphone-Order 1",
+ "timestamp": "2018-08-16T13:32:23.205Z",
+ "amount": 10,
+ "invoiceId": "WwCouQindnn6TYW9PvRMSU",
+ "invoiceData": {
+ "orderId": "Iphone-Order 1",
+ "date": "2018-08-16T12:01:32.513Z",
+ "price": 10,
+ "currency": "USD",
+ "transactionCurrency": "BTC",
+ "payoutPercentage": {
+ "USD": 100
+ }
+ }
+ },
+ {
+ "code": 1023,
+ "description": "Invoice Fee",
+ "timestamp": "2018-08-16T13:32:23.205Z",
+ "amount": -0.1,
+ "invoiceId": "WwCouQindnn6TYW9PvRMSU"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getSettlementResponse.json b/test/unit/BitPaySDK/jsonResponse/getSettlementResponse.json
new file mode 100644
index 00000000..ef189604
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getSettlementResponse.json
@@ -0,0 +1,30 @@
+{
+ "id": "RPWTabW8urd3xWv2To989v",
+ "accountId": "YJCgTf3jrXHkUVzLQ7y4eg",
+ "status": "processing",
+ "currency": "EUR",
+ "payoutInfo": {
+ "label": "Corporate account",
+ "bankCountry": "Netherlands",
+ "name": "Test Organization",
+ "bank": "Test",
+ "swift": "RABONL2U",
+ "account": "NL85ABNA0000000000"
+ },
+ "dateCreated": "2021-05-11T09:05:00.176Z",
+ "dateExecuted": "2021-05-11T11:52:29.681Z",
+ "openingDate": "2021-05-10T09:00:00.000Z",
+ "closingDate": "2021-05-11T09:00:00.000Z",
+ "openingBalance": 23.27,
+ "ledgerEntriesSum": 20.82,
+ "withholdings": [
+ {
+ "amount": 8.21,
+ "code": "W005",
+ "description": "Pending Refunds"
+ }
+ ],
+ "withholdingsSum": 8.21,
+ "totalAmount": 35.88,
+ "token": "2GrR6GDeYxUFYM9sDKViy6nFFTy4Rjvm1SYdLBjK46jkeJdgUTRccRfhtwkhNcuZky"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getSettlementsResponse.json b/test/unit/BitPaySDK/jsonResponse/getSettlementsResponse.json
new file mode 100644
index 00000000..ba4e39d7
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getSettlementsResponse.json
@@ -0,0 +1,56 @@
+[
+ {
+ "id": "KBkdURgmE3Lsy9VTnavZHX",
+ "accountId": "YJCgTf3jrXHkUVzLQ7y4eg",
+ "status": "processing",
+ "currency": "EUR",
+ "payoutInfo": {
+ "label": "Corporate account",
+ "bankCountry": "Netherlands",
+ "name": "Test Organization",
+ "bank": "Test",
+ "swift": "RABONL2U",
+ "account": "NL85ABNA0000000000"
+ },
+ "dateCreated": "2021-05-10T09:05:00.176Z",
+ "dateExecuted": "2021-05-10T11:52:29.681Z",
+ "openingDate": "2021-05-09T09:00:00.000Z",
+ "closingDate": "2021-05-10T09:00:00.000Z",
+ "openingBalance": 1.27,
+ "ledgerEntriesSum": 20.82,
+ "withholdings": [],
+ "withholdingsSum": 0,
+ "totalAmount": 22.09,
+ "token": "2gBtViSiBWSEJGo1LfaMFHoaBRzE2jek2VitKAYeenj2SRiTVSCgRvs1WTN8w4w8Lc"
+ },
+ {
+ "id": "RPWTabW8urd3xWv2To989v",
+ "accountId": "YJCgTf3jrXHkUVzLQ7y4eg",
+ "status": "processing",
+ "currency": "EUR",
+ "payoutInfo": {
+ "label": "Corporate account",
+ "bankCountry": "Netherlands",
+ "name": "Test Organization",
+ "bank": "Test",
+ "swift": "RABONL2U",
+ "account": "NL85ABNA0000000000"
+ },
+ "dateCreated": "2021-05-11T09:05:00.176Z",
+ "dateExecuted": "2021-05-11T11:52:29.681Z",
+ "openingDate": "2021-05-10T09:00:00.000Z",
+ "closingDate": "2021-05-11T09:00:00.000Z",
+ "openingBalance": 23.27,
+ "ledgerEntriesSum": 20.82,
+ "withholdings": [
+ {
+ "amount": 8.21,
+ "code": "W005",
+ "description": "Pending Refunds"
+ }
+ ],
+ "withholdingsSum": 8.21,
+ "totalAmount": 35.88,
+ "token": "2gBtViSiBWSEJitKAYSCgRvs1WTN8w4Go1Leenj2SRiTVFHoaBRzE2jek2VfaMw8Lc"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getSupportedWalletsResponse.json b/test/unit/BitPaySDK/jsonResponse/getSupportedWalletsResponse.json
new file mode 100644
index 00000000..d5cdae03
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getSupportedWalletsResponse.json
@@ -0,0 +1,385 @@
+[
+ {
+ "key": "bitpay",
+ "displayName": "BitPay",
+ "avatar": "bitpay-wallet.png",
+ "payPro": true,
+ "currencies": [
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BCH",
+ "image": "https://bitpay.com/img/icon/currencies/BCH.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "XRP",
+ "image": "https://bitpay.com/img/icon/currencies/XRP.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "DOGE",
+ "image": "https://bitpay.com/img/icon/currencies/DOGE.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681"
+ },
+ "code": "ETH",
+ "image": "https://bitpay.com/img/icon/currencies/ETH.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "USDC",
+ "image": "https://bitpay.com/img/icon/currencies/USDC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "PAX",
+ "image": "https://bitpay.com/img/icon/currencies/PAX.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "GUSD",
+ "image": "https://bitpay.com/img/icon/currencies/GUSD.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "BUSD",
+ "image": "https://bitpay.com/img/icon/currencies/BUSD.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "WBTC",
+ "image": "https://bitpay.com/img/icon/currencies/WBTC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "SHIB",
+ "image": "https://bitpay.com/img/icon/currencies/SHIB.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "DAI",
+ "image": "https://bitpay.com/img/icon/currencies/DAI.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "LTC",
+ "image": "https://bitpay.com/img/icon/currencies/LTC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "APE",
+ "image": "https://bitpay.com/img/icon/currencies/APE.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "EUROC",
+ "image": "https://bitpay.com/img/icon/currencies/EUROC.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/bitpay-wallet.png"
+ },
+ {
+ "key": "copay",
+ "displayName": "Copay",
+ "avatar": "copay-wallet.svg",
+ "payPro": true,
+ "currencies": [
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BCH",
+ "image": "https://bitpay.com/img/icon/currencies/BCH.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "XRP",
+ "image": "https://bitpay.com/img/icon/currencies/XRP.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "DOGE",
+ "image": "https://bitpay.com/img/icon/currencies/DOGE.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681"
+ },
+ "code": "ETH",
+ "image": "https://bitpay.com/img/icon/currencies/ETH.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "USDC",
+ "image": "https://bitpay.com/img/icon/currencies/USDC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "PAX",
+ "image": "https://bitpay.com/img/icon/currencies/PAX.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "GUSD",
+ "image": "https://bitpay.com/img/icon/currencies/GUSD.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "BUSD",
+ "image": "https://bitpay.com/img/icon/currencies/BUSD.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "WBTC",
+ "image": "https://bitpay.com/img/icon/currencies/WBTC.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "SHIB",
+ "image": "https://bitpay.com/img/icon/currencies/SHIB.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "EIP681b"
+ },
+ "code": "DAI",
+ "image": "https://bitpay.com/img/icon/currencies/DAI.svg"
+ },
+ {
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "LTC",
+ "image": "https://bitpay.com/img/icon/currencies/LTC.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/copay-wallet.svg"
+ },
+ {
+ "key": "blockchainWallet",
+ "displayName": "Blockchain Wallet",
+ "avatar": "blockchain-wallet.svg",
+ "payPro": true,
+ "invoiceDefault": "BTC",
+ "uniCode": "bitcoin:?r=https://bitpay.com",
+ "verificationLink": "https://bitpay.com/id/verify",
+ "currencies": [
+ {
+ "payPro": true,
+ "p2p": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ },
+ {
+ "p2p": true,
+ "payPro": true,
+ "qr": {
+ "type": "BIP72b"
+ },
+ "code": "BCH",
+ "image": "https://bitpay.com/img/icon/currencies/BCH.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/blockchain-wallet.svg"
+ },
+ {
+ "key": "squareCash",
+ "displayName": "Cash App",
+ "lightning": true,
+ "avatar": "square-cash-app.svg",
+ "payPro": false,
+ "currencies": [
+ {
+ "p2p": true,
+ "qr": {
+ "type": "ADDRESS"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/square-cash-app.svg"
+ },
+ {
+ "key": "coinbase",
+ "displayName": "Coinbase",
+ "avatar": "coinbase.svg",
+ "offChainMode": true,
+ "payPro": false,
+ "currencies": [
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ },
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "BCH",
+ "image": "https://bitpay.com/img/icon/currencies/BCH.svg"
+ },
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "XRP",
+ "image": "https://bitpay.com/img/icon/currencies/XRP.svg"
+ },
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "DOGE",
+ "image": "https://bitpay.com/img/icon/currencies/DOGE.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/coinbase.svg"
+ },
+ {
+ "key": "gemini",
+ "displayName": "Gemini",
+ "avatar": "gemini.svg",
+ "payPro": false,
+ "currencies": [
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "BTC",
+ "image": "https://bitpay.com/img/icon/currencies/BTC.svg"
+ },
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "BCH",
+ "image": "https://bitpay.com/img/icon/currencies/BCH.svg"
+ },
+ {
+ "p2p": true,
+ "qr": {
+ "collapsed": true,
+ "type": "ADDRESS"
+ },
+ "code": "LTC",
+ "image": "https://bitpay.com/img/icon/currencies/LTC.svg"
+ }
+ ],
+ "image": "https://bitpay.com/img/wallet-logos/gemini.svg"
+ },
+ {
+ "key": "bakkt",
+ "displayName": "Bakkt",
+ "avatar": "bakkt.svg",
+ "uniCode": "bakkt://bitpay",
+ "offChainMode": true,
+ "invoiceDefault": "USD",
+ "payPro": false,
+ "currencies": [],
+ "image": "https://bitpay.com/img/wallet-logos/bakkt.svg"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/getTokensResponse.json b/test/unit/BitPaySDK/jsonResponse/getTokensResponse.json
new file mode 100644
index 00000000..5806d9d9
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/getTokensResponse.json
@@ -0,0 +1,14 @@
+[
+ {
+ "merchant": "someMerchantToken"
+ },
+ {
+ "payout": "somePayoutToken"
+ },
+ {
+ "payout\/recipient": "somePayoutRecipientToken1"
+ },
+ {
+ "payout\/recipient": "somePayoutRecipientToken2"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/payInvoiceResponse.json b/test/unit/BitPaySDK/jsonResponse/payInvoiceResponse.json
new file mode 100644
index 00000000..6879b9f7
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/payInvoiceResponse.json
@@ -0,0 +1 @@
+{"url":"https://test.bitpay.com/invoice?id=4enjVLZH9fUADcAeYRKip3","status":"complete","price":12,"currency":"USD","itemDesc":"Example","orderId":"e81256cb-b115-45e6-9257-607f692635f1","invoiceTime":1668428388468,"rateRefreshTime":1668428388468,"expirationTime":1668429288468,"currentTime":1668428399474,"guid":"7f3b1a02-d6ee-4185-bcd5-838276a598b5","id":"4enjVLZH9fUADcAeYRKip3","lowFeeDetected":false,"amountPaid":72000,"displayAmountPaid":"0.000720","exceptionStatus":false,"targetConfirmations":6,"guaranteedPaymentTargetConfirmations":0,"guaranteedPayment":false,"transactions":[{"amount":72000,"confirmations":6,"receivedTime":"2022-11-14T12:19:59.429Z","txid":"6f84f6662988c33b70cf977f652632b68a3fd3b30705f0903e61f193441da025","exRates":{"BTC":1,"USD":16678.62,"BCH":162.27190686942083,"ETH":13.317964769950652,"GUSD":16678.62,"PAX":16678.62,"BUSD":16678.62,"USDC":16678.62,"DOGE":191235.02412994052,"LTC":290.72023705769567,"MATIC":18099.42485078676,"USDC_m":16678.62}},{"amount":-100,"confirmations":6,"receivedTime":"2022-11-14T12:19:59.439Z","type":"buyerPaidMinerFee","txid":"6f84f6662988c33b70cf977f652632b68a3fd3b30705f0903e61f193441da025"}],"transactionSpeed":"medium","buyer":{"name":"Marcin","address1":"street","address2":"911","locality":"Washington","region":"District of Columbia","postalCode":"20000","country":"USA","email":"satoshi@buyeremaildomain.com","notify":true},"autoRedirect":true,"refundAddresses":[],"refundAddressRequestPending":false,"buyerProvidedEmail":"satoshi@buyeremaildomain.com","buyerProvidedInfo":{"name":"Marcin","selectedWallet":"bitpay","emailAddress":"satoshi@buyeremaildomain.com"},"paymentSubtotals":{"BTC":71900,"BCH":11685700,"ETH":9583000000000000,"GUSD":1200,"PAX":12000000000000000000,"BUSD":12000000000000000000,"USDC":12000000,"DOGE":13762083400,"LTC":20927800,"MATIC":13025073000000000000,"USDC_m":12000000},"paymentTotals":{"BTC":72000,"BCH":11685700,"ETH":9583000000000000,"GUSD":1200,"PAX":12000000000000000000,"BUSD":12000000000000000000,"USDC":12000000,"DOGE":13762083400,"LTC":20927800,"MATIC":13025073000000000000,"USDC_m":12000000},"paymentDisplayTotals":{"BTC":"0.000720","BCH":"0.116857","ETH":"0.009583","GUSD":"12.00","PAX":"12.00","BUSD":"12.00","USDC":"12.00","DOGE":"137.620834","LTC":"0.209278","MATIC":"13.025073","USDC_m":"12.00"},"paymentDisplaySubTotals":{"BTC":"0.000719","BCH":"0.116857","ETH":"0.009583","GUSD":"12.00","PAX":"12.00","BUSD":"12.00","USDC":"12.00","DOGE":"137.620834","LTC":"0.209278","MATIC":"13.025073","USDC_m":"12.00"},"exchangeRates":{"BTC":{"USD":16678.62,"BCH":162.27190686942083,"ETH":13.317964769950652,"GUSD":16678.62,"PAX":16678.62,"BUSD":16678.62,"USDC":16678.62,"DOGE":191235.02412994052,"LTC":290.72023705769567,"MATIC":18099.42485078676,"USDC_m":16678.62},"BCH":{"USD":102.69,"BTC":0.00615832083958021,"ETH":0.08199849881022725,"GUSD":102.69,"PAX":102.69,"BUSD":102.69,"USDC":102.69,"DOGE":1177.4310241436997,"LTC":1.7899599093602927,"MATIC":111.43787303309823,"USDC_m":102.69},"ETH":{"USD":1252.17,"BTC":0.07509265367316342,"BCH":12.182783325280072,"GUSD":1252.17,"PAX":1252.17,"BUSD":1252.17,"USDC":1252.17,"DOGE":14357.22860553137,"LTC":21.826215792225906,"MATIC":1358.8388497015737,"USDC_m":1252.17},"GUSD":{"USD":1,"BTC":5.997001499250375E-5,"BCH":0.009729336532004496,"ETH":7.985051982688407E-4,"PAX":1,"BUSD":1,"USDC":1,"DOGE":11.46587812000876,"LTC":0.017430712916158272,"MATIC":1.0851871947911016,"USDC_m":1},"PAX":{"USD":1,"BTC":5.997001499250375E-5,"BCH":0.009729336532004496,"ETH":7.985051982688407E-4,"GUSD":1,"BUSD":1,"USDC":1,"DOGE":11.46587812000876,"LTC":0.017430712916158272,"MATIC":1.0851871947911016,"USDC_m":1},"BUSD":{"USD":1,"BTC":5.997001499250375E-5,"BCH":0.009729336532004496,"ETH":7.985051982688407E-4,"GUSD":1,"PAX":1,"USDC":1,"DOGE":11.46587812000876,"LTC":0.017430712916158272,"MATIC":1.0851871947911016,"USDC_m":1},"USDC":{"USD":1,"BTC":5.997001499250375E-5,"BCH":0.009729336532004496,"ETH":7.985051982688407E-4,"GUSD":1,"PAX":1,"BUSD":1,"DOGE":11.46587812000876,"LTC":0.017430712916158272,"MATIC":1.0851871947911016,"USDC_m":1},"DOGE":{"USD":0.0871961,"BTC":5.229151424287856E-6,"BCH":8.483602011783173E-4,"ETH":6.962653911876966E-5,"GUSD":0.0871961,"PAX":0.0871961,"BUSD":0.0871961,"USDC":0.0871961,"LTC":0.001519890186508628,"MATIC":0.09462409115572437,"USDC_m":0.0871961},"LTC":{"USD":57.34000000000001,"BTC":0.0034386806596701657,"BCH":0.5578801567451379,"ETH":0.04578628806873533,"GUSD":57.34000000000001,"PAX":57.34000000000001,"BUSD":57.34000000000001,"USDC":57.34000000000001,"DOGE":657.4534514013025,"MATIC":62.224633749321775,"USDC_m":57.34000000000001},"MATIC":{"USD":0.9213000000000001,"BTC":5.525037481259372E-5,"BCH":0.008963637746935744,"ETH":7.35662839165083E-4,"GUSD":0.9213000000000001,"PAX":0.9213000000000001,"BUSD":0.9213000000000001,"USDC":0.9213000000000001,"DOGE":10.563513511964073,"LTC":0.016058915809656616,"USDC_m":0.9213000000000001},"USDC_m":{"USD":1,"BTC":5.997001499250375E-5,"BCH":0.009729336532004496,"ETH":7.985051982688407E-4,"GUSD":1,"PAX":1,"BUSD":1,"USDC":1,"DOGE":11.46587812000876,"LTC":0.017430712916158272,"MATIC":1.0851871947911016}},"minerFees":{"BTC":{"satoshisPerByte":1,"totalFee":100,"fiatAmount":0.02},"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":0,"totalFee":0,"fiatAmount":0},"LTC":{"satoshisPerByte":0,"totalFee":0,"fiatAmount":0},"MATIC":{"satoshisPerByte":0,"totalFee":0,"fiatAmount":0},"USDC_m":{"satoshisPerByte":0,"totalFee":0,"fiatAmount":0}},"shopper":{},"jsonPayProRequired":false,"merchantName":"SUMO Heavy Industries LLC","bitpayIdRequired":false,"itemizedDetails":[],"shopify":{},"transactionCurrency":"BTC","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},"DOGE":{"enabled":true},"LTC":{"enabled":true},"APE":{"enabled":false},"EUROC":{"enabled":false},"MATIC":{"enabled":true},"MATIC_e":{"enabled":false},"ETH_m":{"enabled":false},"USDC_m":{"enabled":true},"BUSD_m":{"enabled":false},"DAI_m":{"enabled":false},"WBTC_m":{"enabled":false},"SHIB_m":{"enabled":false}},"paymentCodes":{"BTC":{"BIP72b":"bitcoin:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3","BIP73":"https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"BCH":{"BIP72b":"bitcoincash:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3","BIP73":"https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"ETH":{"EIP681":"ethereum:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"GUSD":{"EIP681b":"ethereum:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"PAX":{"EIP681b":"ethereum:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"BUSD":{"EIP681b":"ethereum:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"USDC":{"EIP681b":"ethereum:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"DOGE":{"BIP72b":"dogecoin:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3","BIP73":"https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"LTC":{"BIP72b":"litecoin:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3","BIP73":"https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"MATIC":{"EIP681":"matic:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"USDC_m":{"EIP681b":"matic:?r=https://test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"}},"universalCodes":{"paymentString":"https://link.test.bitpay.com/i/4enjVLZH9fUADcAeYRKip3"},"token":"F7uTfepHfSyCepeffoA8uj2oeHGoE7w6HgCadXUHXWQJ"}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/submitPayoutRecipientsResponse.json b/test/unit/BitPaySDK/jsonResponse/submitPayoutRecipientsResponse.json
new file mode 100644
index 00000000..37f5c8a6
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/submitPayoutRecipientsResponse.json
@@ -0,0 +1,18 @@
+[
+ {
+ "email": "alice@email.com",
+ "label": "Alice",
+ "status": "invited",
+ "id": "JA4cEtmBxCp5cybtnh1rds",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf"
+ },
+ {
+ "email": "bob@email.com",
+ "label": "Bob",
+ "status": "invited",
+ "id": "X3icwc4tE8KJ5hEPNPpDXW",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7"
+ }
+]
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/success.json b/test/unit/BitPaySDK/jsonResponse/success.json
new file mode 100644
index 00000000..383af583
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/success.json
@@ -0,0 +1,5 @@
+{
+ "status": "success",
+ "data": {},
+ "message": null
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/updateBillRequest.json b/test/unit/BitPaySDK/jsonResponse/updateBillRequest.json
new file mode 100644
index 00000000..31a9dfa1
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/updateBillRequest.json
@@ -0,0 +1 @@
+{"address1":"2630 Hegal Place","address2":"Apt 42","cc":["jane@doe.com"],"city":"Alexandria","country":"US","currency":"USD","dueDate":"2021-5-31","email":"23242","items":[{"description":"Test Item 1","price":6.0,"quantity":1},{"description":"Test Item 2","price":4.0,"quantity":1}],"name":"John Doe","number":"bill1234-ABCD","passProcessingFee":true,"phone":"555-123-456","state":"VA","token":"AKnJyeLF1BjAfgfDbVUzHXk64N1WuDq3R9xtZouQFhSv","zip":"23242"}
diff --git a/test/unit/BitPaySDK/jsonResponse/updatePayoutRecipientResponse.json b/test/unit/BitPaySDK/jsonResponse/updatePayoutRecipientResponse.json
new file mode 100644
index 00000000..b4933b33
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/updatePayoutRecipientResponse.json
@@ -0,0 +1,8 @@
+{
+ "email": "bob@email.com",
+ "label": "Bob123",
+ "status": "invited",
+ "id": "X3icwc4tE8KJ5hEPNPpDXW",
+ "shopperId": null,
+ "token": "2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7"
+}
\ No newline at end of file
diff --git a/test/unit/BitPaySDK/jsonResponse/updateSubscription.json b/test/unit/BitPaySDK/jsonResponse/updateSubscription.json
new file mode 100644
index 00000000..14ec3ca4
--- /dev/null
+++ b/test/unit/BitPaySDK/jsonResponse/updateSubscription.json
@@ -0,0 +1,40 @@
+{
+ "id": "SeL33Hjyr3VmFHA5Skc4zy",
+ "status": "active",
+ "billData": {
+ "emailBill": true,
+ "cc": [
+ "jane@doe.com"
+ ],
+ "number": "subscription1234-ABCD",
+ "currency": "USD",
+ "name": "John Doe",
+ "address1": "2630 Hegal Place",
+ "address2": "Apt 42",
+ "city": "Alexandria",
+ "state": "VA",
+ "zip": "23242",
+ "country": "US",
+ "email": "john@doe.com",
+ "phone": "555-123-456",
+ "dueDate": "2021-05-31T00:00:00.000Z",
+ "passProcessingFee": true,
+ "items": [
+ {
+ "description": "Test Item 1",
+ "price": 6,
+ "quantity": 1
+ },
+ {
+ "description": "Test Item 2",
+ "price": 4,
+ "quantity": 1
+ }
+ ],
+ "merchant": "5461e13dfd8b0047590d644a"
+ },
+ "schedule": "0 0 0 * * 1",
+ "nextDelivery": "2021-05-24T00:00:00.000Z",
+ "createdDate": "2021-05-21T12:29:54.428Z",
+ "token": "85yxWk7aEgPdJME6zTkXkAGA3K13MtXf3WHqvtBvyhw3ycfEebJ5WMBRZHXsssSBvn"
+}
\ No newline at end of file
diff --git a/tests/BitPaySDK/BitPayTest.php b/tests/BitPaySDK/BitPayTest.php
deleted file mode 100644
index 0856c277..00000000
--- a/tests/BitPaySDK/BitPayTest.php
+++ /dev/null
@@ -1,931 +0,0 @@
-clientMock = $this->createMock(BitPaySDK\Client::class);
- $this->clientMock->withData(
- BitPaySDK\Env::Test,
- __DIR__."/../../examples/bitpay_private_test.key",
- new BitPaySDK\Tokens(
- "7UeQtMcsHamehE4gDZojUQbNRbSuSdggbH17sawtobGJ",
- "5j48K7pUrX5k59DLhRVYkCupgw2CtoEt8DBFrHo2vW47"
- ),
- "YourMasterPassword"
- );
-
- $this->client = BitPaySDK\Client::create()->withData(
- BitPaySDK\Env::Test,
- __DIR__."/../../examples/bitpay_private_test.key",
- new BitPaySDK\Tokens(
- "7UeQtMcsHamehE4gDZojUQbNRbSuSdggbH17sawtobGJ",
- "5j48K7pUrX5k59DLhRVYkCupgw2CtoEt8DBFrHo2vW47"
- ),
- "YourMasterPassword");
-
- /**
- * Uncomment only if you wish to test the client with config files
- * */
-// $this->client1 = BitPaySDK\Client::create()->withFile(__DIR__."/../../examples/BitPay.config.json");
-// $this->client2 = BitPaySDK\Client::create()->withFile(__DIR__."/../../examples/BitPay.config.yml");
-
-
- $this->assertNotNull($this->client);
- /**
- * Uncomment only if you wish to test the client with config files
- * */
-// $this->assertNotNull($this->client1);
-// $this->assertNotNull($this->client2);
- }
-
- public function testShouldGetInvoiceId()
- {
- $invoice = new Invoice(2.16, "eur");
- $invoice->setOrderId("98e572ea-910e-415d-b6de-65f5090680f6");
- $invoice->setFullNotifications(true);
- $invoice->setExtendedNotifications(true);
- $invoice->setTransactionSpeed("medium");
- $invoice->setNotificationURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
- $invoice->setRedirectURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
- $invoice->setPosData("98e572ea35hj356xft8y8cgh56h5090680f6");
- $invoice->setItemDesc("Ab tempora sed ut.");
-
- $buyer = new BitPaySDK\Model\Invoice\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("+99477512690");
- $buyer->setPostalCode("KY7 1TH");
- $buyer->setRegion("New Port");
-
- $invoice->setBuyer($buyer);
-
- try {
- $basicInvoice = $this->client->createInvoice($invoice);
- $retrievedInvoice = $this->client->getInvoice($basicInvoice->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicInvoice->getId());
- $this->assertNotNull($retrievedInvoice->getId());
- $this->assertEquals($basicInvoice->getId(), $retrievedInvoice->getId());
- }
-
- public function testShouldCreateInvoiceBtc()
- {
- try {
- $basicInvoice = $this->client->createInvoice(new Invoice(0.1, Currency::BTC));
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicInvoice->getId());
-
- }
-
- public function testShouldCreateInvoiceBch()
- {
- try {
- $basicInvoice = $this->client->createInvoice(new Invoice(0.1, Currency::BCH));
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicInvoice->getId());
-
- }
-
- public function testShouldCreateInvoiceEth()
- {
- try {
- $basicInvoice = $this->client->createInvoice(new Invoice(0.1, Currency::ETH));
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicInvoice->getId());
-
- }
-
- public function testShouldGetInvoices()
- {
- $invoices = null;
- try {
- //check within the last few days
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-7 day');
- $sevenDaysAgo = $dateBefore->format("Y-m-d");
- $invoices = $this->client->getInvoices($sevenDaysAgo, $today);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($invoices);
- $this->assertTrue(count($invoices) > 0);
- }
-
- public function testShouldCreateGetCancelRefundRequest()
- {
- $invoices = null;
- $firstInvoice = null;
- $firstRefund = null;
- $retrievedRefund = null;
- $retrievedRefunds = null;
- $cancelRefund = null;
- try {
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-30 day');
- $sevenDaysAgo = $dateBefore->format("Y-m-d");
- $invoices = $this->client->getInvoices(
- $sevenDaysAgo, $today, BitPaySDK\Model\Invoice\InvoiceStatus::Complete);
- /**
- * var Invoice
- */
- $firstInvoice = $invoices[0];
- $refunded = $this->client->createRefund(
- $firstInvoice,
- "",
- $firstInvoice->getPrice(),
- $firstInvoice->getCurrency()
- );
- $retrievedRefunds = $this->client->getRefunds($firstInvoice);
- $firstRefund = $retrievedRefunds[0];
- $retrievedRefund = $this->client->getRefund($firstInvoice, $firstRefund->getId());
- $cancelRefund = $this->client->cancelRefund($firstInvoice->getId(), $firstRefund);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($invoices);
- $this->assertNotNull($retrievedRefunds);
- $this->assertEquals($firstRefund->getId(), $retrievedRefund->getId());
- $this->assertTrue($cancelRefund);
- }
-
- public function testShouldCreateBillUSD()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- $bill = new BitPaySDK\Model\Bill\Bill("1001", Currency::USD, "", $items);
- $basicBill = null;
- try {
- $basicBill = $this->client->createBill($bill);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicBill->getId());
- $this->assertNotNull($basicBill->getItems()[0]->getId());
- }
-
- public function testShouldCreateBillEUR()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- $bill = new BitPaySDK\Model\Bill\Bill("1002", Currency::EUR, "", $items);
- $basicBill = null;
- try {
- $basicBill = $this->client->createBill($bill);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicBill->getId());
- $this->assertNotNull($basicBill->getUrl());
- $this->assertEquals(BillStatus::Draft, $basicBill->getStatus());
- $this->assertNotNull($basicBill->getItems()[0]->getId());
- }
-
- public function testShouldGetBill()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- $bill = new BitPaySDK\Model\Bill\Bill("1003", Currency::EUR, "", $items);
- $basicBill = null;
- $retrievedBill = null;
- try {
- $basicBill = $this->client->createBill($bill);
- $retrievedBill = $this->client->getBill($basicBill->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertEquals($basicBill->getId(), $retrievedBill->getId());
- $this->assertEquals($basicBill->getItems(), $retrievedBill->getItems());
- }
-
- public function testShouldUpdateBill()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- $bill = new BitPaySDK\Model\Bill\Bill("1004", Currency::EUR, "", $items);
- $basicBill = null;
- $retrievedBill = null;
- $updatedBill = null;
- try {
- $basicBill = $this->client->createBill($bill);
- $retrievedBill = $this->client->getBill($basicBill->getId());
-
- $this->assertEquals($basicBill->getId(), $retrievedBill->getId());
- $this->assertEquals($basicBill->getItems(), $retrievedBill->getItems());
- $this->assertEquals(count($retrievedBill->getItems()), 4);
-
- $items = $retrievedBill->getItems();
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(60);
- $item->setQuantity(7);
- $item->setDescription("product-added");
- array_push($items, $item);
-
- $retrievedBill->setItems($items);
- $updatedBill = $this->client->updateBill($retrievedBill, $retrievedBill->getId());
- $items = $updatedBill->getItems();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertEquals(count($updatedBill->getItems()), 5);
- $this->assertEquals(end($items)->getDescription(), "product-added");
- }
-
- public function testShouldGetBills()
- {
- $bills = null;
- try {
- $bills = $this->client->getBills();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($bills) > 0);
- }
-
- public function testShouldGetBillsByStatus()
- {
- $bills = null;
- try {
- $bills = $this->client->getBills(BillStatus::Draft);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($bills) > 0);
- }
-
- public function testShouldDeliverBill()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Bill\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- $bill = new BitPaySDK\Model\Bill\Bill("1005", Currency::EUR, "", $items);
- $basicBill = null;
- $retrievedBill = null;
- $result = null;
- try {
- $basicBill = $this->client->createBill($bill);
- $result = $this->client->deliverBill($basicBill->getId(), $basicBill->getToken());
- $retrievedBill = $this->client->getBill($basicBill->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertEquals($basicBill->getId(), $retrievedBill->getId());
- $this->assertEquals($basicBill->getItems(), $retrievedBill->getItems());
- $this->assertEquals("Success", $result);
- $this->assertNotEquals($basicBill->getStatus(), $retrievedBill->getStatus());
- $this->assertEquals($retrievedBill->getStatus(), BillStatus::Sent);
- }
-
- public function testShouldGetExchangeRates()
- {
- $ratesList = null;
- try {
- $rates = $this->client->getRates();
- $ratesList = $rates->getRates();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($ratesList);
- }
-
- public function testShouldGetEURExchangeRate()
- {
- $rate = null;
- try {
- $rates = $this->client->getRates();
- $rate = $rates->getRate(Currency::EUR);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue($rate != 0);
- }
-
- public function testShouldGetCNYExchangeRate()
- {
- $rate = null;
- try {
- $rates = $this->client->getRates();
- $rate = $rates->getRate(Currency::CNY);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue($rate != 0);
- }
-
- public function testShouldUpdateExchangeRates()
- {
- $rates = null;
- $ratesList = null;
- try {
- $rates = $this->client->getRates();
- $rates->update();
- $ratesList = $rates->getRates();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($ratesList);
- }
-
- public function testShouldGetLedgerBtc()
- {
- $ledge = null;
- try {
- //check within the last few days
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-7 day');
- $sevenDaysAgo = $dateBefore->format("Y-m-d");
- $ledger = $this->client->getLedger(Currency::BTC, $sevenDaysAgo, $today);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($ledger);
- $this->assertTrue(count($ledger->getEntries()) > 0);
- }
-
- public function testShouldGetLedgerUsd()
- {
- $ledge = null;
- try {
- //check within the last few days
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-30 day');
- $sevenDaysAgo = $dateBefore->format("Y-m-d");
- $ledger = $this->client->getLedger(Currency::USD, $sevenDaysAgo, $today);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($ledger);
- $this->assertTrue(count($ledger->getEntries()) > 0);
- }
-
- public function testShouldGetLedgers()
- {
- $ledgers = null;
- try {
- $ledgers = $this->client->getLedgers();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($ledgers);
- $this->assertTrue(count($ledgers) > 0);
- }
-
- public function testShouldSubmitPayoutBatch()
- {
- $date = new \DateTime();
- $threeDaysFromNow = $date->modify('+3 day');
-
- $effectiveDate = $threeDaysFromNow->format("Y-m-d");
- $currency = Currency::USD;
- $instructions = [
- new BitPaySDK\Model\Payout\PayoutInstruction(100.0, "mtHDtQtkEkRRB5mgeWpLhALsSbga3iZV6u"),
- new BitPaySDK\Model\Payout\PayoutInstruction(200.0, "mvR4Xj7MYT7GJcL93xAQbSZ2p4eHJV5F7A"),
- ];
-
- $batch = new BitPaySDK\Model\Payout\PayoutBatch($currency, $effectiveDate, $instructions);
- try {
- $batch = $this->client->submitPayoutBatch($batch);
- $this->client->cancelPayoutBatch($batch->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($batch->getId());
- $this->assertTrue(count($batch->getInstructions()) == 2);
- }
-
- public function testShouldGetPayoutBatches()
- {
- try {
- $batches = $this->client->getPayoutBatches();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($batches) > 0);
- }
-
- public function testShouldGetPayoutBatchesByStatus()
- {
- try {
- $batches = $this->client->getPayoutBatches(PayoutStatus::New);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($batches) > 0);
- }
-
- public function testShouldSubmitGetAndDeletePayoutBatch()
- {
- $date = new \DateTime();
- $threeDaysFromNow = $date->modify('+3 day');
-
- $effectiveDate = $threeDaysFromNow->format("Y-m-d");
- $currency = Currency::USD;
- $instructions = [
- new BitPaySDK\Model\Payout\PayoutInstruction(100.0, "mtHDtQtkEkRRB5mgeWpLhALsSbga3iZV6u"),
- new BitPaySDK\Model\Payout\PayoutInstruction(200.0, "mvR4Xj7MYT7GJcL93xAQbSZ2p4eHJV5F7A"),
- ];
-
- $batch = new BitPaySDK\Model\Payout\PayoutBatch($currency, $effectiveDate, $instructions);
- $batchRetrieved = null;
- try {
- $batch = $this->client->submitPayoutBatch($batch);
- $batchRetrieved = $this->client->getPayoutBatch($batch->getId());
- $batchCancelled = $this->client->cancelPayoutBatch($batchRetrieved->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($batch->getId());
- $this->assertNotNull($batchRetrieved->getId());
- $this->assertNotNull($batchCancelled->getId());
- $this->assertTrue(count($batch->getInstructions()) == 2);
- $this->assertEquals($batch->getId(), $batchRetrieved->getId());
- $this->assertEquals($batchRetrieved->getId(), $batchCancelled->getId());
- $this->assertEquals($batchRetrieved->getStatus(), PayoutStatus::New);
- $this->assertEquals($batchCancelled->getStatus(), PayoutStatus::Cancelled);
- }
-
- public function testGetSettlements()
- {
- $settlements = null;
- $firstSettlement = null;
- $settlement = null;
- try {
- //check within the last few days
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-365 day');
- $oneMonthAgo = $dateBefore->format("Y-m-d");
-
- $settlements = $this->client->getSettlements(Currency::USD, $oneMonthAgo, $today, null, null, null);
- $firstSettlement = $settlements[0];
- $settlement = $this->client->getSettlement($firstSettlement->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($settlements);
- $this->assertTrue(count($settlements) > 0);
- $this->assertNotNull($settlement->getId());
- $this->assertEquals($firstSettlement->getId(), $settlement->getId());
- }
-
- public function testGetSettlementReconciliationReport()
- {
- $settlements = null;
- $firstSettlement = null;
- $settlement = null;
- try {
- //check within the last few days
- $date = new \DateTime();
- $today = $date->format("Y-m-d");
- $dateBefore = $date->modify('-365 day');
- $oneMonthAgo = $dateBefore->format("Y-m-d");
-
- $settlements = $this->client->getSettlements(Currency::USD, $oneMonthAgo, $today, null, null, null);
- $firstSettlement = $settlements[0];
- $settlement = $this->client->getSettlementReconciliationReport($firstSettlement);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($settlements);
- $this->assertTrue(count($settlements) > 0);
- $this->assertNotNull($settlement->getId());
- $this->assertEquals($firstSettlement->getId(), $settlement->getId());
- }
-
- public function testShouldCreateSubscription()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- //Stop subscription a few days later
- $date = new \DateTime();
- $date->modify('+1 month');
- $dueDate = $date->format("Y-m-d");
-
- $billData = new BitPaySDK\Model\Subscription\BillData(
- Currency::USD,
- "",
- $dueDate,
- $items
- );
-
- $subscription = new BitPaySDK\Model\Subscription\Subscription();
- $subscription->setBillData($billData);
- $subscription->setSchedule("weekly");
- $basicSubscription = null;
- try {
- $basicSubscription = $this->client->createSubscription($subscription);
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($basicSubscription->getId());
- $this->assertNotNull($basicSubscription->getBillData()->getItems()[0]);
- }
-
- public function testShouldGetSubscription()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- //Stop subscription a few days later
- $date = new \DateTime();
- $date->modify('+1 month');
- $dueDate = $date->format("Y-m-d");
-
- $billData = new BitPaySDK\Model\Subscription\BillData(
- Currency::USD,
- "",
- $dueDate,
- $items
- );
-
- $subscription = new BitPaySDK\Model\Subscription\Subscription();
- $subscription->setBillData($billData);
- $subscription->setSchedule("weekly");
- $basicSubscription = null;
- $retrievedSubscription = null;
- try {
- $basicSubscription = $this->client->createSubscription($subscription);
- $retrievedSubscription = $this->client->getSubscription($basicSubscription->getId());
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertEquals($basicSubscription->getId(), $retrievedSubscription->getId());
- $this->assertEquals($basicSubscription->getBillData()->getItems(), $retrievedSubscription->getBillData()->getItems());
- }
-
- public function testShouldUpdateSubscription()
- {
- $items = [];
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(30.0);
- $item->setQuantity(9);
- $item->setDescription("product-a");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(14.0);
- $item->setQuantity(16);
- $item->setDescription("product-b");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(3.90);
- $item->setQuantity(42);
- $item->setDescription("product-c");
- array_push($items, $item);
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(6.99);
- $item->setQuantity(12);
- $item->setDescription("product-d");
- array_push($items, $item);
-
- //Stop subscription a few days later
- $date = new \DateTime();
- $date->modify('+1 month');
- $dueDate = $date->format("Y-m-d");
-
- $billData = new BitPaySDK\Model\Subscription\BillData(
- Currency::USD,
- "",
- $dueDate,
- $items
- );
-
- $subscription = new BitPaySDK\Model\Subscription\Subscription();
- $subscription->setBillData($billData);
- $subscription->setSchedule("weekly");
- $basicSubscription = null;
- $retrievedSubscription = null;
- $updatedSubscription = null;
- try {
- $basicSubscription = $this->client->createSubscription($subscription);
- $retrievedSubscription = $this->client->getSubscription($basicSubscription->getId());
-
- $this->assertEquals($basicSubscription->getId(), $retrievedSubscription->getId());
- $this->assertEquals(
- $basicSubscription->getBillData()->getItems(), $retrievedSubscription->getBillData()->getItems());
- $this->assertEquals(count($retrievedSubscription->getBillData()->getItems()), 4);
-
- $items = $retrievedSubscription->getBillData()->getItems();
-
- $item = new BitPaySDK\Model\Subscription\Item();
- $item->setPrice(60);
- $item->setQuantity(7);
- $item->setDescription("product-added");
- array_push($items, $item);
-
- $retrievedSubscription->getBillData()->setItems($items);
- $updatedSubscription = $this->client->updateSubscription(
- $retrievedSubscription, $retrievedSubscription->getId());
- $items = $updatedSubscription->getBillData()->getItems();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertEquals(count($updatedSubscription->getBillData()->getItems()), 5);
- $this->assertEquals(end($items)->getDescription(), "product-added");
- }
-
- public function testShouldGetSubscriptions()
- {
- $subscriptions = null;
- try {
- $subscriptions = $this->client->getSubscriptions();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($subscriptions) > 0);
- }
-
- public function testShouldGetSubscriptionsByStatus()
- {
- $subscriptions = null;
- try {
- $subscriptions = $this->client->getSubscriptions();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertTrue(count($subscriptions) > 0);
- }
-
- public function testShouldGetCurrencies()
- {
- $currencyList = null;
- try {
- $currencyList = $this->client->getCurrencies();
- } catch (\Exception $e) {
- $e->getTraceAsString();
- self::fail($e->getMessage());
- }
-
- $this->assertNotNull($currencyList);
- }
-}