diff --git a/composer.lock b/composer.lock index 496eae5f..dabc30fe 100644 --- a/composer.lock +++ b/composer.lock @@ -691,16 +691,16 @@ }, { "name": "symfony/console", - "version": "v6.4.8", + "version": "v6.4.9", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "be5854cee0e8c7b110f00d695d11debdfa1a2a91" + "reference": "6edb5363ec0c78ad4d48c5128ebf4d083d89d3a9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/be5854cee0e8c7b110f00d695d11debdfa1a2a91", - "reference": "be5854cee0e8c7b110f00d695d11debdfa1a2a91", + "url": "https://api.github.com/repos/symfony/console/zipball/6edb5363ec0c78ad4d48c5128ebf4d083d89d3a9", + "reference": "6edb5363ec0c78ad4d48c5128ebf4d083d89d3a9", "shasum": "" }, "require": { @@ -765,7 +765,7 @@ "terminal" ], "support": { - "source": "https://github.com/symfony/console/tree/v6.4.8" + "source": "https://github.com/symfony/console/tree/v6.4.9" }, "funding": [ { @@ -781,7 +781,7 @@ "type": "tidelift" } ], - "time": "2024-05-31T14:49:08+00:00" + "time": "2024-06-28T09:49:33+00:00" }, { "name": "symfony/deprecation-contracts", @@ -1968,16 +1968,16 @@ }, { "name": "phpunit/phpunit", - "version": "10.5.21", + "version": "10.5.26", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "ac837816fa52078f7a5e17ed774f256a72a51af6" + "reference": "42e2f13ceaa2e34461bc89bea75407550b40b2aa" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/ac837816fa52078f7a5e17ed774f256a72a51af6", - "reference": "ac837816fa52078f7a5e17ed774f256a72a51af6", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/42e2f13ceaa2e34461bc89bea75407550b40b2aa", + "reference": "42e2f13ceaa2e34461bc89bea75407550b40b2aa", "shasum": "" }, "require": { @@ -2049,7 +2049,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.21" + "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.26" }, "funding": [ { @@ -2065,7 +2065,7 @@ "type": "tidelift" } ], - "time": "2024-06-15T09:13:15+00:00" + "time": "2024-07-08T05:30:46+00:00" }, { "name": "sebastian/cli-parser", diff --git a/docs/classes/BitPaySDK-Client-BillClient.html b/docs/classes/BitPaySDK-Client-BillClient.html index b599bbd5..1e6cec63 100644 --- a/docs/classes/BitPaySDK-Client-BillClient.html +++ b/docs/classes/BitPaySDK-Client-BillClient.html @@ -157,6 +157,7 @@

+

Tags @@ -208,19 +209,19 @@

- $instance + $instance  : self|null
- $restCli + $restCli  : RESTcli
- $tokenCache + $tokenCache  : Tokens
@@ -234,55 +235,55 @@

- create() + create()  : Bill
Create a BitPay Bill.
- deliver() + deliver()  : bool
Deliver a BitPay Bill.
- get() + get()  : Bill
Retrieve a BitPay bill by bill id using the specified facade.
- getBills() + getBills()  : array<string|int, Bill>
Retrieve a collection of BitPay bills.
- getInstance() + getInstance()  : static
Factory method for Bill Client.
- update() + update()  : Bill
Update a BitPay Bill.
- __construct() + __construct()  : mixed
- mapJsonToBillClass() + mapJsonToBillClass()  : Bill
@@ -322,6 +323,7 @@

+ private static self|null @@ -357,6 +359,7 @@

+ private RESTcli @@ -392,6 +395,7 @@

+ private Tokens @@ -440,6 +444,7 @@

+

Parameters
@@ -531,6 +536,7 @@

+

Parameters
@@ -622,6 +628,7 @@

+

Parameters
@@ -713,6 +720,7 @@

+

Parameters
@@ -786,6 +794,7 @@

+

Parameters
@@ -841,6 +850,7 @@

+

Parameters
@@ -922,6 +932,7 @@

+

Parameters
@@ -972,6 +983,7 @@

+

Parameters
@@ -1129,23 +1141,23 @@
Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-InvoiceClient.html b/docs/classes/BitPaySDK-Client-InvoiceClient.html index e899c58f..9e2e9ab5 100644 --- a/docs/classes/BitPaySDK-Client-InvoiceClient.html +++ b/docs/classes/BitPaySDK-Client-InvoiceClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,28 +235,28 @@

    - cancel() + cancel()  : Invoice
    Cancel a BitPay invoice.
    - cancelByGuid() + cancelByGuid()  : Invoice
    Cancel a BitPay invoice.
    - create() + create()  : Invoice
    Create a BitPay invoice.
    - get() + get()  : Invoice
    @@ -263,61 +264,61 @@

    authorized for the specified facade (the public facade requires no authorization).
    - getByGuid() + getByGuid()  : Invoice
    - getInstance() + getInstance()  : static
    Factory method for Invoice Client.
    - getInvoices() + getInvoices()  : array<string|int, Invoice>
    Retrieve a collection of BitPay invoices.
    - pay() + pay()  : Invoice
    Pay an invoice with a mock transaction
    - requestNotification() + requestNotification()  : bool
    Request a BitPay Invoice Webhook.
    - update() + update()  : Invoice
    Update a BitPay invoice.
    - __construct() + __construct()  : mixed
    - validateBuyerEmailAndSms() + validateBuyerEmailAndSms()  : void
    Check if buyerEmail or buyerSms is present, and not both.
    - validateSmsCode() + validateSmsCode()  : void
    @@ -358,6 +359,7 @@

    + private static self|null @@ -393,6 +395,7 @@

    + private RESTcli @@ -428,6 +431,7 @@

    + private Tokens @@ -476,6 +480,7 @@

    +

    Parameters
    @@ -560,6 +565,7 @@

    +

    Parameters
    @@ -644,6 +650,7 @@

    +

    Parameters
    @@ -736,6 +743,7 @@

    +

    Parameters
    @@ -826,6 +834,7 @@

    +

    Parameters
    @@ -911,6 +920,7 @@

    +

    Parameters
    @@ -966,6 +976,7 @@

    +

    Parameters
    @@ -1085,6 +1096,7 @@

    +

    Parameters
    @@ -1171,6 +1183,7 @@

    +

    Parameters
    @@ -1248,6 +1261,7 @@

    +

    Parameters
    @@ -1356,6 +1370,7 @@

    +

    Parameters
    @@ -1406,6 +1421,7 @@

    +

    Updating the invoice will require EITHER SMS or E-mail, but not both.

    @@ -1478,6 +1494,7 @@

    +

    smsCode required only when verifying SMS, except when autoVerify is true.

    @@ -1646,28 +1663,28 @@

  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-LedgerClient.html b/docs/classes/BitPaySDK-Client-LedgerClient.html index 7c9383c7..c9eb47e5 100644 --- a/docs/classes/BitPaySDK-Client-LedgerClient.html +++ b/docs/classes/BitPaySDK-Client-LedgerClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,28 +235,28 @@

    - get() + get()  : array<string|int, LedgerEntry>
    Retrieve a list of ledgers by date range using the merchant facade.
    - getInstance() + getInstance()  : static
    Factory method for Ledger Client.
    - getLedgers() + getLedgers()  : array<string|int, Ledger>
    Retrieve a list of ledgers using the merchant facade.
    - __construct() + __construct()  : mixed
    @@ -295,6 +296,7 @@

    + private static self|null @@ -330,6 +332,7 @@

    + private RESTcli @@ -365,6 +368,7 @@

    + private Tokens @@ -413,6 +417,7 @@

    +

    Parameters
    @@ -508,6 +513,7 @@

    +

    Parameters
    @@ -565,6 +571,7 @@

    +

    Tags @@ -627,6 +634,7 @@

    +

    Parameters
    @@ -764,19 +772,19 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-PayoutClient.html b/docs/classes/BitPaySDK-Client-PayoutClient.html index 17b43a5b..bc1b3887 100644 --- a/docs/classes/BitPaySDK-Client-PayoutClient.html +++ b/docs/classes/BitPaySDK-Client-PayoutClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,26 +235,26 @@

    - cancel() + cancel()  : bool
    Cancel a BitPay Payout.
    - cancelGroup() + cancelGroup()  : PayoutGroup
    - createGroup() + createGroup()  : PayoutGroup
    - get() + get()  : Payout
    @@ -261,41 +262,41 @@

    for the payout facade.
    - getInstance() + getInstance()  : static
    Factory method for Payout Client.
    - getPayouts() + getPayouts()  : array<string|int, Payout>
    Retrieve a collection of BitPay payouts.
    - requestNotification() + requestNotification()  : bool
    Notify BitPay Payout.
    - submit() + submit()  : Payout
    Submit a BitPay Payout.
    - __construct() + __construct()  : mixed
    - getPayoutGroupResponse() + getPayoutGroupResponse()  : PayoutGroup
    @@ -335,6 +336,7 @@

    + private static self|null @@ -370,6 +372,7 @@

    + private RESTcli @@ -405,6 +408,7 @@

    + private Tokens @@ -453,6 +457,7 @@

    +

    Parameters
    @@ -525,6 +530,7 @@

    +

    Parameters
    @@ -595,6 +601,7 @@

    +

    Parameters
    @@ -667,6 +674,7 @@

    +

    Parameters
    @@ -740,6 +748,7 @@

    +

    Parameters
    @@ -795,6 +804,7 @@

    +

    Parameters
    @@ -914,6 +924,7 @@

    +

    Parameters
    @@ -987,6 +998,7 @@

    +

    Parameters
    @@ -1059,6 +1071,7 @@

    +

    Parameters
    @@ -1109,6 +1122,7 @@

    +

    Parameters
    @@ -1267,25 +1281,25 @@
    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html b/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html index 11c80465..eb561fd0 100644 --- a/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html +++ b/docs/classes/BitPaySDK-Client-PayoutRecipientsClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,14 +235,14 @@

    - delete() + delete()  : bool
    Delete a Payout Recipient.
    - get() + get()  : PayoutRecipient
    @@ -249,42 +250,42 @@

    payout facade.
    - getInstance() + getInstance()  : static
    Factory method for Payout Recipients Client.
    - getPayoutRecipients() + getPayoutRecipients()  : array<string|int, PayoutRecipient>
    Retrieve a collection of BitPay Payout Recipients.
    - requestNotification() + requestNotification()  : bool
    Notify BitPay Payout Recipient.
    - submit() + submit()  : array<string|int, PayoutRecipients>
    Submit BitPay Payout Recipients.
    - update() + update()  : PayoutRecipient
    Update a Payout Recipient.
    - __construct() + __construct()  : mixed
    @@ -324,6 +325,7 @@

    + private static self|null @@ -359,6 +361,7 @@

    + private RESTcli @@ -394,6 +397,7 @@

    + private Tokens @@ -442,6 +446,7 @@

    +

    Parameters
    @@ -520,6 +525,7 @@

    +

    Parameters
    @@ -593,6 +599,7 @@

    +

    Parameters
    @@ -648,6 +655,7 @@

    +

    Parameters
    @@ -740,6 +748,7 @@

    +

    Parameters
    @@ -817,6 +826,7 @@

    +

    Parameters
    @@ -894,6 +904,7 @@

    +

    Parameters
    @@ -975,6 +986,7 @@

    +

    Parameters
    @@ -1112,23 +1124,23 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-RateClient.html b/docs/classes/BitPaySDK-Client-RateClient.html index 42a1fefb..26e1fd0b 100644 --- a/docs/classes/BitPaySDK-Client-RateClient.html +++ b/docs/classes/BitPaySDK-Client-RateClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,13 +209,13 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    @@ -228,35 +229,35 @@

    - getCurrencyPairRate() + getCurrencyPairRate()  : Rate
    Retrieve the rate for a cryptocurrency / fiat pair
    - getCurrencyRates() + getCurrencyRates()  : Rates
    Retrieve all the rates for a given cryptocurrency
    - getInstance() + getInstance()  : static
    Factory method for Rate Client.
    - getRates() + getRates()  : Rates
    Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
    - __construct() + __construct()  : mixed
    @@ -296,6 +297,7 @@

    + private static self|null @@ -331,6 +333,7 @@

    + private RESTcli @@ -379,6 +382,7 @@

    +

    Parameters
    @@ -466,6 +470,7 @@

    +

    Parameters
    @@ -544,6 +549,7 @@

    +

    Parameters
    @@ -594,6 +600,7 @@

    +

    Tags @@ -652,6 +659,7 @@

    +

    Parameters
    @@ -782,19 +790,19 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-RefundClient.html b/docs/classes/BitPaySDK-Client-RefundClient.html index 4a5f74ac..d7b2b50b 100644 --- a/docs/classes/BitPaySDK-Client-RefundClient.html +++ b/docs/classes/BitPaySDK-Client-RefundClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,77 +235,77 @@

    - cancel() + cancel()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - cancelByGuid() + cancelByGuid()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - create() + create()  : Refund
    Create a refund for a BitPay invoice.
    - get() + get()  : Refund
    Retrieve a previously made refund request on a BitPay invoice.
    - getByGuid() + getByGuid()  : Refund
    Retrieve a previously made refund request on a BitPay invoice by guid.
    - getInstance() + getInstance()  : static
    Factory method for Bill Client.
    - getRefunds() + getRefunds()  : array<string|int, Refund>
    Retrieve all refund requests on a BitPay invoice.
    - sendNotification() + sendNotification()  : bool
    Send a refund notification.
    - update() + update()  : Refund
    Update the status of a BitPay invoice.
    - updateByGuid() + updateByGuid()  : Refund
    Update the status of a BitPay invoice.
    - __construct() + __construct()  : mixed
    @@ -344,6 +345,7 @@

    + private static self|null @@ -379,6 +381,7 @@

    + private RESTcli @@ -414,6 +417,7 @@

    + private Tokens @@ -462,6 +466,7 @@

    +

    Parameters
    @@ -539,6 +544,7 @@

    +

    Parameters
    @@ -624,6 +630,7 @@

    +

    Parameters
    @@ -771,6 +778,7 @@

    +

    Parameters
    @@ -848,6 +856,7 @@

    +

    Parameters
    @@ -933,6 +942,7 @@

    +

    Parameters
    @@ -988,6 +998,7 @@

    +

    Parameters
    @@ -1061,6 +1072,7 @@

    +

    Parameters
    @@ -1138,6 +1150,7 @@

    +

    Parameters
    @@ -1224,6 +1237,7 @@

    +

    Parameters
    @@ -1317,6 +1331,7 @@

    +

    Parameters
    @@ -1454,26 +1469,26 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-SettlementClient.html b/docs/classes/BitPaySDK-Client-SettlementClient.html index 510974b8..a3083322 100644 --- a/docs/classes/BitPaySDK-Client-SettlementClient.html +++ b/docs/classes/BitPaySDK-Client-SettlementClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,19 +209,19 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -234,35 +235,35 @@

    - get() + get()  : Settlement
    Retrieves a summary of the specified settlement.
    - getInstance() + getInstance()  : static
    Factory method for Settlements Client.
    - getReconciliationReport() + getReconciliationReport()  : Settlement
    Gets a detailed reconciliation report of the activity within the settlement period.
    - getSettlements() + getSettlements()  : array<string|int, Settlement>
    Retrieves settlement reports for the calling merchant filtered by query.
    - __construct() + __construct()  : mixed
    @@ -302,6 +303,7 @@

    + private static self|null @@ -337,6 +339,7 @@

    + private RESTcli @@ -372,6 +375,7 @@

    + private Tokens @@ -420,6 +424,7 @@

    +

    Parameters
    @@ -493,6 +498,7 @@

    +

    Parameters
    @@ -548,6 +554,7 @@

    +

    Parameters
    @@ -629,6 +636,7 @@

    +

    The limit and offset parameters specify pages for large query sets.

    @@ -750,6 +758,7 @@

    +

    Parameters
    @@ -887,20 +896,20 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-TokenClient.html b/docs/classes/BitPaySDK-Client-TokenClient.html index bef6b54a..c0608043 100644 --- a/docs/classes/BitPaySDK-Client-TokenClient.html +++ b/docs/classes/BitPaySDK-Client-TokenClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,13 +209,13 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    @@ -228,21 +229,21 @@

    - getInstance() + getInstance()  : static
    Factory method for Token Client.
    - getTokens() + getTokens()  : array<string|int, mixed>
    Get Tokens.
    - __construct() + __construct()  : mixed
    @@ -282,6 +283,7 @@

    + private static self|null @@ -317,6 +319,7 @@

    + private RESTcli @@ -365,6 +368,7 @@

    +

    Parameters
    @@ -415,6 +419,7 @@

    +

    Tags @@ -473,6 +478,7 @@

    +

    Parameters
    @@ -603,17 +609,17 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client-WalletClient.html b/docs/classes/BitPaySDK-Client-WalletClient.html index fa08a6e8..bea8a977 100644 --- a/docs/classes/BitPaySDK-Client-WalletClient.html +++ b/docs/classes/BitPaySDK-Client-WalletClient.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,13 +209,13 @@

    - $instance + $instance  : self|null
    - $restCli + $restCli  : RESTcli
    @@ -228,21 +229,21 @@

    - getInstance() + getInstance()  : static
    Factory method for Wallet Client.
    - getSupportedWallets() + getSupportedWallets()  : array<string|int, Wallet>
    Retrieve all supported wallets.
    - __construct() + __construct()  : mixed
    @@ -282,6 +283,7 @@

    + private static self|null @@ -317,6 +319,7 @@

    + private RESTcli @@ -365,6 +368,7 @@

    +

    Parameters
    @@ -415,6 +419,7 @@

    +

    Tags @@ -473,6 +478,7 @@

    +

    Parameters
    @@ -603,17 +609,17 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Client.html b/docs/classes/BitPaySDK-Client.html index b02ef4b4..c7fee2d7 100644 --- a/docs/classes/BitPaySDK-Client.html +++ b/docs/classes/BitPaySDK-Client.html @@ -155,6 +155,7 @@

    +

    Tags @@ -206,13 +207,13 @@

    - $restCli + $restCli  : RESTcli
    - $tokenCache + $tokenCache  : Tokens
    @@ -226,138 +227,138 @@

    - __construct() + __construct()  : mixed
    Client constructor.
    - cancelInvoice() + cancelInvoice()  : Invoice
    Cancel a BitPay invoice.
    - cancelInvoiceByGuid() + cancelInvoiceByGuid()  : Invoice
    Cancel a BitPay invoice.
    - cancelPayout() + cancelPayout()  : bool
    Cancel a BitPay Payout.
    - cancelPayoutGroup() + cancelPayoutGroup()  : PayoutGroup
    - cancelRefund() + cancelRefund()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - cancelRefundByGuid() + cancelRefundByGuid()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - createBill() + createBill()  : Bill
    Create a BitPay Bill.
    - createInvoice() + createInvoice()  : Invoice
    Create a BitPay invoice.
    - createPayoutGroup() + createPayoutGroup()  : PayoutGroup
    - createRefund() + createRefund()  : Refund
    Create a refund for a BitPay invoice.
    - createWithData() + createWithData()  : Client
    Constructor for use if the keys and SIN are managed by this library.
    - createWithFile() + createWithFile()  : Client
    Constructor for use if the keys and SIN are managed by this library.
    - deletePayoutRecipient() + deletePayoutRecipient()  : bool
    Delete a Payout Recipient.
    - deliverBill() + deliverBill()  : bool
    Deliver a BitPay Bill.
    - getBill() + getBill()  : Bill
    Retrieve a BitPay bill by bill id using the specified facade.
    - getBills() + getBills()  : array<string|int, Bill>
    Retrieve a collection of BitPay bills.
    - getCurrencyPairRate() + getCurrencyPairRate()  : Rate
    Retrieve the rate for a cryptocurrency / fiat pair
    - getCurrencyRates() + getCurrencyRates()  : Rates
    Retrieve all the rates for a given cryptocurrency
    - getInvoice() + getInvoice()  : Invoice
    @@ -365,35 +366,35 @@

    authorized for the specified facade (the public facade requires no authorization).
    - getInvoiceByGuid() + getInvoiceByGuid()  : Invoice
    Retrieve a BitPay invoice by guid using the specified facade.
    - getInvoices() + getInvoices()  : array<string|int, Invoice>
    Retrieve a collection of BitPay invoices.
    - getLedgerEntries() + getLedgerEntries()  : array<string|int, LedgerEntry>
    Retrieve a list of ledgers by date range using the merchant facade.
    - getLedgers() + getLedgers()  : array<string|int, Ledger>
    Retrieve a list of ledgers using the merchant facade.
    - getPayout() + getPayout()  : Payout
    @@ -401,7 +402,7 @@

    for the payout facade.
    - getPayoutRecipient() + getPayoutRecipient()  : PayoutRecipient
    @@ -409,244 +410,244 @@

    payout facade.
    - getPayoutRecipients() + getPayoutRecipients()  : array<string|int, PayoutRecipient>
    Retrieve a collection of BitPay Payout Recipients.
    - getPayouts() + getPayouts()  : array<string|int, Payout>
    Retrieve a collection of BitPay payouts.
    - getRates() + getRates()  : Rates
    Retrieve the exchange rate table maintained by BitPay.
    - getRefund() + getRefund()  : Refund
    Retrieve a previously made refund request on a BitPay invoice.
    - getRefundByGuid() + getRefundByGuid()  : Refund
    Retrieve a previously made refund request on a BitPay invoice.
    - getRefunds() + getRefunds()  : array<string|int, Refund>
    Retrieve all refund requests on a BitPay invoice.
    - getSettlement() + getSettlement()  : Settlement
    Retrieves a summary of the specified settlement.
    - getSettlementReconciliationReport() + getSettlementReconciliationReport()  : Settlement
    Gets a detailed reconciliation report of the activity within the settlement period.
    - getSettlements() + getSettlements()  : array<string|int, Settlement>
    Retrieves settlement reports for the calling merchant filtered by query.
    - getSupportedWallets() + getSupportedWallets()  : array<string|int, Wallet>
    Retrieve all supported wallets.
    - getTokens() + getTokens()  : array<string|int, mixed>
    Get Tokens.
    - payInvoice() + payInvoice()  : Invoice
    Pay an invoice with a mock transaction
    - requestInvoiceNotification() + requestInvoiceNotification()  : bool
    Request a BitPay Invoice Webhook.
    - requestPayoutNotification() + requestPayoutNotification()  : bool
    Notify BitPay Payout.
    - requestPayoutRecipientNotification() + requestPayoutRecipientNotification()  : bool
    Notify BitPay Payout Recipient.
    - sendRefundNotification() + sendRefundNotification()  : bool
    Send a refund notification.
    - submitPayout() + submitPayout()  : Payout
    Submit a BitPay Payout.
    - submitPayoutRecipients() + submitPayoutRecipients()  : array<string|int, PayoutRecipient>
    Submit BitPay Payout Recipients.
    - updateBill() + updateBill()  : Bill
    Update a BitPay Bill.
    - updateInvoice() + updateInvoice()  : Invoice
    Update a BitPay invoice.
    - updatePayoutRecipient() + updatePayoutRecipient()  : PayoutRecipient
    Update a Payout Recipient.
    - updateRefund() + updateRefund()  : Refund
    Update the status of a BitPay invoice.
    - updateRefundByGuid() + updateRefundByGuid()  : Refund
    Update the status of a BitPay invoice.
    - getBillClient() + getBillClient()  : BillClient
    Gets bill client
    - getInvoiceClient() + getInvoiceClient()  : InvoiceClient
    Gets invoice client
    - getLedgerClient() + getLedgerClient()  : LedgerClient
    Gets ledger client
    - getPayoutClient() + getPayoutClient()  : PayoutClient
    Gets payout client
    - getPayoutRecipientsClient() + getPayoutRecipientsClient()  : PayoutRecipientsClient
    Gets payout recipients client
    - getRateClient() + getRateClient()  : RateClient
    Gets rate client
    - getRefundClient() + getRefundClient()  : RefundClient
    Gets refund client
    - getSettlementClient() + getSettlementClient()  : SettlementClient
    Gets settlement client
    - getWalletClient() + getWalletClient()  : WalletClient
    Gets wallet client
    - getConfigData() + getConfigData()  : array<string|int, mixed>
    - getTokenClient() + getTokenClient()  : TokenClient
    Gets token client
    - initKeys() + initKeys()  : PrivateKey|null
    @@ -686,6 +687,7 @@

    + protected RESTcli @@ -721,6 +723,7 @@

    + protected Tokens @@ -769,6 +772,7 @@

    +

    Parameters
    @@ -820,6 +824,7 @@

    +

    Parameters
    @@ -914,6 +919,7 @@

    +

    Parameters
    @@ -1008,6 +1014,7 @@

    +

    Parameters
    @@ -1090,6 +1097,7 @@

    +

    Parameters
    @@ -1171,6 +1179,7 @@

    +

    Parameters
    @@ -1250,6 +1259,7 @@

    +

    Parameters
    @@ -1329,6 +1339,7 @@

    +

    Parameters
    @@ -1430,6 +1441,7 @@

    +

    Parameters
    @@ -1530,6 +1542,7 @@

    +

    Parameters
    @@ -1611,6 +1624,7 @@

    +

    Parameters
    @@ -1757,6 +1771,7 @@

    +

    Parameters
    @@ -1867,6 +1882,7 @@

    +

    Parameters
    @@ -1932,6 +1948,7 @@

    +

    Parameters
    @@ -2019,6 +2036,7 @@

    +

    Parameters
    @@ -2120,6 +2138,7 @@

    +

    Parameters
    @@ -2221,6 +2240,7 @@

    +

    Parameters
    @@ -2302,6 +2322,7 @@

    +

    Parameters
    @@ -2399,6 +2420,7 @@

    +

    Parameters
    @@ -2488,6 +2510,7 @@

    +

    Parameters
    @@ -2588,6 +2611,7 @@

    +

    The client must have been previously authorized for the specified facade.

    @@ -2692,6 +2716,7 @@

    +

    Parameters
    @@ -2821,6 +2846,7 @@

    +

    Parameters
    @@ -2928,6 +2954,7 @@

    +

    Tags @@ -3002,6 +3029,7 @@

    +

    Parameters
    @@ -3086,6 +3114,7 @@

    +

    Parameters
    @@ -3169,6 +3198,7 @@

    +

    Parameters
    @@ -3271,6 +3301,7 @@

    +

    Parameters
    @@ -3402,6 +3433,7 @@

    +

    Tags @@ -3469,6 +3501,7 @@

    +

    Parameters
    @@ -3556,6 +3589,7 @@

    +

    Parameters
    @@ -3643,6 +3677,7 @@

    +

    Parameters
    @@ -3718,6 +3753,7 @@

    +

    Parameters
    @@ -3801,6 +3837,7 @@

    +

    Parameters
    @@ -3892,6 +3929,7 @@

    +

    The limit and offset parameters specify pages for large query sets.

    @@ -4026,6 +4064,7 @@

    +

    Tags @@ -4097,6 +4136,7 @@

    +

    Tags @@ -4156,6 +4196,7 @@

    +

    Parameters
    @@ -4242,6 +4283,7 @@

    +

    Parameters
    @@ -4329,6 +4371,7 @@

    +

    Parameters
    @@ -4412,6 +4455,7 @@

    +

    Parameters
    @@ -4499,6 +4543,7 @@

    +

    Parameters
    @@ -4578,6 +4623,7 @@

    +

    Parameters
    @@ -4661,6 +4707,7 @@

    +

    Parameters
    @@ -4748,6 +4795,7 @@

    +

    Parameters
    @@ -4840,6 +4888,7 @@

    +

    Parameters
    @@ -4959,6 +5008,7 @@

    +

    Parameters
    @@ -5051,6 +5101,7 @@

    +

    Parameters
    @@ -5139,6 +5190,7 @@

    +

    Parameters
    @@ -5229,6 +5281,7 @@

    + @@ -5271,6 +5324,7 @@

    + @@ -5313,6 +5367,7 @@

    + @@ -5355,6 +5410,7 @@

    + @@ -5397,6 +5453,7 @@

    + @@ -5439,6 +5496,7 @@

    + @@ -5481,6 +5539,7 @@

    + @@ -5523,6 +5582,7 @@

    + @@ -5565,6 +5625,7 @@

    + @@ -5604,6 +5665,7 @@

    +

    Parameters
    @@ -5669,6 +5731,7 @@

    + @@ -5704,6 +5767,7 @@

    +

    Parameters
    @@ -5868,75 +5932,75 @@
    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Env.html b/docs/classes/BitPaySDK-Env.html index 2132b2b2..ab14ca50 100644 --- a/docs/classes/BitPaySDK-Env.html +++ b/docs/classes/BitPaySDK-Env.html @@ -146,6 +146,7 @@

    +

    Tags @@ -195,49 +196,49 @@

    - BITPAY_API_FRAME + BITPAY_API_FRAME  = "std"
    - BITPAY_API_FRAME_VERSION + BITPAY_API_FRAME_VERSION  = "1.0.0"
    - BITPAY_API_VERSION + BITPAY_API_VERSION  = "2.0.0"
    - BITPAY_PLUGIN_INFO + BITPAY_PLUGIN_INFO -  = "BitPay_PHP_Client_v9.0.3" +  = "BitPay_PHP_Client_v9.0.4"
    - PROD + PROD  = "Prod"
    - PROD_URL + PROD_URL  = "https://bitpay.com/"
    - TEST + TEST  = "Test"
    - TEST_URL + TEST_URL  = "https://test.bitpay.com/"
    @@ -272,6 +273,7 @@

    + public mixed @@ -302,6 +304,7 @@

    + public mixed @@ -332,6 +335,7 @@

    + public mixed @@ -362,11 +366,12 @@

    + public mixed BITPAY_PLUGIN_INFO - = "BitPay_PHP_Client_v9.0.3" + = "BitPay_PHP_Client_v9.0.4" @@ -392,6 +397,7 @@

    + public mixed @@ -422,6 +428,7 @@

    + public mixed @@ -452,6 +459,7 @@

    + public mixed @@ -482,6 +490,7 @@

    + public mixed @@ -611,14 +620,14 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayApiException.html b/docs/classes/BitPaySDK-Exceptions-BitPayApiException.html index c1264d62..84c7f099 100644 --- a/docs/classes/BitPaySDK-Exceptions-BitPayApiException.html +++ b/docs/classes/BitPaySDK-Exceptions-BitPayApiException.html @@ -163,6 +163,7 @@

    +

    Table of Contents @@ -184,7 +185,7 @@

    - $bitPayCode + $bitPayCode  : string|null
    @@ -198,14 +199,14 @@

    - __construct() + __construct()  : mixed
    BitPayException constructor.
    - getBitPayCode() + getBitPayCode()  : string|null
    @@ -250,6 +251,7 @@

    + private string|null @@ -298,6 +300,7 @@

    +

    Parameters
    @@ -355,6 +358,7 @@

    + @@ -477,15 +481,15 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayException.html b/docs/classes/BitPaySDK-Exceptions-BitPayException.html index 70f6e2e0..f9488e4f 100644 --- a/docs/classes/BitPaySDK-Exceptions-BitPayException.html +++ b/docs/classes/BitPaySDK-Exceptions-BitPayException.html @@ -165,6 +165,7 @@

    +

    Table of Contents diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayExceptionProvider.html b/docs/classes/BitPaySDK-Exceptions-BitPayExceptionProvider.html index 159124ff..e7ef6642 100644 --- a/docs/classes/BitPaySDK-Exceptions-BitPayExceptionProvider.html +++ b/docs/classes/BitPaySDK-Exceptions-BitPayExceptionProvider.html @@ -160,6 +160,7 @@

    +

    Table of Contents @@ -179,7 +180,7 @@

    - GENERIC_API_UNMAPPED_ERROR_CODE + GENERIC_API_UNMAPPED_ERROR_CODE  = "000000"
    @@ -195,49 +196,49 @@

    - throwApiExceptionByArrayResponse() + throwApiExceptionByArrayResponse()  : void
    - throwApiExceptionWithMessage() + throwApiExceptionWithMessage()  : void
    - throwDeserializeException() + throwDeserializeException()  : void
    - throwDeserializeResourceException() + throwDeserializeResourceException()  : void
    - throwGenericExceptionWithMessage() + throwGenericExceptionWithMessage()  : void
    - throwInvalidCurrencyException() + throwInvalidCurrencyException()  : void
    - throwValidationException() + throwValidationException()  : void
    - logErrorMessage() + logErrorMessage()  : void
    @@ -268,6 +269,7 @@

    public mixed @@ -319,6 +321,7 @@

    +

    Parameters
    @@ -377,6 +380,7 @@

    +

    Parameters
    @@ -435,6 +439,7 @@

    +

    Parameters
    @@ -493,6 +498,7 @@

    +

    Parameters
    @@ -558,6 +564,7 @@

    +

    Parameters
    @@ -616,6 +623,7 @@

    +

    Parameters
    @@ -674,6 +682,7 @@

    +

    Parameters
    @@ -732,6 +741,7 @@

    +

    Parameters
    @@ -861,7 +871,7 @@
    Parameters
  • Constants
    • @@ -869,14 +879,14 @@
    Parameters
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayGenericException.html b/docs/classes/BitPaySDK-Exceptions-BitPayGenericException.html index 825c8d71..8b82e6a3 100644 --- a/docs/classes/BitPaySDK-Exceptions-BitPayGenericException.html +++ b/docs/classes/BitPaySDK-Exceptions-BitPayGenericException.html @@ -163,6 +163,7 @@

    +

    Table of Contents diff --git a/docs/classes/BitPaySDK-Exceptions-BitPayValidationException.html b/docs/classes/BitPaySDK-Exceptions-BitPayValidationException.html index 7d09ad5b..b3bbd943 100644 --- a/docs/classes/BitPaySDK-Exceptions-BitPayValidationException.html +++ b/docs/classes/BitPaySDK-Exceptions-BitPayValidationException.html @@ -163,6 +163,7 @@

    +

    Table of Contents diff --git a/docs/classes/BitPaySDK-Logger-BitPayLogger.html b/docs/classes/BitPaySDK-Logger-BitPayLogger.html index a7a1d706..1797de2c 100644 --- a/docs/classes/BitPaySDK-Logger-BitPayLogger.html +++ b/docs/classes/BitPaySDK-Logger-BitPayLogger.html @@ -151,6 +151,7 @@

    +

    Table of Contents @@ -173,19 +174,19 @@

    - logError() + logError()  : void
    - logRequest() + logRequest()  : void
    - logResponse() + logResponse()  : void
    @@ -229,6 +230,7 @@

    +

    Parameters
    @@ -272,6 +274,7 @@

    +

    Parameters
    @@ -329,6 +332,7 @@

    +

    Parameters
    @@ -472,9 +476,9 @@
    Parameters
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Logger-EmptyLogger.html b/docs/classes/BitPaySDK-Logger-EmptyLogger.html index 68114d4e..fa0e803f 100644 --- a/docs/classes/BitPaySDK-Logger-EmptyLogger.html +++ b/docs/classes/BitPaySDK-Logger-EmptyLogger.html @@ -163,6 +163,7 @@

    +

    Table of Contents @@ -192,19 +193,19 @@

    - logError() + logError()  : void
    - logRequest() + logRequest()  : void
    - logResponse() + logResponse()  : void
    @@ -249,6 +250,7 @@

    +

    Parameters
    @@ -292,6 +294,7 @@

    +

    Parameters
    @@ -349,6 +352,7 @@

    +

    Parameters
    @@ -493,9 +497,9 @@
    Parameters
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Logger-LoggerProvider.html b/docs/classes/BitPaySDK-Logger-LoggerProvider.html index edb2fe10..7de1faa9 100644 --- a/docs/classes/BitPaySDK-Logger-LoggerProvider.html +++ b/docs/classes/BitPaySDK-Logger-LoggerProvider.html @@ -160,6 +160,7 @@

    +

    Table of Contents @@ -181,7 +182,7 @@

    - $logger + $logger  : BitPayLogger|null
    @@ -195,19 +196,19 @@

    - getLogger() + getLogger()  : BitPayLogger
    - setLogger() + setLogger()  : void
    - __construct() + __construct()  : mixed
    @@ -247,6 +248,7 @@

    + private static BitPayLogger|null @@ -296,6 +298,7 @@

    + @@ -331,6 +334,7 @@

    +

    Parameters
    @@ -376,6 +380,7 @@

    + @@ -494,16 +499,16 @@

  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Bill-Bill.html b/docs/classes/BitPaySDK-Model-Bill-Bill.html index 085f529d..8a01c261 100644 --- a/docs/classes/BitPaySDK-Model-Bill-Bill.html +++ b/docs/classes/BitPaySDK-Model-Bill-Bill.html @@ -158,6 +158,7 @@

    +

    Tags @@ -209,127 +210,127 @@

    - $address1 + $address1  : string|null
    - $address2 + $address2  : string|null
    - $cc + $cc  : array<string|int, mixed>|null
    - $city + $city  : string|null
    - $country + $country  : string|null
    - $createDate + $createDate  : string|null
    - $currency + $currency  : string|null
    - $dueDate + $dueDate  : string|null
    - $email + $email  : string|null
    - $id + $id  : string|null
    - $items + $items  : array<string|int, mixed>
    - $merchant + $merchant  : string|null
    - $name + $name  : string|null
    - $number + $number  : string|null
    - $passProcessingFee + $passProcessingFee  : bool|null
    - $phone + $phone  : string|null
    - $state + $state  : string|null
    - $status + $status  : string|null
    - $token + $token  : string|null
    - $url + $url  : string|null
    - $zip + $zip  : string|null
    @@ -343,315 +344,315 @@

    - __construct() + __construct()  : mixed
    Constructor, create a minimal request Bill object.
    - getAddress1() + getAddress1()  : string|null
    Gets Bill recipient's address
    - getAddress2() + getAddress2()  : string|null
    Gets Bill recipient's address
    - getCc() + getCc()  : array<string|int, mixed>|null
    Gets Bill cc
    - getCity() + getCity()  : string|null
    Gets Bill recipient's city
    - getCountry() + getCountry()  : string|null
    Gets Bill recipient's country
    - getCreateDate() + getCreateDate()  : string|null
    Gets bill create date
    - getCurrency() + getCurrency()  : string|null
    Gets bill currency
    - getDueDate() + getDueDate()  : string|null
    Gets Bill due date
    - getEmail() + getEmail()  : string|null
    Gets bill email
    - getId() + getId()  : string|null
    Gets bill id
    - getItems() + getItems()  : array<string|int, mixed>
    Gets items from bill
    - getItemsAsArray() + getItemsAsArray()  : array<string|int, mixed>|null
    Gets items as array from bill
    - getMerchant() + getMerchant()  : string|null
    Gets bill merchant
    - getName() + getName()  : string|null
    Gets Bill recipient's name
    - getNumber() + getNumber()  : string|null
    Gets bill number
    - getPassProcessingFee() + getPassProcessingFee()  : bool|null
    Gets bill pass processing fee
    - getPhone() + getPhone()  : string|null
    Gets Bill recipient's phone number
    - getState() + getState()  : string|null
    Gets Bill recipient's state or province
    - getStatus() + getStatus()  : string|null
    Gets bill status
    - getToken() + getToken()  : string|null
    Gets token
    - getUrl() + getUrl()  : string|null
    Gets bill url
    - getZip() + getZip()  : string|null
    Gets Bill recipient's ZIP code
    - setAddress1() + setAddress1()  : void
    Sets Bill recipient's address
    - setAddress2() + setAddress2()  : void
    Sets Bill recipient's address
    - setCc() + setCc()  : void
    Sets Bill's cc
    - setCity() + setCity()  : void
    Sets Bill recipient's city
    - setCountry() + setCountry()  : void
    Sets Bill recipient's country
    - setCreateDate() + setCreateDate()  : void
    Sets Bill's create date
    - setCurrency() + setCurrency()  : void
    Sets Bill's currency
    - setDueDate() + setDueDate()  : void
    Sets Bill's due date
    - setEmail() + setEmail()  : void
    Sets Bill's email
    - setId() + setId()  : void
    Sets Bill's id
    - setItems() + setItems()  : void
    Sets Bill's items
    - setMerchant() + setMerchant()  : void
    Sets Bill's merchant
    - setName() + setName()  : void
    Sets Bill recipient's name
    - setNumber() + setNumber()  : void
    Sets Bill's number
    - setPassProcessingFee() + setPassProcessingFee()  : void
    Sets Bill's pass processing fee
    - setPhone() + setPhone()  : void
    Sets Bill recipient's phone number
    - setState() + setState()  : void
    Sets Bill recipient's state or province
    - setStatus() + setStatus()  : void
    Sets Bill's status
    - setToken() + setToken()  : void
    Sets Bill's token
    - setUrl() + setUrl()  : void
    Sets Bill's url
    - setZip() + setZip()  : void
    Sets Bill recipient's ZIP code
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -692,6 +693,7 @@

    + protected string|null @@ -727,6 +729,7 @@

    + protected string|null @@ -762,6 +765,7 @@

    + protected array<string|int, mixed>|null @@ -797,6 +801,7 @@

    + protected string|null @@ -832,6 +837,7 @@

    + protected string|null @@ -867,6 +873,7 @@

    + protected string|null @@ -902,6 +909,7 @@

    + protected string|null @@ -937,6 +945,7 @@

    + protected string|null @@ -972,6 +981,7 @@

    + protected string|null @@ -1007,6 +1017,7 @@

    + protected string|null @@ -1042,6 +1053,7 @@

    + protected array<string|int, mixed> @@ -1077,6 +1089,7 @@

    + protected string|null @@ -1112,6 +1125,7 @@

    + protected string|null @@ -1147,6 +1161,7 @@

    + protected string|null @@ -1182,6 +1197,7 @@

    + protected bool|null @@ -1217,6 +1233,7 @@

    + protected string|null @@ -1252,6 +1269,7 @@

    + protected string|null @@ -1287,6 +1305,7 @@

    + protected string|null @@ -1322,6 +1341,7 @@

    + protected string|null @@ -1357,6 +1377,7 @@

    + protected string|null @@ -1392,6 +1413,7 @@

    + protected string|null @@ -1440,6 +1462,7 @@

    +

    Parameters
    @@ -1515,6 +1538,7 @@

    + @@ -1557,6 +1581,7 @@

    + @@ -1596,6 +1621,7 @@

    +

    Email addresses to which a copy of the bill must be sent

    @@ -1643,6 +1669,7 @@

    + @@ -1685,6 +1712,7 @@

    + @@ -1724,6 +1752,7 @@

    +

    Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)

    @@ -1768,6 +1797,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the price field

    @@ -1812,6 +1842,7 @@

    +

    Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)

    @@ -1859,6 +1890,7 @@

    + @@ -1898,6 +1930,7 @@

    +

    Bill resource id

    @@ -1945,6 +1978,7 @@

    + @@ -1987,6 +2021,7 @@

    + @@ -2026,6 +2061,7 @@

    +

    Internal identifier for BitPay, this field can be ignored by the merchants.

    @@ -2073,6 +2109,7 @@

    + @@ -2112,6 +2149,7 @@

    +

    Bill identifier, specified by merchant

    @@ -2159,6 +2197,7 @@

    + @@ -2201,6 +2240,7 @@

    + @@ -2243,6 +2283,7 @@

    + @@ -2282,6 +2323,7 @@

    +

    Can "draft", "sent", "new", "paid", or "complete"

    @@ -2326,6 +2368,7 @@

    +

    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.

    @@ -2371,6 +2414,7 @@

    +

    Web address of bill

    @@ -2418,6 +2462,7 @@

    + @@ -2458,6 +2503,7 @@

    +

    Parameters
    @@ -2504,6 +2550,7 @@

    +

    Parameters
    @@ -2549,6 +2596,7 @@

    +

    Email addresses to which a copy of the bill must be sent

    @@ -2598,6 +2646,7 @@

    +

    Parameters
    @@ -2644,6 +2693,7 @@

    +

    Parameters
    @@ -2689,6 +2739,7 @@

    +

    Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)

    @@ -2737,6 +2788,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the price field

    @@ -2800,6 +2852,7 @@

    +

    Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)

    @@ -2849,6 +2902,7 @@

    +

    Parameters
    @@ -2894,6 +2948,7 @@

    +

    Bill resource id

    @@ -2943,6 +2998,7 @@

    +

    Parameters
    @@ -2988,6 +3044,7 @@

    +

    Internal identifier for BitPay, this field can be ignored by the merchants.

    @@ -3037,6 +3094,7 @@

    +

    Parameters
    @@ -3082,6 +3140,7 @@

    +

    Bill identifier, specified by merchant

    @@ -3130,6 +3189,7 @@

    +

    If set to true, BitPay's processing fee will be included in the amount charged on the invoice

    @@ -3179,6 +3239,7 @@

    +

    Parameters
    @@ -3225,6 +3286,7 @@

    +

    Parameters
    @@ -3270,6 +3332,7 @@

    +

    Can "draft", "sent", "new", "paid", or "complete"

    @@ -3318,6 +3381,7 @@

    +

    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.

    @@ -3367,6 +3431,7 @@

    +

    Web address of bill

    @@ -3416,6 +3481,7 @@

    +

    Parameters
    @@ -3464,6 +3530,7 @@

    + @@ -3590,78 +3657,78 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Bill-BillStatus.html b/docs/classes/BitPaySDK-Model-Bill-BillStatus.html index 170118b4..bceeecbe 100644 --- a/docs/classes/BitPaySDK-Model-Bill-BillStatus.html +++ b/docs/classes/BitPaySDK-Model-Bill-BillStatus.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,31 +210,31 @@

    - COMPLETE + COMPLETE  = "complete"
    - DRAFT + DRAFT  = "draft"
    - NEW + NEW  = "new"
    - PAID + PAID  = "paid"
    - SENT + SENT  = "sent"
    @@ -268,6 +269,7 @@

    + public mixed @@ -298,6 +300,7 @@

    + public mixed @@ -328,6 +331,7 @@

    + public mixed @@ -358,6 +362,7 @@

    + public mixed @@ -388,6 +393,7 @@

    + public mixed @@ -517,11 +523,11 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Bill-Item.html b/docs/classes/BitPaySDK-Model-Bill-Item.html index 9acc8ae2..08fde170 100644 --- a/docs/classes/BitPaySDK-Model-Bill-Item.html +++ b/docs/classes/BitPaySDK-Model-Bill-Item.html @@ -158,6 +158,7 @@

    +

    Tags @@ -230,25 +231,25 @@

    - $description + $description  : string|null
    - $id + $id  : string|null
    - $price + $price  : float|null
    - $quantity + $quantity  : int|null
    @@ -262,75 +263,75 @@

    - __construct() + __construct()  : mixed
    - createFromArray() + createFromArray()  : Item
    - getDescription() + getDescription()  : string|null
    Gets Line item description
    - getId() + getId()  : string|null
    Gets id.
    - getPrice() + getPrice()  : float|null
    Gets Line item unit price for the corresponding currency
    - getQuantity() + getQuantity()  : int|null
    Gets Line item number of units
    - setDescription() + setDescription()  : void
    Sets Line item description
    - setId() + setId()  : void
    Sets id.
    - setPrice() + setPrice()  : void
    Sets Line item unit price for the corresponding currency
    - setQuantity() + setQuantity()  : void
    Sets Line item number of units
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -371,6 +372,7 @@

    + protected string|null @@ -406,6 +408,7 @@

    + protected string|null @@ -441,6 +444,7 @@

    + protected float|null @@ -476,6 +480,7 @@

    + protected int|null @@ -525,6 +530,7 @@

    + @@ -556,6 +562,7 @@

    +

    Parameters
    @@ -608,6 +615,7 @@

    + @@ -650,6 +658,7 @@

    + @@ -692,6 +701,7 @@

    + @@ -734,6 +744,7 @@

    + @@ -774,6 +785,7 @@

    +

    Parameters
    @@ -820,6 +832,7 @@

    +

    Parameters
    @@ -866,6 +879,7 @@

    +

    Parameters
    @@ -912,6 +926,7 @@

    +

    Parameters
    @@ -960,6 +975,7 @@

    + @@ -1086,27 +1102,27 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Currency.html b/docs/classes/BitPaySDK-Model-Currency.html index 899b72c2..90a72ae9 100644 --- a/docs/classes/BitPaySDK-Model-Currency.html +++ b/docs/classes/BitPaySDK-Model-Currency.html @@ -157,6 +157,7 @@

    +

    Tags @@ -206,1075 +207,1075 @@

    - AED + AED  = "AED"
    - AFN + AFN  = "AFN"
    - ALL + ALL  = "ALL"
    - AMD + AMD  = "AMD"
    - ANG + ANG  = "ANG"
    - AOA + AOA  = "AOA"
    - ARS + ARS  = "ARS"
    - AUD + AUD  = "AUD"
    - AWG + AWG  = "AWG"
    - AZN + AZN  = "AZN"
    - BAM + BAM  = "BAM"
    - BBD + BBD  = "BBD"
    - BCH + BCH  = "BCH"
    - BDT + BDT  = "BDT"
    - BGN + BGN  = "BGN"
    - BHD + BHD  = "BHD"
    - BIF + BIF  = "BIF"
    - BMD + BMD  = "BMD"
    - BND + BND  = "BND"
    - BOB + BOB  = "BOB"
    - BOV + BOV  = "BOV"
    - BRL + BRL  = "BRL"
    - BSD + BSD  = "BSD"
    - BTC + BTC  = "BTC"
    - BTN + BTN  = "BTN"
    - BUSD + BUSD  = "BUSD"
    - BWP + BWP  = "BWP"
    - BYR + BYR  = "BYR"
    - BZD + BZD  = "BZD"
    - CAD + CAD  = "CAD"
    - CDF + CDF  = "CDF"
    - CHE + CHE  = "CHE"
    - CHF + CHF  = "CHF"
    - CHW + CHW  = "CHW"
    - CLF + CLF  = "CLF"
    - CLP + CLP  = "CLP"
    - CNY + CNY  = "CNY"
    - COP + COP  = "COP"
    - COU + COU  = "COU"
    - CRC + CRC  = "CRC"
    - CUC + CUC  = "CUC"
    - CUP + CUP  = "CUP"
    - CVE + CVE  = "CVE"
    - CZK + CZK  = "CZK"
    - DJF + DJF  = "DJF"
    - DKK + DKK  = "DKK"
    - DOGE + DOGE  = "DOGE"
    - DOP + DOP  = "DOP"
    - DZD + DZD  = "DZD"
    - EGP + EGP  = "EGP"
    - ERN + ERN  = "ERN"
    - ETB + ETB  = "ETB"
    - ETH + ETH  = "ETH"
    - EUR + EUR  = "EUR"
    - FJD + FJD  = "FJD"
    - FKP + FKP  = "FKP"
    - GBP + GBP  = "GBP"
    - GEL + GEL  = "GEL"
    - GHS + GHS  = "GHS"
    - GIP + GIP  = "GIP"
    - GMD + GMD  = "GMD"
    - GNF + GNF  = "GNF"
    - GTQ + GTQ  = "GTQ"
    - GUSD + GUSD  = "GUSD"
    - GYD + GYD  = "GYD"
    - HKD + HKD  = "HKD"
    - HNL + HNL  = "HNL"
    - HRK + HRK  = "HRK"
    - HTG + HTG  = "HTG"
    - HUF + HUF  = "HUF"
    - IDR + IDR  = "IDR"
    - ILS + ILS  = "ILS"
    - INR + INR  = "INR"
    - IQD + IQD  = "IQD"
    - IRR + IRR  = "IRR"
    - ISK + ISK  = "ISK"
    - JMD + JMD  = "JMD"
    - JOD + JOD  = "JOD"
    - JPY + JPY  = "JPY"
    - KES + KES  = "KES"
    - KGS + KGS  = "KGS"
    - KHR + KHR  = "KHR"
    - KMF + KMF  = "KMF"
    - KPW + KPW  = "KPW"
    - KRW + KRW  = "KRW"
    - KWD + KWD  = "KWD"
    - KYD + KYD  = "KYD"
    - KZT + KZT  = "KZT"
    - LAK + LAK  = "LAK"
    - LBP + LBP  = "LBP"
    - LKR + LKR  = "LKR"
    - LRD + LRD  = "LRD"
    - LSL + LSL  = "LSL"
    - LTC + LTC  = "LTC"
    - LYD + LYD  = "LYD"
    - MAD + MAD  = "MAD"
    - MDL + MDL  = "MDL"
    - MGA + MGA  = "MGA"
    - MKD + MKD  = "MKD"
    - MMK + MMK  = "MMK"
    - MNT + MNT  = "MNT"
    - MOP + MOP  = "MOP"
    - MRU + MRU  = "MRU"
    - MUR + MUR  = "MUR"
    - MVR + MVR  = "MVR"
    - MWK + MWK  = "MWK"
    - MXN + MXN  = "MXN"
    - MXV + MXV  = "MXV"
    - MYR + MYR  = "MYR"
    - MZN + MZN  = "MZN"
    - NAD + NAD  = "NAD"
    - NGN + NGN  = "NGN"
    - NIO + NIO  = "NIO"
    - NOK + NOK  = "NOK"
    - NPR + NPR  = "NPR"
    - NZD + NZD  = "NZD"
    - OMR + OMR  = "OMR"
    - PAB + PAB  = "PAB"
    - PAX + PAX  = "PAX"
    - PEN + PEN  = "PEN"
    - PGK + PGK  = "PGK"
    - PHP + PHP  = "PHP"
    - PKR + PKR  = "PKR"
    - PLN + PLN  = "PLN"
    - PYG + PYG  = "PYG"
    - QAR + QAR  = "QAR"
    - RON + RON  = "RON"
    - RSD + RSD  = "RSD"
    - RUB + RUB  = "RUB"
    - RWF + RWF  = "RWF"
    - SAR + SAR  = "SAR"
    - SBD + SBD  = "SBD"
    - SCR + SCR  = "SCR"
    - SDG + SDG  = "SDG"
    - SEK + SEK  = "SEK"
    - SGD + SGD  = "SGD"
    - SHIB + SHIB  = "SHIB"
    - SHP + SHP  = "SHP"
    - SLL + SLL  = "SLL"
    - SOS + SOS  = "SOS"
    - SRD + SRD  = "SRD"
    - SSP + SSP  = "SSP"
    - STN + STN  = "STN"
    - SVC + SVC  = "SVC"
    - SYP + SYP  = "SYP"
    - SZL + SZL  = "SZL"
    - THB + THB  = "THB"
    - TJS + TJS  = "TJS"
    - TMT + TMT  = "TMT"
    - TND + TND  = "TND"
    - TOP + TOP  = "TOP"
    - TRY + TRY  = "TRY"
    - TTD + TTD  = "TTD"
    - TWD + TWD  = "TWD"
    - TZS + TZS  = "TZS"
    - UAH + UAH  = "UAH"
    - UGX + UGX  = "UGX"
    - USD + USD  = "USD"
    - USDC + USDC  = "USDC"
    - USN + USN  = "USN"
    - UYI + UYI  = "UYI"
    - UYU + UYU  = "UYU"
    - UZS + UZS  = "UZS"
    - VEF + VEF  = "VEF"
    - VND + VND  = "VND"
    - VUV + VUV  = "VUV"
    - WST + WST  = "WST"
    - XAF + XAF  = "XAF"
    - XCD + XCD  = "XCD"
    - XDR + XDR  = "XDR"
    - XOF + XOF  = "XOF"
    - XPF + XPF  = "XPF"
    - XRP + XRP  = "XRP"
    - XSU + XSU  = "XSU"
    - XUA + XUA  = "XUA"
    - YER + YER  = "YER"
    - ZAR + ZAR  = "ZAR"
    - ZMW + ZMW  = "ZMW"
    - ZWL + ZWL  = "ZWL"
    @@ -1289,91 +1290,91 @@

    - $alts + $alts  : string|null
    - $chain + $chain  : string|null
    - $code + $code  : string|null
    - $contractAddress + $contractAddress  : string|null
    - $currentlySettled + $currentlySettled  : bool|null
    - $decimals + $decimals  : int|null
    - $displayCode + $displayCode  : string|null
    - $maxSupply + $maxSupply  : string|null
    - $minimum + $minimum  : string|null
    - $name + $name  : string|null
    - $plural + $plural  : string|null
    - $precision + $precision  : int|null
    - $sanctioned + $sanctioned  : bool|null
    - $symbol + $symbol  : string|null
    - $trancheDecimals + $trancheDecimals  : int|null
    @@ -1387,220 +1388,220 @@

    - __construct() + __construct()  : mixed
    - getAlts() + getAlts()  : string|null
    Gets alternative currency name(s)
    - getChain() + getChain()  : string|null
    - getCode() + getCode()  : string|null
    Get ISO 4217 3-character currency code
    - getContractAddress() + getContractAddress()  : string|null
    - getCurrentlySettled() + getCurrentlySettled()  : bool|null
    Gets currently settled value
    - getDecimals() + getDecimals()  : int|null
    Gets decimal precision
    - getDisplayCode() + getDisplayCode()  : string|null
    - getMaxSupply() + getMaxSupply()  : string|null
    - getMinimum() + getMinimum()  : string|null
    Gets minimum supported value when creating an invoice, bill or payout for instance
    - getName() + getName()  : string|null
    Gets currency name
    - getPlural() + getPlural()  : string|null
    Gets English plural form
    - getPrecision() + getPrecision()  : int|null
    Number of decimal places
    - getSanctioned() + getSanctioned()  : bool|null
    Gets if the currency is linked to a sanctionned country
    - getSymbol() + getSymbol()  : string|null
    Display symbol
    - getTrancheDecimals() + getTrancheDecimals()  : int|null
    - isValid() + isValid()  : bool
    Currency validation
    - setAlts() + setAlts()  : void
    Sets alternative currency name(s)
    - setChain() + setChain()  : void
    - setCode() + setCode()  : void
    Sets ISO 4217 3-character currency code
    - setContractAddress() + setContractAddress()  : void
    - setCurrentlySettled() + setCurrentlySettled()  : void
    Sets currently settled value
    - setDecimals() + setDecimals()  : void
    Sets decimal precision
    - setDisplayCode() + setDisplayCode()  : void
    - setMaxSupply() + setMaxSupply()  : void
    - setMinimum() + setMinimum()  : void
    Sets minimum supported value when creating an invoice, bill or payout for instance
    - setName() + setName()  : void
    Sets currency name
    - setPlural() + setPlural()  : void
    Sets English plural form
    - setPrecision() + setPrecision()  : void
    Sets number of decimal places
    - setSanctioned() + setSanctioned()  : void
    Sets if the currency is linked to a sanctionned country
    - setSymbol() + setSymbol()  : void
    Sets symbol
    - setTrancheDecimals() + setTrancheDecimals()  : void
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -1632,6 +1633,7 @@

    + public mixed @@ -1662,6 +1664,7 @@

    + public mixed @@ -1692,6 +1695,7 @@

    + public mixed @@ -1722,6 +1726,7 @@

    + public mixed @@ -1752,6 +1757,7 @@

    + public mixed @@ -1782,6 +1788,7 @@

    + public mixed @@ -1812,6 +1819,7 @@

    + public mixed @@ -1842,6 +1850,7 @@

    + public mixed @@ -1872,6 +1881,7 @@

    + public mixed @@ -1902,6 +1912,7 @@

    + public mixed @@ -1932,6 +1943,7 @@

    + public mixed @@ -1962,6 +1974,7 @@

    + public mixed @@ -1992,6 +2005,7 @@

    + public mixed @@ -2022,6 +2036,7 @@

    + public mixed @@ -2052,6 +2067,7 @@

    + public mixed @@ -2082,6 +2098,7 @@

    + public mixed @@ -2112,6 +2129,7 @@

    + public mixed @@ -2142,6 +2160,7 @@

    + public mixed @@ -2172,6 +2191,7 @@

    + public mixed @@ -2202,6 +2222,7 @@

    + public mixed @@ -2232,6 +2253,7 @@

    + public mixed @@ -2262,6 +2284,7 @@

    + public mixed @@ -2292,6 +2315,7 @@

    + public mixed @@ -2322,6 +2346,7 @@

    + public mixed @@ -2352,6 +2377,7 @@

    + public mixed @@ -2382,6 +2408,7 @@

    + public mixed @@ -2412,6 +2439,7 @@

    + public mixed @@ -2442,6 +2470,7 @@

    + public mixed @@ -2472,6 +2501,7 @@

    + public mixed @@ -2502,6 +2532,7 @@

    + public mixed @@ -2532,6 +2563,7 @@

    + public mixed @@ -2562,6 +2594,7 @@

    + public mixed @@ -2592,6 +2625,7 @@

    + public mixed @@ -2622,6 +2656,7 @@

    + public mixed @@ -2652,6 +2687,7 @@

    + public mixed @@ -2682,6 +2718,7 @@

    + public mixed @@ -2712,6 +2749,7 @@

    + public mixed @@ -2742,6 +2780,7 @@

    + public mixed @@ -2772,6 +2811,7 @@

    + public mixed @@ -2802,6 +2842,7 @@

    + public mixed @@ -2832,6 +2873,7 @@

    + public mixed @@ -2862,6 +2904,7 @@

    + public mixed @@ -2892,6 +2935,7 @@

    + public mixed @@ -2922,6 +2966,7 @@

    + public mixed @@ -2952,6 +2997,7 @@

    + public mixed @@ -2982,6 +3028,7 @@

    + public mixed @@ -3012,6 +3059,7 @@

    + public mixed @@ -3042,6 +3090,7 @@

    + public mixed @@ -3072,6 +3121,7 @@

    + public mixed @@ -3102,6 +3152,7 @@

    + public mixed @@ -3132,6 +3183,7 @@

    + public mixed @@ -3162,6 +3214,7 @@

    + public mixed @@ -3192,6 +3245,7 @@

    + public mixed @@ -3222,6 +3276,7 @@

    + public mixed @@ -3252,6 +3307,7 @@

    + public mixed @@ -3282,6 +3338,7 @@

    + public mixed @@ -3312,6 +3369,7 @@

    + public mixed @@ -3342,6 +3400,7 @@

    + public mixed @@ -3372,6 +3431,7 @@

    + public mixed @@ -3402,6 +3462,7 @@

    + public mixed @@ -3432,6 +3493,7 @@

    + public mixed @@ -3462,6 +3524,7 @@

    + public mixed @@ -3492,6 +3555,7 @@

    + public mixed @@ -3522,6 +3586,7 @@

    + public mixed @@ -3552,6 +3617,7 @@

    + public mixed @@ -3582,6 +3648,7 @@

    + public mixed @@ -3612,6 +3679,7 @@

    + public mixed @@ -3642,6 +3710,7 @@

    + public mixed @@ -3672,6 +3741,7 @@

    + public mixed @@ -3702,6 +3772,7 @@

    + public mixed @@ -3732,6 +3803,7 @@

    + public mixed @@ -3762,6 +3834,7 @@

    + public mixed @@ -3792,6 +3865,7 @@

    + public mixed @@ -3822,6 +3896,7 @@

    + public mixed @@ -3852,6 +3927,7 @@

    + public mixed @@ -3882,6 +3958,7 @@

    + public mixed @@ -3912,6 +3989,7 @@

    + public mixed @@ -3942,6 +4020,7 @@

    + public mixed @@ -3972,6 +4051,7 @@

    + public mixed @@ -4002,6 +4082,7 @@

    + public mixed @@ -4032,6 +4113,7 @@

    + public mixed @@ -4062,6 +4144,7 @@

    + public mixed @@ -4092,6 +4175,7 @@

    + public mixed @@ -4122,6 +4206,7 @@

    + public mixed @@ -4152,6 +4237,7 @@

    + public mixed @@ -4182,6 +4268,7 @@

    + public mixed @@ -4212,6 +4299,7 @@

    + public mixed @@ -4242,6 +4330,7 @@

    + public mixed @@ -4272,6 +4361,7 @@

    + public mixed @@ -4302,6 +4392,7 @@

    + public mixed @@ -4332,6 +4423,7 @@

    + public mixed @@ -4362,6 +4454,7 @@

    + public mixed @@ -4392,6 +4485,7 @@

    + public mixed @@ -4422,6 +4516,7 @@

    + public mixed @@ -4452,6 +4547,7 @@

    + public mixed @@ -4482,6 +4578,7 @@

    + public mixed @@ -4512,6 +4609,7 @@

    + public mixed @@ -4542,6 +4640,7 @@

    + public mixed @@ -4572,6 +4671,7 @@

    + public mixed @@ -4602,6 +4702,7 @@

    + public mixed @@ -4632,6 +4733,7 @@

    + public mixed @@ -4662,6 +4764,7 @@

    + public mixed @@ -4692,6 +4795,7 @@

    + public mixed @@ -4722,6 +4826,7 @@

    + public mixed @@ -4752,6 +4857,7 @@

    + public mixed @@ -4782,6 +4888,7 @@

    + public mixed @@ -4812,6 +4919,7 @@

    + public mixed @@ -4842,6 +4950,7 @@

    + public mixed @@ -4872,6 +4981,7 @@

    + public mixed @@ -4902,6 +5012,7 @@

    + public mixed @@ -4932,6 +5043,7 @@

    + public mixed @@ -4962,6 +5074,7 @@

    + public mixed @@ -4992,6 +5105,7 @@

    + public mixed @@ -5022,6 +5136,7 @@

    + public mixed @@ -5052,6 +5167,7 @@

    + public mixed @@ -5082,6 +5198,7 @@

    + public mixed @@ -5112,6 +5229,7 @@

    + public mixed @@ -5142,6 +5260,7 @@

    + public mixed @@ -5172,6 +5291,7 @@

    + public mixed @@ -5202,6 +5322,7 @@

    + public mixed @@ -5232,6 +5353,7 @@

    + public mixed @@ -5262,6 +5384,7 @@

    + public mixed @@ -5292,6 +5415,7 @@

    + public mixed @@ -5322,6 +5446,7 @@

    + public mixed @@ -5352,6 +5477,7 @@

    + public mixed @@ -5382,6 +5508,7 @@

    + public mixed @@ -5412,6 +5539,7 @@

    + public mixed @@ -5442,6 +5570,7 @@

    + public mixed @@ -5472,6 +5601,7 @@

    + public mixed @@ -5502,6 +5632,7 @@

    + public mixed @@ -5532,6 +5663,7 @@

    + public mixed @@ -5562,6 +5694,7 @@

    + public mixed @@ -5592,6 +5725,7 @@

    + public mixed @@ -5622,6 +5756,7 @@

    + public mixed @@ -5652,6 +5787,7 @@

    + public mixed @@ -5682,6 +5818,7 @@

    + public mixed @@ -5712,6 +5849,7 @@

    + public mixed @@ -5742,6 +5880,7 @@

    + public mixed @@ -5772,6 +5911,7 @@

    + public mixed @@ -5802,6 +5942,7 @@

    + public mixed @@ -5832,6 +5973,7 @@

    + public mixed @@ -5862,6 +6004,7 @@

    + public mixed @@ -5892,6 +6035,7 @@

    + public mixed @@ -5922,6 +6066,7 @@

    + public mixed @@ -5952,6 +6097,7 @@

    + public mixed @@ -5982,6 +6128,7 @@

    + public mixed @@ -6012,6 +6159,7 @@

    + public mixed @@ -6042,6 +6190,7 @@

    + public mixed @@ -6072,6 +6221,7 @@

    + public mixed @@ -6102,6 +6252,7 @@

    + public mixed @@ -6132,6 +6283,7 @@

    + public mixed @@ -6162,6 +6314,7 @@

    + public mixed @@ -6192,6 +6345,7 @@

    + public mixed @@ -6222,6 +6376,7 @@

    + public mixed @@ -6252,6 +6407,7 @@

    + public mixed @@ -6282,6 +6438,7 @@

    + public mixed @@ -6312,6 +6469,7 @@

    + public mixed @@ -6342,6 +6500,7 @@

    + public mixed @@ -6372,6 +6531,7 @@

    + public mixed @@ -6402,6 +6562,7 @@

    + public mixed @@ -6432,6 +6593,7 @@

    + public mixed @@ -6462,6 +6624,7 @@

    + public mixed @@ -6492,6 +6655,7 @@

    + public mixed @@ -6522,6 +6686,7 @@

    + public mixed @@ -6552,6 +6717,7 @@

    + public mixed @@ -6582,6 +6748,7 @@

    + public mixed @@ -6612,6 +6779,7 @@

    + public mixed @@ -6642,6 +6810,7 @@

    + public mixed @@ -6672,6 +6841,7 @@

    + public mixed @@ -6702,6 +6872,7 @@

    + public mixed @@ -6732,6 +6903,7 @@

    + public mixed @@ -6762,6 +6934,7 @@

    + public mixed @@ -6792,6 +6965,7 @@

    + public mixed @@ -6822,6 +6996,7 @@

    + public mixed @@ -6852,6 +7027,7 @@

    + public mixed @@ -6882,6 +7058,7 @@

    + public mixed @@ -6912,6 +7089,7 @@

    + public mixed @@ -6942,6 +7120,7 @@

    + public mixed @@ -6972,6 +7151,7 @@

    + public mixed @@ -7018,6 +7198,7 @@

    + protected string|null @@ -7053,6 +7234,7 @@

    + protected string|null @@ -7088,6 +7270,7 @@

    + protected string|null @@ -7123,6 +7306,7 @@

    + protected string|null @@ -7158,6 +7342,7 @@

    + protected bool|null @@ -7193,6 +7378,7 @@

    + protected int|null @@ -7228,6 +7414,7 @@

    + protected string|null @@ -7263,6 +7450,7 @@

    + protected string|null @@ -7298,6 +7486,7 @@

    + protected string|null @@ -7333,6 +7522,7 @@

    + protected string|null @@ -7368,6 +7558,7 @@

    + protected string|null @@ -7403,6 +7594,7 @@

    + protected int|null @@ -7438,6 +7630,7 @@

    + protected bool|null @@ -7473,6 +7666,7 @@

    + protected string|null @@ -7508,6 +7702,7 @@

    + protected int|null @@ -7557,6 +7752,7 @@

    + @@ -7591,6 +7787,7 @@

    + @@ -7632,6 +7829,7 @@

    + @@ -7670,6 +7868,7 @@

    + @@ -7711,6 +7910,7 @@

    + @@ -7749,6 +7949,7 @@

    + @@ -7787,6 +7988,7 @@

    + @@ -7828,6 +8030,7 @@

    + @@ -7865,6 +8068,7 @@

    + @@ -7903,6 +8107,7 @@

    + @@ -7945,6 +8150,7 @@

    + @@ -7987,6 +8193,7 @@

    + @@ -8029,6 +8236,7 @@

    + @@ -8071,6 +8279,7 @@

    + @@ -8113,6 +8322,7 @@

    + @@ -8154,6 +8364,7 @@

    + @@ -8190,6 +8401,7 @@

    +

    Parameters
    @@ -8240,6 +8452,7 @@

    +

    Parameters
    @@ -8285,6 +8498,7 @@

    +

    Parameters
    @@ -8329,6 +8543,7 @@

    +

    Parameters
    @@ -8374,6 +8589,7 @@

    +

    Parameters
    @@ -8418,6 +8634,7 @@

    +

    Parameters
    @@ -8462,6 +8679,7 @@

    +

    Parameters
    @@ -8507,6 +8725,7 @@

    +

    Parameters
    @@ -8550,6 +8769,7 @@

    +

    Parameters
    @@ -8594,6 +8814,7 @@

    +

    Parameters
    @@ -8640,6 +8861,7 @@

    +

    Parameters
    @@ -8686,6 +8908,7 @@

    +

    Parameters
    @@ -8732,6 +8955,7 @@

    +

    Parameters
    @@ -8778,6 +9002,7 @@

    +

    Parameters
    @@ -8824,6 +9049,7 @@

    +

    Parameters
    @@ -8867,6 +9093,7 @@

    +

    Parameters
    @@ -8913,6 +9140,7 @@

    + @@ -9039,245 +9267,245 @@

    Return values
  • Constants
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Facade.html b/docs/classes/BitPaySDK-Model-Facade.html index eb2881c6..12533e8c 100644 --- a/docs/classes/BitPaySDK-Model-Facade.html +++ b/docs/classes/BitPaySDK-Model-Facade.html @@ -149,6 +149,7 @@

    +

    Tags @@ -208,7 +209,7 @@

    - MERCHANT + MERCHANT  = "merchant"
    @@ -217,14 +218,14 @@

    as well as the creation of new merchant or pos tokens associated with the account.
    - PAYOUT + PAYOUT  = "payout"
    This is the facade which allows merchant to access the Payouts related resources and corresponding endpoints.
    - POS + POS  = "pos"
    @@ -264,6 +265,7 @@

    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 @@ -295,6 +297,7 @@

    This is the facade which allows merchant to access the Payouts related resources and corresponding endpoints.

    + public mixed @@ -329,6 +332,7 @@

    Limited to creating new invoice or bills and search specific invoices or bills based on their id for the merchant's organization

    + public mixed @@ -458,9 +462,9 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-Buyer.html b/docs/classes/BitPaySDK-Model-Invoice-Buyer.html index 51314559..6cc0efe9 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Buyer.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Buyer.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,61 +221,61 @@

    - $address1 + $address1  : string|null
    - $address2 + $address2  : string|null
    - $country + $country  : string|null
    - $email + $email  : string|null
    - $locality + $locality  : string|null
    - $name + $name  : string|null
    - $notify + $notify  : bool|null
    - $phone + $phone  : string|null
    - $postalCode + $postalCode  : string|null
    - $region + $region  : string|null
    @@ -288,153 +289,153 @@

    - __construct() + __construct()  : mixed
    - getAddress1() + getAddress1()  : string|null
    Gets Buyer's address
    - getAddress2() + getAddress2()  : string|null
    Gets Buyer's appartment or suite number
    - getCountry() + getCountry()  : string|null
    Gets Buyer's Country code
    - getEmail() + getEmail()  : string|null
    Gets Buyer's email address.
    - getLocality() + getLocality()  : string|null
    Gets Buyer's city or locality
    - getName() + getName()  : string|null
    Gets Buyer's name
    - getNotify() + getNotify()  : bool|null
    Gets Buyer's notify
    - getPhone() + getPhone()  : string|null
    Gets Buyer's phone number
    - getPostalCode() + getPostalCode()  : string|null
    Gets Buyer's Zip or Postal Code
    - getRegion() + getRegion()  : string|null
    Buyer's state or province
    - setAddress1() + setAddress1()  : void
    Sets Buyer's address
    - setAddress2() + setAddress2()  : void
    Sets Buyer's appartment or suite number
    - setCountry() + setCountry()  : void
    Sets Buyer's Country code
    - setEmail() + setEmail()  : void
    Sets Buyer's email address
    - setLocality() + setLocality()  : void
    Sets Buyer's city or locality
    - setName() + setName()  : void
    Sets Buyer's name
    - setNotify() + setNotify()  : void
    Sets Buyer's notify
    - setPhone() + setPhone()  : void
    Sets Buyer's phone number
    - setPostalCode() + setPostalCode()  : void
    Sets Buyer's Zip or Postal Code
    - setRegion() + setRegion()  : void
    Sets Buyer's state or province
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -475,6 +476,7 @@

    + protected string|null @@ -510,6 +512,7 @@

    + protected string|null @@ -545,6 +548,7 @@

    + protected string|null @@ -580,6 +584,7 @@

    + protected string|null @@ -615,6 +620,7 @@

    + protected string|null @@ -650,6 +656,7 @@

    + protected string|null @@ -685,6 +692,7 @@

    + protected bool|null @@ -720,6 +728,7 @@

    + protected string|null @@ -755,6 +764,7 @@

    + protected string|null @@ -790,6 +800,7 @@

    + protected string|null @@ -839,6 +850,7 @@

    + @@ -873,6 +885,7 @@

    + @@ -915,6 +928,7 @@

    + @@ -954,6 +968,7 @@

    +

    Format ISO 3166-1 alpha-2

    @@ -998,6 +1013,7 @@

    +

    If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.

    @@ -1045,6 +1061,7 @@

    + @@ -1087,6 +1104,7 @@

    + @@ -1126,6 +1144,7 @@

    +

    Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice

    @@ -1173,6 +1192,7 @@

    + @@ -1215,6 +1235,7 @@

    + @@ -1257,6 +1278,7 @@

    + @@ -1297,6 +1319,7 @@

    +

    Parameters
    @@ -1343,6 +1366,7 @@

    +

    Parameters
    @@ -1389,6 +1413,7 @@

    +

    Parameters
    @@ -1434,6 +1459,7 @@

    +

    If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.

    @@ -1483,6 +1509,7 @@

    +

    Parameters
    @@ -1529,6 +1556,7 @@

    +

    Parameters
    @@ -1574,6 +1602,7 @@

    +

    Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice

    @@ -1623,6 +1652,7 @@

    +

    Parameters
    @@ -1669,6 +1699,7 @@

    +

    Parameters
    @@ -1715,6 +1746,7 @@

    +

    Parameters
    @@ -1763,6 +1795,7 @@

    + @@ -1889,44 +1922,44 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-BuyerFields.html b/docs/classes/BitPaySDK-Model-Invoice-BuyerFields.html index 3c59bb11..301c3309 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-BuyerFields.html +++ b/docs/classes/BitPaySDK-Model-Invoice-BuyerFields.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,61 +220,61 @@

    - $buyerAddress1 + $buyerAddress1  : string|null
    - $buyerAddress2 + $buyerAddress2  : string|null
    - $buyerCity + $buyerCity  : string|null
    - $buyerCountry + $buyerCountry  : string|null
    - $buyerEmail + $buyerEmail  : string|null
    - $buyerName + $buyerName  : string|null
    - $buyerNotify + $buyerNotify  : bool|null
    - $buyerPhone + $buyerPhone  : string|null
    - $buyerState + $buyerState  : string|null
    - $buyerZip + $buyerZip  : string|null
    @@ -287,121 +288,121 @@

    - getBuyerAddress1() + getBuyerAddress1()  : string|null
    - getBuyerAddress2() + getBuyerAddress2()  : string|null
    - getBuyerCity() + getBuyerCity()  : string|null
    - getBuyerCountry() + getBuyerCountry()  : string|null
    - getBuyerEmail() + getBuyerEmail()  : string|null
    - getBuyerName() + getBuyerName()  : string|null
    - getBuyerNotify() + getBuyerNotify()  : bool|null
    - getBuyerPhone() + getBuyerPhone()  : string|null
    - getBuyerState() + getBuyerState()  : string|null
    - getBuyerZip() + getBuyerZip()  : string|null
    - setBuyerAddress1() + setBuyerAddress1()  : void
    - setBuyerAddress2() + setBuyerAddress2()  : void
    - setBuyerCity() + setBuyerCity()  : void
    - setBuyerCountry() + setBuyerCountry()  : void
    - setBuyerEmail() + setBuyerEmail()  : void
    - setBuyerName() + setBuyerName()  : void
    - setBuyerNotify() + setBuyerNotify()  : void
    - setBuyerPhone() + setBuyerPhone()  : void
    - setBuyerState() + setBuyerState()  : void
    - setBuyerZip() + setBuyerZip()  : void
    @@ -441,6 +442,7 @@

    + protected string|null @@ -476,6 +478,7 @@

    + protected string|null @@ -511,6 +514,7 @@

    + protected string|null @@ -546,6 +550,7 @@

    + protected string|null @@ -581,6 +586,7 @@

    + protected string|null @@ -616,6 +622,7 @@

    + protected string|null @@ -651,6 +658,7 @@

    + protected bool|null @@ -686,6 +694,7 @@

    + protected string|null @@ -721,6 +730,7 @@

    + protected string|null @@ -756,6 +766,7 @@

    + protected string|null @@ -805,6 +816,7 @@

    + @@ -842,6 +854,7 @@

    + @@ -879,6 +892,7 @@

    + @@ -916,6 +930,7 @@

    + @@ -953,6 +968,7 @@

    + @@ -990,6 +1006,7 @@

    + @@ -1027,6 +1044,7 @@

    + @@ -1064,6 +1082,7 @@

    + @@ -1101,6 +1120,7 @@

    + @@ -1138,6 +1158,7 @@

    + @@ -1173,6 +1194,7 @@

    +

    Parameters
    @@ -1216,6 +1238,7 @@

    +

    Parameters
    @@ -1259,6 +1282,7 @@

    +

    Parameters
    @@ -1302,6 +1326,7 @@

    +

    Parameters
    @@ -1345,6 +1370,7 @@

    +

    Parameters
    @@ -1388,6 +1414,7 @@

    +

    Parameters
    @@ -1431,6 +1458,7 @@

    +

    Parameters
    @@ -1474,6 +1502,7 @@

    +

    Parameters
    @@ -1517,6 +1546,7 @@

    +

    Parameters
    @@ -1560,6 +1590,7 @@

    +

    Parameters
    @@ -1690,42 +1721,42 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html b/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html index 67b68fac..e99dfe91 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html +++ b/docs/classes/BitPaySDK-Model-Invoice-BuyerProvidedInfo.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,43 +221,43 @@

    - $emailAddress + $emailAddress  : string|null
    - $name + $name  : string|null
    - $phoneNumber + $phoneNumber  : string|null
    - $selectedTransactionCurrency + $selectedTransactionCurrency  : string|null
    - $selectedWallet + $selectedWallet  : string|null
    - $sms + $sms  : string|null
    - $smsVerified + $smsVerified  : bool|null
    @@ -270,111 +271,111 @@

    - __construct() + __construct()  : mixed
    - getEmailAddress() + getEmailAddress()  : string|null
    Gets email address
    - getName() + getName()  : string|null
    Gets name
    - getPhoneNumber() + getPhoneNumber()  : string|null
    Gets phone number
    - getSelectedTransactionCurrency() + getSelectedTransactionCurrency()  : string|null
    Gets selected transaction currency
    - getSelectedWallet() + getSelectedWallet()  : string|null
    Gets selected wallet
    - getSms() + getSms()  : string|null
    Gets sms
    - getSmsVerified() + getSmsVerified()  : bool|null
    Gets verification status of SMS (ie. have they passed the challenge).
    - setEmailAddress() + setEmailAddress()  : void
    Sets email address
    - setName() + setName()  : void
    Sets name
    - setPhoneNumber() + setPhoneNumber()  : void
    Sets phone number
    - setSelectedTransactionCurrency() + setSelectedTransactionCurrency()  : void
    Sets selected transaction currency
    - setSelectedWallet() + setSelectedWallet()  : void
    Sets selected wallet
    - setSms() + setSms()  : void
    Sets sms
    - setSmsVerified() + setSmsVerified()  : void
    Sets verification status of SMS (ie. have they passed the challenge).
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -415,6 +416,7 @@

    + protected string|null @@ -450,6 +452,7 @@

    + protected string|null @@ -485,6 +488,7 @@

    + protected string|null @@ -520,6 +524,7 @@

    protected string|null @@ -555,6 +560,7 @@

    + protected string|null @@ -590,6 +596,7 @@

    + protected string|null @@ -625,6 +632,7 @@

    + protected bool|null @@ -674,6 +682,7 @@

    + @@ -705,6 +714,7 @@

    +

    Populated with the buyer's email address if passed in the buyer object, otherwise this field is not returned in the response.

    @@ -750,6 +760,7 @@

    +

    Populated with the buyer's name address if passed in the buyer object by the merchant

    @@ -794,6 +805,7 @@

    +

    Populated with the buyer's phone number if passed in the buyer object by the merchant

    @@ -838,6 +850,7 @@

    +

    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.

    @@ -884,6 +897,7 @@

    +

    This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.

    @@ -928,6 +942,7 @@

    +

    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.

    @@ -976,6 +991,7 @@

    + @@ -1015,6 +1031,7 @@

    +

    Populated with the buyer's email address if passed in the buyer object, otherwise this field is not returned in the response.

    @@ -1064,6 +1081,7 @@

    +

    Populated with the buyer's name address if passed in the buyer object by the merchant

    @@ -1112,6 +1130,7 @@

    +

    Populated with the buyer's phone number if passed in the buyer object by the merchant

    @@ -1160,6 +1179,7 @@

    +

    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.

    @@ -1210,6 +1230,7 @@

    +

    This field contains the name of the cryptocurrency wallet selected by the shopper to complete the payment.

    @@ -1258,6 +1279,7 @@

    +

    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.

    @@ -1308,6 +1330,7 @@

    +

    Parameters
    @@ -1356,6 +1379,7 @@

    + @@ -1482,35 +1506,35 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-Invoice.html b/docs/classes/BitPaySDK-Model-Invoice-Invoice.html index cb564ffb..cc1cd6bd 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Invoice.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Invoice.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,373 +220,373 @@

    - $acceptanceWindow + $acceptanceWindow  : int|null
    - $amountPaid + $amountPaid  : float|null
    - $autoRedirect + $autoRedirect  : bool
    - $billId + $billId  : string|null
    - $bitpayIdRequired + $bitpayIdRequired  : bool|null
    - $buyer + $buyer  : Buyer|null
    - $buyerEmail + $buyerEmail  : string|null
    - $buyerProvidedEmail + $buyerProvidedEmail  : string|null
    - $buyerProvidedInfo + $buyerProvidedInfo  : BuyerProvidedInfo|null
    - $buyerSms + $buyerSms  : string|null
    - $closeURL + $closeURL  : string|null
    - $currency + $currency  : string|null
    - $currentTime + $currentTime  : int|null
    - $displayAmountPaid + $displayAmountPaid  : string|null
    - $exceptionStatus + $exceptionStatus  : string|null
    - $exchangeRates + $exchangeRates  : array<string|int, mixed>|null
    - $expirationTime + $expirationTime  : int|null
    - $extendedNotifications + $extendedNotifications  : bool
    - $forcedBuyerSelectedTransactionCurrency + $forcedBuyerSelectedTransactionCurrency  : string|null
    - $forcedBuyerSelectedWallet + $forcedBuyerSelectedWallet  : string|null
    - $fullNotifications + $fullNotifications  : bool
    - $guid + $guid  : string|null
    - $id + $id  : string|null
    - $invoiceTime + $invoiceTime  : int|null
    - $isCancelled + $isCancelled  : bool|null
    - $itemCode + $itemCode  : string|null
    - $itemDesc + $itemDesc  : string|null
    - $itemizedDetails + $itemizedDetails  : array<string|int, ItemizedDetails>
    - $jsonPayProRequired + $jsonPayProRequired  : bool|null
    - $lowFeeDetected + $lowFeeDetected  : bool|null
    - $merchantName + $merchantName  : string|null
    - $minerFees + $minerFees  : MinerFees|null
    - $nonPayProPaymentReceived + $nonPayProPaymentReceived  : bool|null
    - $notificationEmail + $notificationEmail  : string|null
    - $notificationURL + $notificationURL  : string|null
    - $orderId + $orderId  : string|null
    - $overpaidAmount + $overpaidAmount  : float|null
    - $paymentCodes + $paymentCodes  : array<string|int, mixed>|null
    - $paymentCurrencies + $paymentCurrencies  : array<string|int, mixed>|null
    - $paymentDisplaySubTotals + $paymentDisplaySubTotals  : array<string|int, mixed>|null
    - $paymentDisplayTotals + $paymentDisplayTotals  : array<string|int, mixed>|null
    - $paymentSubtotals + $paymentSubtotals  : array<string|int, mixed>|null
    - $paymentTotals + $paymentTotals  : array<string|int, mixed>|null
    - $physical + $physical  : bool
    - $posData + $posData  : string|null
    - $price + $price  : float|null
    - $redirectURL + $redirectURL  : string|null
    - $refundAddresses + $refundAddresses  : array<string|int, mixed>|null
    - $refundAddressRequestPending + $refundAddressRequestPending  : bool|null
    - $refundInfo + $refundInfo  : RefundInfo|null
    - $selectedTransactionCurrency + $selectedTransactionCurrency  : string|null
    - $shopper + $shopper  : Shopper|null
    - $status + $status  : string|null
    - $supportedTransactionCurrencies + $supportedTransactionCurrencies  : SupportedTransactionCurrencies|null
    - $targetConfirmations + $targetConfirmations  : int|null
    - $token + $token  : string|null
    - $transactionCurrency + $transactionCurrency  : string|null
    - $transactions + $transactions  : array<string|int, mixed>|null
    - $transactionSpeed + $transactionSpeed  : string|null
    - $underpaidAmount + $underpaidAmount  : float|null
    - $universalCodes + $universalCodes  : UniversalCodes|null
    - $url + $url  : string|null
    @@ -599,882 +600,882 @@

    - __construct() + __construct()  : mixed
    Constructor, create a minimal request Invoice object.
    - getAcceptanceWindow() + getAcceptanceWindow()  : int|null
    Gets acceptanceWindow
    - getAmountPaid() + getAmountPaid()  : float|null
    Gets amountPaid
    - getAutoRedirect() + getAutoRedirect()  : bool|null
    Gets autoRedirect
    - getBillId() + getBillId()  : string|null
    Gets billId
    - getBitpayIdRequired() + getBitpayIdRequired()  : bool|null
    Gets bitpayIdRequired
    - getBuyer() + getBuyer()  : Buyer|null
    Gets buyer
    - getBuyerEmail() + getBuyerEmail()  : string|null
    Gets buyerEmail
    - getBuyerProvidedEmail() + getBuyerProvidedEmail()  : string|null
    Gets buyerProvidedEmail
    - getBuyerProvidedInfo() + getBuyerProvidedInfo()  : BuyerProvidedInfo|null
    Gets buyerProvidedEmail
    - getBuyerSms() + getBuyerSms()  : string|null
    Gets buyerSms
    - getCloseURL() + getCloseURL()  : string|null
    Gets closeURL
    - getCurrency() + getCurrency()  : string|null
    Gets currency
    - getCurrentTime() + getCurrentTime()  : int|null
    Gets currentTime - UNIX time of API call, in milliseconds
    - getDisplayAmountPaid() + getDisplayAmountPaid()  : string|null
    Gets displayAmountPaid
    - getExceptionStatus() + getExceptionStatus()  : string|null
    Gets exceptionStatus
    - getExchangeRates() + getExchangeRates()  : array<string|int, mixed>|null
    Gets exchangeRates
    - getExpirationTime() + getExpirationTime()  : int|null
    Gets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
    - getExtendedNotifications() + getExtendedNotifications()  : bool|null
    Gets extendedNotifications
    - getForcedBuyerSelectedTransactionCurrency() + getForcedBuyerSelectedTransactionCurrency()  : string|null
    Gets forcedBuyerSelectedWallet
    - getForcedBuyerSelectedWallet() + getForcedBuyerSelectedWallet()  : string|null
    Gets forcedBuyerSelectedWallet
    - getFullNotifications() + getFullNotifications()  : bool|null
    Gets fullNotifications
    - getGuid() + getGuid()  : string|null
    Gets guid
    - getId() + getId()  : string|null
    Gets invoice resource id
    - getInvoiceTime() + getInvoiceTime()  : int|null
    Gets invoiceTime - UNIX time of invoice creation, in milliseconds
    - getIsCancelled() + getIsCancelled()  : bool|null
    Gets isCancelled
    - getItemCode() + getItemCode()  : string|null
    Gets itemCode
    - getItemDesc() + getItemDesc()  : string|null
    Gets itemDesc
    - getItemizedDetails() + getItemizedDetails()  : array<string|int, ItemizedDetails>
    Gets itemizedDetails
    - getJsonPayProRequired() + getJsonPayProRequired()  : bool|null
    Gets jsonPayProRequired
    - getLowFeeDetected() + getLowFeeDetected()  : bool|null
    Gets lowFeeDetected
    - getMerchantName() + getMerchantName()  : string|null
    Gets merchantName
    - getMinerFees() + getMinerFees()  : MinerFees|null
    Gets minerFees
    - getNonPayProPaymentReceived() + getNonPayProPaymentReceived()  : bool|null
    Gets nonPayProPaymentReceived
    - getNotificationEmail() + getNotificationEmail()  : string|null
    Gets NotificationEmail
    - getNotificationURL() + getNotificationURL()  : string|null
    Gets notificationURL
    - getOrderId() + getOrderId()  : string|null
    Gets orderId
    - getOverpaidAmount() + getOverpaidAmount()  : float|null
    Gets overpaidAmount
    - getPaymentCodes() + getPaymentCodes()  : array<string|int, mixed>|null
    Gets paymentCodes
    - getPaymentCurrencies() + getPaymentCurrencies()  : array<string|int, mixed>|null
    Gets paymentCurrencies
    - getPaymentDisplaySubTotals() + getPaymentDisplaySubTotals()  : array<string|int, mixed>|null
    Gets paymentDisplaySubtotals
    - getPaymentDisplayTotals() + getPaymentDisplayTotals()  : array<string|int, mixed>|null
    Gets paymentDisplayTotals
    - getPaymentSubtotals() + getPaymentSubtotals()  : array<string|int, mixed>|null
    Gets paymentSubtotals
    - getPaymentTotals() + getPaymentTotals()  : array<string|int, mixed>|null
    Gets paymentTotals
    - getPhysical() + getPhysical()  : bool|null
    Gets physical.
    - getPosData() + getPosData()  : string|null
    Gets posData
    - getPrice() + getPrice()  : float|null
    Gets price
    - getRedirectURL() + getRedirectURL()  : string|null
    Gets RedirectURL
    - getRefundAddresses() + getRefundAddresses()  : array<string|int, mixed>|null
    Gets refundAddresses
    - getRefundAddressRequestPending() + getRefundAddressRequestPending()  : bool|null
    Gets refundAddressRequestPending
    - getRefundInfo() + getRefundInfo()  : RefundInfo|null
    Gets refundInfo
    - getSelectedTransactionCurrency() + getSelectedTransactionCurrency()  : string|null
    Gets selectedTransactionCurrency
    - getShopper() + getShopper()  : Shopper|null
    Gets shopper
    - getStatus() + getStatus()  : string|null
    Gets status
    - getSupportedTransactionCurrencies() + getSupportedTransactionCurrencies()  : SupportedTransactionCurrencies|null
    Gets supportedTransactionCurrencies
    - getTargetConfirmations() + getTargetConfirmations()  : int|null
    Gets targetConfirmations
    - getToken() + getToken()  : string|null
    Gets token
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    Gets transactionCurrency
    - getTransactions() + getTransactions()  : array<string|int, mixed>|null
    Gets transactions
    - getTransactionSpeed() + getTransactionSpeed()  : string|null
    Gets transactionSpeed.
    - getUnderpaidAmount() + getUnderpaidAmount()  : float|null
    Gets underpaidAmount
    - getUniversalCodes() + getUniversalCodes()  : UniversalCodes|null
    Gets universalCodes
    - getUrl() + getUrl()  : string|null
    Gets url
    - setAcceptanceWindow() + setAcceptanceWindow()  : void
    Sets acceptanceWindow
    - setAmountPaid() + setAmountPaid()  : void
    Sets amountPaid
    - setAutoRedirect() + setAutoRedirect()  : void
    Sets autoRedirect
    - setBillId() + setBillId()  : void
    Sets billId
    - setBitpayIdRequired() + setBitpayIdRequired()  : void
    Sets bitpayIdRequired
    - setBuyer() + setBuyer()  : void
    Sets buyer
    - setBuyerEmail() + setBuyerEmail()  : void
    Sets buyerEmail
    - setBuyerProvidedEmail() + setBuyerProvidedEmail()  : void
    Sets buyerProvidedEmail
    - setBuyerProvidedInfo() + setBuyerProvidedInfo()  : mixed
    Sets buyerProvidedEmail
    - setBuyerSms() + setBuyerSms()  : void
    Sets buyerSms
    - setCloseURL() + setCloseURL()  : void
    Gets closeURL
    - setCurrency() + setCurrency()  : void
    Sets currency
    - setCurrentTime() + setCurrentTime()  : void
    Sets currentTime - UNIX time of API call, in milliseconds
    - setDisplayAmountPaid() + setDisplayAmountPaid()  : void
    Sets displayAmountPaid
    - setExceptionStatus() + setExceptionStatus()  : void
    Sets exceptionStatus
    - setExchangeRates() + setExchangeRates()  : void
    Sets exchangeRates
    - setExpirationTime() + setExpirationTime()  : void
    Sets expirationTime - UNIX time when invoice is last available to be paid, in milliseconds
    - setExtendedNotifications() + setExtendedNotifications()  : void
    Sets extendedNotifications
    - setForcedBuyerSelectedTransactionCurrency() + setForcedBuyerSelectedTransactionCurrency()  : mixed
    Sets forcedBuyerSelectedWallet
    - setForcedBuyerSelectedWallet() + setForcedBuyerSelectedWallet()  : mixed
    Sets forcedBuyerSelectedWallet
    - setFullNotifications() + setFullNotifications()  : void
    Sets fullNotifications
    - setGuid() + setGuid()  : void
    Sets guid
    - setId() + setId()  : void
    Sets invoice resource id
    - setInvoiceTime() + setInvoiceTime()  : mixed
    Sets invoiceTime - UNIX time of invoice creation, in milliseconds
    - setIsCancelled() + setIsCancelled()  : void
    Sets isCancelled
    - setItemCode() + setItemCode()  : void
    Sets itemCode
    - setItemDesc() + setItemDesc()  : void
    Sets itemDesc
    - setItemizedDetails() + setItemizedDetails()  : void
    Sets itemizedDetails
    - setJsonPayProRequired() + setJsonPayProRequired()  : void
    Sets jsonPayProRequired
    - setLowFeeDetected() + setLowFeeDetected()  : mixed
    Sets lowFeeDetected
    - setMerchantName() + setMerchantName()  : void
    Sets merchantName
    - setMinerFees() + setMinerFees()  : void
    Sets minerFees
    - setNonPayProPaymentReceived() + setNonPayProPaymentReceived()  : void
    Sets nonPayProPaymentReceived
    - setNotificationEmail() + setNotificationEmail()  : void
    Sets NotificationEmail
    - setNotificationURL() + setNotificationURL()  : void
    Sets notificationURL
    - setOrderId() + setOrderId()  : void
    Sets orderId
    - setOverpaidAmount() + setOverpaidAmount()  : void
    Sets overpaidAmount
    - setPaymentCodes() + setPaymentCodes()  : mixed
    Sets paymentCodes
    - setPaymentCurrencies() + setPaymentCurrencies()  : void
    Sets paymentCurrencies
    - setPaymentDisplaySubTotals() + setPaymentDisplaySubTotals()  : mixed
    Sets paymentDisplaySubtotals
    - setPaymentDisplayTotals() + setPaymentDisplayTotals()  : mixed
    Sets paymentDisplayTotals
    - setPaymentSubtotals() + setPaymentSubtotals()  : mixed
    Sets paymentSubtotals
    - setPaymentTotals() + setPaymentTotals()  : mixed
    Sets paymentTotals
    - setPhysical() + setPhysical()  : void
    Sets physical.
    - setPosData() + setPosData()  : void
    Sets posData
    - setPrice() + setPrice()  : void
    Sets price
    - setRedirectURL() + setRedirectURL()  : void
    Sets RedirectURL
    - setRefundAddresses() + setRefundAddresses()  : void
    Sets refundAddresses
    - setRefundAddressRequestPending() + setRefundAddressRequestPending()  : void
    Sets refundAddressRequestPending
    - setRefundInfo() + setRefundInfo()  : void
    Sets refundInfo
    - setSelectedTransactionCurrency() + setSelectedTransactionCurrency()  : void
    Sets selectedTransactionCurrency
    - setShopper() + setShopper()  : mixed
    Sets shopper
    - setStatus() + setStatus()  : void
    Sets status
    - setSupportedTransactionCurrencies() + setSupportedTransactionCurrencies()  : void
    Sets supportedTransactionCurrencies
    - setTargetConfirmations() + setTargetConfirmations()  : void
    Sets targetConfirmations
    - setToken() + setToken()  : void
    Sets token
    - setTransactionCurrency() + setTransactionCurrency()  : void
    Sets transactionCurrency
    - setTransactions() + setTransactions()  : void
    Sets transactions
    - setTransactionSpeed() + setTransactionSpeed()  : void
    Sets transactionSpeed.
    - setUnderpaidAmount() + setUnderpaidAmount()  : void
    Sets underpaidAmount
    - setUniversalCodes() + setUniversalCodes()  : mixed
    Sets universalCodes
    - setUrl() + setUrl()  : void
    Sets url
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -1515,6 +1516,7 @@

    + protected int|null @@ -1550,6 +1552,7 @@

    + protected float|null @@ -1585,6 +1588,7 @@

    + protected bool @@ -1620,6 +1624,7 @@

    + protected string|null @@ -1655,6 +1660,7 @@

    + protected bool|null @@ -1690,6 +1696,7 @@

    + protected Buyer|null @@ -1725,6 +1732,7 @@

    + protected string|null @@ -1760,6 +1768,7 @@

    + protected string|null @@ -1795,6 +1804,7 @@

    + protected BuyerProvidedInfo|null @@ -1830,6 +1840,7 @@

    + protected string|null @@ -1865,6 +1876,7 @@

    + protected string|null @@ -1900,6 +1912,7 @@

    + protected string|null @@ -1935,6 +1948,7 @@

    + protected int|null @@ -1970,6 +1984,7 @@

    + protected string|null @@ -2005,6 +2020,7 @@

    + protected string|null @@ -2040,6 +2056,7 @@

    + protected array<string|int, mixed>|null @@ -2075,6 +2092,7 @@

    + protected int|null @@ -2110,6 +2128,7 @@

    + protected bool @@ -2145,6 +2164,7 @@

    protected string|null @@ -2180,6 +2200,7 @@

    + protected string|null @@ -2215,6 +2236,7 @@

    + protected bool @@ -2250,6 +2272,7 @@

    + protected string|null @@ -2285,6 +2308,7 @@

    + protected string|null @@ -2320,6 +2344,7 @@

    + protected int|null @@ -2355,6 +2380,7 @@

    + protected bool|null @@ -2390,6 +2416,7 @@

    + protected string|null @@ -2425,6 +2452,7 @@

    + protected string|null @@ -2460,6 +2488,7 @@

    + protected array<string|int, ItemizedDetails> @@ -2495,6 +2524,7 @@

    + protected bool|null @@ -2530,6 +2560,7 @@

    + protected bool|null @@ -2565,6 +2596,7 @@

    + protected string|null @@ -2600,6 +2632,7 @@

    + protected MinerFees|null @@ -2635,6 +2668,7 @@

    + protected bool|null @@ -2670,6 +2704,7 @@

    + protected string|null @@ -2705,6 +2740,7 @@

    + protected string|null @@ -2740,6 +2776,7 @@

    + protected string|null @@ -2775,6 +2812,7 @@

    + protected float|null @@ -2810,6 +2848,7 @@

    + protected array<string|int, mixed>|null @@ -2845,6 +2884,7 @@

    + protected array<string|int, mixed>|null @@ -2880,6 +2920,7 @@

    + protected array<string|int, mixed>|null @@ -2915,6 +2956,7 @@

    + protected array<string|int, mixed>|null @@ -2950,6 +2992,7 @@

    + protected array<string|int, mixed>|null @@ -2985,6 +3028,7 @@

    + protected array<string|int, mixed>|null @@ -3020,6 +3064,7 @@

    + protected bool @@ -3055,6 +3100,7 @@

    + protected string|null @@ -3090,6 +3136,7 @@

    + protected float|null @@ -3125,6 +3172,7 @@

    + protected string|null @@ -3160,6 +3208,7 @@

    + protected array<string|int, mixed>|null @@ -3195,6 +3244,7 @@

    protected bool|null @@ -3230,6 +3280,7 @@

    + protected RefundInfo|null @@ -3265,6 +3316,7 @@

    protected string|null @@ -3300,6 +3352,7 @@

    + protected Shopper|null @@ -3335,6 +3388,7 @@

    + protected string|null @@ -3370,6 +3424,7 @@

    protected SupportedTransactionCurrencies|null @@ -3405,6 +3460,7 @@

    + protected int|null @@ -3440,6 +3496,7 @@

    + protected string|null @@ -3475,6 +3532,7 @@

    + protected string|null @@ -3510,6 +3568,7 @@

    + protected array<string|int, mixed>|null @@ -3545,6 +3604,7 @@

    + protected string|null @@ -3580,6 +3640,7 @@

    + protected float|null @@ -3615,6 +3676,7 @@

    + protected UniversalCodes|null @@ -3650,6 +3712,7 @@

    + protected string|null @@ -3698,6 +3761,7 @@

    +

    Parameters
    @@ -3752,6 +3816,7 @@

    +

    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).

    @@ -3798,6 +3863,7 @@

    +

    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)

    @@ -3839,6 +3905,7 @@

    +

    Set to false by default, merchant can setup automatic redirect to their website by setting this parameter to true.

    @@ -3884,6 +3951,7 @@

    +

    This field will be in the invoice object only if the invoice was generated from a bill,

    @@ -3941,6 +4009,7 @@

    +

    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.

    @@ -3987,6 +4056,7 @@

    +

    Allows merchant to pass buyer related information in the invoice object

    @@ -4031,6 +4101,7 @@

    +

    Buyer's email address. If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.

    @@ -4076,6 +4147,7 @@

    +

    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, @@ -4124,6 +4196,7 @@

    +

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

    @@ -4169,6 +4242,7 @@

    +

    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.

    @@ -4215,6 +4289,7 @@

    +

    URL to redirect if the shopper does not pay the invoice and click on the Close button instead.

    @@ -4259,6 +4334,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the price field, supported currencies are available via the Currencies resource

    @@ -4308,6 +4384,7 @@

    + @@ -4347,6 +4424,7 @@

    +

    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

    @@ -4389,6 +4467,7 @@

    +

    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 unless an exception is triggered. @@ -4437,6 +4516,7 @@

    +

    Exchange rates keyed by source and target currencies.

    @@ -4480,6 +4560,7 @@

    + @@ -4519,6 +4600,7 @@

    +

    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. @@ -4563,6 +4645,7 @@

    +

    Merchant pre-selects transaction currency on behalf of buyer.

    @@ -4607,6 +4690,7 @@

    +

    Merchant pre-selects transaction currency on behalf of buyer.

    @@ -4651,6 +4735,7 @@

    +

    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 @@ -4700,6 +4785,7 @@

    +

    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.

    @@ -4749,6 +4835,7 @@

    + @@ -4791,6 +4878,7 @@

    + @@ -4830,6 +4918,7 @@

    +

    Indicates whether or not the invoice was cancelled.

    @@ -4870,6 +4959,7 @@

    +

    "bitcoindonation" for donations, otherwise do not include the field in the request.

    @@ -4914,6 +5004,7 @@

    +

    Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.

    @@ -4958,6 +5049,7 @@

    +

    Object containing line item details for display.

    @@ -4998,6 +5090,7 @@

    +

    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 @@ -5045,6 +5138,7 @@

    +

    Flag to indicate if the miner fee used by the buyer is too low. Initially set to false when the invoice is created.

    @@ -5090,6 +5184,7 @@

    +

    A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).

    @@ -5134,6 +5229,7 @@

    +

    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. @@ -5180,6 +5276,7 @@

    +

    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).

    @@ -5221,6 +5318,7 @@

    +

    Merchant email address for notification of payout status change.

    @@ -5268,6 +5366,7 @@

    + @@ -5309,6 +5408,7 @@

    +

    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.

    @@ -5350,6 +5450,7 @@

    +

    This parameter will be returned on the invoice object if the invoice was overpaid ("exceptionStatus": "paidOver"). It equals to the absolute difference between amountPaid @@ -5393,6 +5494,7 @@

    +

    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. @@ -5438,6 +5540,7 @@

    +

    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". @@ -5486,6 +5589,7 @@

    +

    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.

    @@ -5532,6 +5636,7 @@

    +

    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 @@ -5579,6 +5684,7 @@

    +

    For internal use. This field can be ignored in merchant implementations.

    @@ -5623,6 +5729,7 @@

    +

    For internal use - This field can be ignored in merchant implementations.

    @@ -5667,6 +5774,7 @@

    +

    Indicates whether items are physical goods. Alternatives include digital goods and services.

    @@ -5711,6 +5819,7 @@

    +

    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.

    @@ -5757,6 +5866,7 @@

    +

    Fixed price amount for the checkout, in the "currency" of the invoice object.

    @@ -5801,6 +5911,7 @@

    +

    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.

    @@ -5846,6 +5957,7 @@

    +

    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.

    @@ -5892,6 +6004,7 @@

    +

    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 @@ -5940,6 +6053,7 @@

    +

    For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.

    @@ -5980,6 +6094,7 @@

    +

    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". @@ -6027,6 +6142,7 @@

    +

    This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.

    @@ -6088,6 +6204,7 @@

    +

    Detailed information about invoice status notifications can be found under the Instant Payment Notification (IPN) section. @@ -6135,6 +6252,7 @@

    +

    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. @@ -6184,6 +6302,7 @@

    +

    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, @@ -6231,6 +6350,7 @@

    +

    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.

    @@ -6278,6 +6398,7 @@

    +

    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", @@ -6321,6 +6442,7 @@

    +

    Contains the cryptocurrency transaction details for the executed payout.

    @@ -6365,6 +6487,7 @@

    +

    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. @@ -6414,6 +6537,7 @@

    +

    This parameter will be returned on the invoice object if the invoice was underpaid ("exceptionStatus": "paidPartial"). It equals to the absolute difference between amountPaid @@ -6457,6 +6581,7 @@

    +

    Object containing wallet-specific URLs for payment protocol.

    @@ -6501,6 +6626,7 @@

    +

    Web address of invoice, expires at expirationTime

    @@ -6545,6 +6671,7 @@

    +

    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).

    @@ -6595,6 +6722,7 @@

    +

    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)

    @@ -6644,6 +6772,7 @@

    +

    Set to false by default, merchant can setup automatic redirect to their website by setting this parameter to true.

    @@ -6693,6 +6822,7 @@

    +

    This field will be in the invoice object only if the invoice was generated from a bill,

    @@ -6758,6 +6888,7 @@

    +

    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.

    @@ -6808,6 +6939,7 @@

    +

    Allows merchant to pass buyer related information in the invoice object

    @@ -6856,6 +6988,7 @@

    +

    Buyer's email address. If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.

    @@ -6905,6 +7038,7 @@

    +

    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, @@ -6958,6 +7092,7 @@

    +

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

    @@ -7008,6 +7143,7 @@

    +

    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.

    @@ -7058,6 +7194,7 @@

    +

    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.

    @@ -7107,6 +7244,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the price field, supported currencies are available via the Currencies resource

    @@ -7173,6 +7311,7 @@

    +

    Parameters
    @@ -7218,6 +7357,7 @@

    +

    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

    @@ -7268,6 +7408,7 @@

    +

    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. @@ -7320,6 +7461,7 @@

    +

    Exchange rates keyed by source and target currencies.

    @@ -7369,6 +7511,7 @@

    +

    Parameters
    @@ -7414,6 +7557,7 @@

    +

    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. @@ -7466,6 +7610,7 @@

    +

    Merchant pre-selects transaction currency on behalf of buyer.

    @@ -7514,6 +7659,7 @@

    +

    Merchant pre-selects transaction currency on behalf of buyer.

    @@ -7562,6 +7708,7 @@

    +

    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 @@ -7615,6 +7762,7 @@

    +

    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.

    @@ -7666,6 +7814,7 @@

    +

    Parameters
    @@ -7712,6 +7861,7 @@

    +

    Parameters
    @@ -7757,6 +7907,7 @@

    +

    Indicates whether or not the invoice was cancelled.

    @@ -7805,6 +7956,7 @@

    +

    "bitcoindonation" for donations, otherwise do not include the field in the request.

    @@ -7853,6 +8005,7 @@

    +

    Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.

    @@ -7901,6 +8054,7 @@

    +

    Object containing line item details for display.

    @@ -7962,6 +8116,7 @@

    +

    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 @@ -8013,6 +8168,7 @@

    +

    Flag to indicate if the miner fee used by the buyer is too low. Initially set to false when the invoice is created.

    @@ -8062,6 +8218,7 @@

    +

    A display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).

    @@ -8110,6 +8267,7 @@

    +

    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. @@ -8165,6 +8323,7 @@

    +

    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).

    @@ -8214,6 +8373,7 @@

    +

    Merchant email address for notification of payout status change.

    @@ -8263,6 +8423,7 @@

    +

    Parameters
    @@ -8310,6 +8471,7 @@

    +

    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.

    @@ -8359,6 +8521,7 @@

    +

    This parameter will be returned on the invoice object if the invoice was overpaid ("exceptionStatus": "paidOver"). It equals to the absolute difference between amountPaid @@ -8410,6 +8573,7 @@

    +

    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. @@ -8461,6 +8625,7 @@

    +

    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". @@ -8513,6 +8678,7 @@

    +

    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.

    @@ -8563,6 +8729,7 @@

    +

    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 @@ -8614,6 +8781,7 @@

    +

    For internal use. This field can be ignored in merchant implementations.

    @@ -8662,6 +8830,7 @@

    +

    For internal use - This field can be ignored in merchant implementations.

    @@ -8710,6 +8879,7 @@

    +

    Indicates whether items are physical goods. Alternatives include digital goods and services.

    @@ -8758,6 +8928,7 @@

    +

    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.

    @@ -8808,6 +8979,7 @@

    +

    Fixed price amount for the checkout, in the "currency" of the invoice object.

    @@ -8856,6 +9028,7 @@

    +

    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.

    @@ -8906,6 +9079,7 @@

    +

    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.

    @@ -8954,6 +9128,7 @@

    +

    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 @@ -9007,6 +9182,7 @@

    +

    For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.

    @@ -9053,6 +9229,7 @@

    +

    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". @@ -9105,6 +9282,7 @@

    +

    This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.

    @@ -9170,6 +9348,7 @@

    +

    Detailed information about invoice status notifications can be found under the Instant Payment Notification (IPN) section. @@ -9222,6 +9401,7 @@

    +

    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. @@ -9276,6 +9456,7 @@

    +

    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, @@ -9329,6 +9510,7 @@

    +

    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.

    @@ -9379,6 +9561,7 @@

    +

    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", @@ -9430,6 +9613,7 @@

    +

    Contains the cryptocurrency transaction details for the executed payout.

    @@ -9478,6 +9662,7 @@

    +

    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. @@ -9531,6 +9716,7 @@

    +

    This parameter will be returned on the invoice object if the invoice was underpaid ("exceptionStatus": "paidPartial"). It equals to the absolute difference between amountPaid @@ -9583,6 +9769,7 @@

    +

    Parameters
    @@ -9628,6 +9815,7 @@

    +

    Web address of invoice, expires at expirationTime

    @@ -9679,6 +9867,7 @@

    + @@ -9801,200 +9990,200 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-InvoiceRefundAddresses.html b/docs/classes/BitPaySDK-Model-Invoice-InvoiceRefundAddresses.html index f0e17e07..0f7107aa 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-InvoiceRefundAddresses.html +++ b/docs/classes/BitPaySDK-Model-Invoice-InvoiceRefundAddresses.html @@ -161,6 +161,7 @@

    +

    Table of Contents @@ -182,25 +183,25 @@

    - $date + $date  : string
    - $email + $email  : string|null
    - $tag + $tag  : int|null
    - $type + $type  : string
    @@ -214,49 +215,49 @@

    - getDate() + getDate()  : string
    - getEmail() + getEmail()  : string|null
    - getTag() + getTag()  : int|null
    - getType() + getType()  : string
    - setDate() + setDate()  : void
    - setEmail() + setEmail()  : void
    - setTag() + setTag()  : void
    - setType() + setType()  : void
    @@ -296,6 +297,7 @@

    + protected string @@ -331,6 +333,7 @@

    + protected string|null @@ -366,6 +369,7 @@

    + protected int|null @@ -401,6 +405,7 @@

    + protected string @@ -450,6 +455,7 @@

    + @@ -487,6 +493,7 @@

    + @@ -524,6 +531,7 @@

    + @@ -561,6 +569,7 @@

    + @@ -596,6 +605,7 @@

    +

    Parameters
    @@ -639,6 +649,7 @@

    +

    Parameters
    @@ -682,6 +693,7 @@

    +

    Parameters
    @@ -725,6 +737,7 @@

    +

    Parameters
    @@ -855,24 +868,24 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html b/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html index 5ab74635..4fd63e8e 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html +++ b/docs/classes/BitPaySDK-Model-Invoice-InvoiceStatus.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,7 +210,7 @@

    - COMPLETE + COMPLETE  = 'complete'
    @@ -219,14 +220,14 @@

    this takes on average 1 hour.
    - CONFIRMED + CONFIRMED  = 'confirmed'
    This status can be used by merchants in order to fulfill orders placed by the consumer.
    - DECLINED + DECLINED  = 'declined'
    @@ -234,14 +235,14 @@

    and the customer will be automatically contacted regarding a refund if needed.
    - EXPIRED + EXPIRED  = 'expired'
    An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.
    - INVALID + INVALID  = 'invalid'
    @@ -249,7 +250,7 @@

    but the corresponding cryptocurrency transaction was not confirmed within 1 hour on the corresponding blockchain.
    - NEW + NEW  = 'new'
    @@ -260,7 +261,7 @@

    an invoice is either paid or not paid, partial payments are automatically refunded by BitPay to the consumer.
    - PAID + PAID  = 'paid'
    @@ -300,6 +301,7 @@

    6 confirmation blocks on the bitcoin network are required for an invoice to be complete, this takes on average 1 hour.

    + public mixed @@ -331,6 +333,7 @@

    This status can be used by merchants in order to fulfill orders placed by the consumer.

    + public mixed @@ -368,6 +371,7 @@

    An invoice in the declined status is no longer eligible to be successfully completed, and the customer will be automatically contacted regarding a refund if needed.

    + public mixed @@ -402,6 +406,7 @@

    An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.

    + public mixed @@ -434,6 +439,7 @@

    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 @@ -473,6 +479,7 @@

    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 @@ -504,6 +511,7 @@

    As soon as payment is received it is evaluated against the invoice requested amount.

    + public mixed @@ -637,13 +645,13 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-InvoiceTransaction.html b/docs/classes/BitPaySDK-Model-Invoice-InvoiceTransaction.html index 9fff961e..56f70d22 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-InvoiceTransaction.html +++ b/docs/classes/BitPaySDK-Model-Invoice-InvoiceTransaction.html @@ -161,6 +161,7 @@

    +

    Table of Contents @@ -182,43 +183,43 @@

    - $amount + $amount  : string
    - $confirmations + $confirmations  : int
    - $exRates + $exRates  : array<string|int, mixed>
    - $outputIndex + $outputIndex  : int
    - $receivedTime + $receivedTime  : string
    - $time + $time  : string
    - $txid + $txid  : string
    @@ -232,85 +233,85 @@

    - getAmount() + getAmount()  : string
    - getConfirmations() + getConfirmations()  : int
    - getExRates() + getExRates()  : array<string|int, mixed>
    - getOutputIndex() + getOutputIndex()  : int
    - getReceivedTime() + getReceivedTime()  : string
    - getTime() + getTime()  : string
    - getTxid() + getTxid()  : string
    - setAmount() + setAmount()  : void
    - setConfirmations() + setConfirmations()  : void
    - setExRates() + setExRates()  : void
    - setOutputIndex() + setOutputIndex()  : void
    - setReceivedTime() + setReceivedTime()  : void
    - setTime() + setTime()  : void
    - setTxid() + setTxid()  : void
    @@ -350,6 +351,7 @@

    + protected string @@ -385,6 +387,7 @@

    + protected int @@ -420,6 +423,7 @@

    + protected array<string|int, mixed> @@ -455,6 +459,7 @@

    + protected int @@ -490,6 +495,7 @@

    + protected string @@ -525,6 +531,7 @@

    + protected string @@ -560,6 +567,7 @@

    + protected string @@ -609,6 +617,7 @@

    + @@ -646,6 +655,7 @@

    + @@ -683,6 +693,7 @@

    + @@ -724,6 +735,7 @@

    + @@ -761,6 +773,7 @@

    + @@ -798,6 +811,7 @@

    + @@ -835,6 +849,7 @@

    + @@ -870,6 +885,7 @@

    +

    Parameters
    @@ -913,6 +929,7 @@

    +

    Parameters
    @@ -956,6 +973,7 @@

    +

    Parameters
    @@ -1001,6 +1019,7 @@

    +

    Parameters
    @@ -1044,6 +1063,7 @@

    +

    Parameters
    @@ -1087,6 +1107,7 @@

    +

    Parameters
    @@ -1130,6 +1151,7 @@

    +

    Parameters
    @@ -1260,33 +1282,33 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-InvoiceWebhook.html b/docs/classes/BitPaySDK-Model-Invoice-InvoiceWebhook.html index f4ee48d3..255c9bc5 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-InvoiceWebhook.html +++ b/docs/classes/BitPaySDK-Model-Invoice-InvoiceWebhook.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,109 +220,109 @@

    - $amountPaid + $amountPaid  : float|null
    - $buyerFields + $buyerFields  : BuyerFields|null
    - $currency + $currency  : string|null
    - $currencyTime + $currencyTime  : string|null
    - $exceptionStatus + $exceptionStatus  : string|null
    - $exchangeRates + $exchangeRates  : array<string|int, mixed>|null
    - $id + $id  : string|null
    - $inInvoiceId + $inInvoiceId  : string|null
    - $inPaymentRequest + $inPaymentRequest  : string|null
    - $invoiceTime + $invoiceTime  : string|null
    - $orderId + $orderId  : string|null
    - $paymentSubtotals + $paymentSubtotals  : array<string|int, mixed>|null
    - $paymentTotals + $paymentTotals  : array<string|int, mixed>|null
    - $posData + $posData  : string|null
    - $price + $price  : float|null
    - $status + $status  : string|null
    - $transactionCurrency + $transactionCurrency  : string|null
    - $url + $url  : string|null
    @@ -335,217 +336,217 @@

    - getAmountPaid() + getAmountPaid()  : float|null
    - getBuyerFields() + getBuyerFields()  : BuyerFields|null
    - getCurrency() + getCurrency()  : string|null
    - getCurrencyTime() + getCurrencyTime()  : string|null
    - getExceptionStatus() + getExceptionStatus()  : string|null
    - getExchangeRates() + getExchangeRates()  : array<string|int, mixed>|null
    - getId() + getId()  : string|null
    - getInInvoiceId() + getInInvoiceId()  : string|null
    - getInPaymentRequest() + getInPaymentRequest()  : string|null
    - getInvoiceTime() + getInvoiceTime()  : string|null
    - getOrderId() + getOrderId()  : string|null
    - getPaymentSubtotals() + getPaymentSubtotals()  : array<string|int, mixed>|null
    - getPaymentTotals() + getPaymentTotals()  : array<string|int, mixed>|null
    - getPosData() + getPosData()  : string|null
    - getPrice() + getPrice()  : float|null
    - getStatus() + getStatus()  : string|null
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    - getUrl() + getUrl()  : string|null
    - setAmountPaid() + setAmountPaid()  : void
    - setBuyerFields() + setBuyerFields()  : void
    - setCurrency() + setCurrency()  : void
    - setCurrencyTime() + setCurrencyTime()  : void
    - setExceptionStatus() + setExceptionStatus()  : void
    - setExchangeRates() + setExchangeRates()  : void
    - setId() + setId()  : void
    - setInInvoiceId() + setInInvoiceId()  : void
    - setInPaymentRequest() + setInPaymentRequest()  : void
    - setInvoiceTime() + setInvoiceTime()  : void
    - setOrderId() + setOrderId()  : void
    - setPaymentSubtotals() + setPaymentSubtotals()  : void
    - setPaymentTotals() + setPaymentTotals()  : void
    - setPosData() + setPosData()  : void
    - setPrice() + setPrice()  : void
    - setStatus() + setStatus()  : void
    - setTransactionCurrency() + setTransactionCurrency()  : void
    - setUrl() + setUrl()  : void
    @@ -585,6 +586,7 @@

    + protected float|null @@ -620,6 +622,7 @@

    + protected BuyerFields|null @@ -655,6 +658,7 @@

    + protected string|null @@ -690,6 +694,7 @@

    + protected string|null @@ -725,6 +730,7 @@

    + protected string|null @@ -760,6 +766,7 @@

    + protected array<string|int, mixed>|null @@ -795,6 +802,7 @@

    + protected string|null @@ -830,6 +838,7 @@

    + protected string|null @@ -865,6 +874,7 @@

    + protected string|null @@ -900,6 +910,7 @@

    + protected string|null @@ -935,6 +946,7 @@

    + protected string|null @@ -970,6 +982,7 @@

    + protected array<string|int, mixed>|null @@ -1005,6 +1018,7 @@

    + protected array<string|int, mixed>|null @@ -1040,6 +1054,7 @@

    + protected string|null @@ -1075,6 +1090,7 @@

    + protected float|null @@ -1110,6 +1126,7 @@

    + protected string|null @@ -1145,6 +1162,7 @@

    + protected string|null @@ -1180,6 +1198,7 @@

    + protected string|null @@ -1229,6 +1248,7 @@

    + @@ -1266,6 +1286,7 @@

    + @@ -1303,6 +1324,7 @@

    + @@ -1340,6 +1362,7 @@

    + @@ -1377,6 +1400,7 @@

    + @@ -1414,6 +1438,7 @@

    + @@ -1451,6 +1476,7 @@

    + @@ -1488,6 +1514,7 @@

    + @@ -1525,6 +1552,7 @@

    + @@ -1562,6 +1590,7 @@

    + @@ -1599,6 +1628,7 @@

    + @@ -1636,6 +1666,7 @@

    + @@ -1673,6 +1704,7 @@

    + @@ -1710,6 +1742,7 @@

    + @@ -1747,6 +1780,7 @@

    + @@ -1784,6 +1818,7 @@

    + @@ -1821,6 +1856,7 @@

    + @@ -1858,6 +1894,7 @@

    + @@ -1893,6 +1930,7 @@

    +

    Parameters
    @@ -1936,6 +1974,7 @@

    +

    Parameters
    @@ -1979,6 +2018,7 @@

    +

    Parameters
    @@ -2022,6 +2062,7 @@

    +

    Parameters
    @@ -2065,6 +2106,7 @@

    +

    Parameters
    @@ -2108,6 +2150,7 @@

    +

    Parameters
    @@ -2151,6 +2194,7 @@

    +

    Parameters
    @@ -2194,6 +2238,7 @@

    +

    Parameters
    @@ -2237,6 +2282,7 @@

    +

    Parameters
    @@ -2280,6 +2326,7 @@

    +

    Parameters
    @@ -2323,6 +2370,7 @@

    +

    Parameters
    @@ -2366,6 +2414,7 @@

    +

    Parameters
    @@ -2409,6 +2458,7 @@

    +

    Parameters
    @@ -2452,6 +2502,7 @@

    +

    Parameters
    @@ -2495,6 +2546,7 @@

    +

    Parameters
    @@ -2538,6 +2590,7 @@

    +

    Parameters
    @@ -2581,6 +2634,7 @@

    +

    Parameters
    @@ -2624,6 +2678,7 @@

    +

    Parameters
    @@ -2754,66 +2809,66 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html b/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html index 58eaed33..d0ed0461 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html +++ b/docs/classes/BitPaySDK-Model-Invoice-ItemizedDetails.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,19 +221,19 @@

    - $amount + $amount  : float|null
    - $description + $description  : string|null
    - $isFee + $isFee  : bool|null
    @@ -246,55 +247,55 @@

    - __construct() + __construct()  : mixed
    - getAmount() + getAmount()  : float|null
    Gets The amount of currency.
    - getDescription() + getDescription()  : string|null
    Gets description
    - getIsFee() + getIsFee()  : bool|null
    Gets is fee
    - setAmount() + setAmount()  : void
    Sets The amount of currency.
    - setDescription() + setDescription()  : void
    Sets string for the item.
    - setIsFee() + setIsFee()  : void
    Sets is fee
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -335,6 +336,7 @@

    + protected float|null @@ -370,6 +372,7 @@

    + protected string|null @@ -405,6 +408,7 @@

    + protected bool|null @@ -454,6 +458,7 @@

    + @@ -488,6 +493,7 @@

    + @@ -527,6 +533,7 @@

    +

    Display string for the item.

    @@ -571,6 +578,7 @@

    +

    Indicates whether or not the item is considered a fee/tax or part of the main purchase.

    @@ -616,6 +624,7 @@

    +

    Parameters
    @@ -662,6 +671,7 @@

    +

    Parameters
    @@ -707,6 +717,7 @@

    +

    Gets Indicates whether or not the item is considered a fee/tax or part of the main purchase.

    @@ -758,6 +769,7 @@

    + @@ -884,23 +896,23 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html b/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html index 0adae43d..3926ae35 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html +++ b/docs/classes/BitPaySDK-Model-Invoice-MinerFees.html @@ -157,6 +157,7 @@

    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.

    @@ -224,85 +225,85 @@

    - $bch + $bch  : MinerFeesItem
    - $btc + $btc  : MinerFeesItem
    - $busd + $busd  : MinerFeesItem
    - $dai + $dai  : MinerFeesItem
    - $doge + $doge  : MinerFeesItem
    - $eth + $eth  : MinerFeesItem
    - $gusd + $gusd  : MinerFeesItem
    - $ltc + $ltc  : MinerFeesItem
    - $matic + $matic  : MinerFeesItem
    - $pax + $pax  : MinerFeesItem
    - $usdc + $usdc  : MinerFeesItem
    - $usdcM + $usdcM  : MinerFeesItem
    - $wbtc + $wbtc  : MinerFeesItem
    - $xrp + $xrp  : MinerFeesItem
    @@ -316,210 +317,210 @@

    - __construct() + __construct()  : mixed
    MinerFees constructor.
    - getBCH() + getBCH()  : MinerFeesItem
    Gets BCH.
    - getBTC() + getBTC()  : MinerFeesItem
    Gets BTC.
    - getBUSD() + getBUSD()  : MinerFeesItem
    Gets BUSD.
    - getDAI() + getDAI()  : MinerFeesItem
    Gets DAI.
    - getDOGE() + getDOGE()  : MinerFeesItem
    Gets DOGE.
    - getETH() + getETH()  : MinerFeesItem
    Gets ETH.
    - getGUSD() + getGUSD()  : MinerFeesItem
    Gets GUSD.
    - getLTC() + getLTC()  : MinerFeesItem
    Gets LTC.
    - getMATIC() + getMATIC()  : MinerFeesItem
    Gets MATIC.
    - getPAX() + getPAX()  : MinerFeesItem
    Gets PAX.
    - getUSDC() + getUSDC()  : MinerFeesItem
    Gets USDC.
    - getUsdcM() + getUsdcM()  : MinerFeesItem
    Gets USDC_m.
    - getWBTC() + getWBTC()  : MinerFeesItem
    Gets WBTC.
    - getXRP() + getXRP()  : MinerFeesItem
    Gets XRP.
    - setBCH() + setBCH()  : void
    Sets BCH.
    - setBTC() + setBTC()  : void
    Sets BTC.
    - setBUSD() + setBUSD()  : void
    Sets BUSD.
    - setDAI() + setDAI()  : void
    Sets DAI.
    - setDOGE() + setDOGE()  : void
    Sets DOGE.
    - setETH() + setETH()  : void
    Sets ETH.
    - setGUSD() + setGUSD()  : void
    Sets GUSD.
    - setLTC() + setLTC()  : void
    Sets LTC.
    - setMATIC() + setMATIC()  : void
    Sets MATIC.
    - setPAX() + setPAX()  : void
    Sets PAX.
    - setUSDC() + setUSDC()  : void
    Sets USDC.
    - setUsdcM() + setUsdcM()  : void
    Sets USDC_m.
    - setWBTC() + setWBTC()  : void
    Sets WBTC.
    - setXRP() + setXRP()  : void
    Sets XRP.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -560,6 +561,7 @@

    + protected MinerFeesItem @@ -595,6 +597,7 @@

    + protected MinerFeesItem @@ -630,6 +633,7 @@

    + protected MinerFeesItem @@ -665,6 +669,7 @@

    + protected MinerFeesItem @@ -700,6 +705,7 @@

    + protected MinerFeesItem @@ -735,6 +741,7 @@

    + protected MinerFeesItem @@ -770,6 +777,7 @@

    + protected MinerFeesItem @@ -805,6 +813,7 @@

    + protected MinerFeesItem @@ -840,6 +849,7 @@

    + protected MinerFeesItem @@ -875,6 +885,7 @@

    + protected MinerFeesItem @@ -910,6 +921,7 @@

    + protected MinerFeesItem @@ -945,6 +957,7 @@

    + protected MinerFeesItem @@ -980,6 +993,7 @@

    + protected MinerFeesItem @@ -1015,6 +1029,7 @@

    + protected MinerFeesItem @@ -1065,6 +1080,7 @@

    + @@ -1099,6 +1115,7 @@

    + @@ -1137,6 +1154,7 @@

    + @@ -1175,6 +1193,7 @@

    + @@ -1213,6 +1232,7 @@

    + @@ -1251,6 +1271,7 @@

    + @@ -1289,6 +1310,7 @@

    + @@ -1327,6 +1349,7 @@

    + @@ -1365,6 +1388,7 @@

    + @@ -1403,6 +1427,7 @@

    + @@ -1441,6 +1466,7 @@

    + @@ -1479,6 +1505,7 @@

    + @@ -1517,6 +1544,7 @@

    + @@ -1555,6 +1583,7 @@

    + @@ -1593,6 +1622,7 @@

    + @@ -1629,6 +1659,7 @@

    +

    Parameters
    @@ -1675,6 +1706,7 @@

    +

    Parameters
    @@ -1721,6 +1753,7 @@

    +

    Parameters
    @@ -1767,6 +1800,7 @@

    +

    Parameters
    @@ -1811,6 +1845,7 @@

    +

    Parameters
    @@ -1857,6 +1892,7 @@

    +

    Parameters
    @@ -1903,6 +1939,7 @@

    +

    Parameters
    @@ -1949,6 +1986,7 @@

    +

    Parameters
    @@ -1995,6 +2033,7 @@

    +

    Parameters
    @@ -2039,6 +2078,7 @@

    +

    Parameters
    @@ -2085,6 +2125,7 @@

    +

    Parameters
    @@ -2131,6 +2172,7 @@

    +

    Parameters
    @@ -2175,6 +2217,7 @@

    +

    Parameters
    @@ -2219,6 +2262,7 @@

    +

    Parameters
    @@ -2267,6 +2311,7 @@

    + @@ -2389,56 +2434,56 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html index 7abe9af1..b6806e54 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html +++ b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,19 +221,19 @@

    - $fiatAmount + $fiatAmount  : float|null
    - $satoshisPerByte + $satoshisPerByte  : float|null
    - $totalFee + $totalFee  : int|null
    @@ -246,49 +247,49 @@

    - __construct() + __construct()  : mixed
    - getFiatAmount() + getFiatAmount()  : float|null
    - getSatoshisPerByte() + getSatoshisPerByte()  : float|null
    - getTotalFee() + getTotalFee()  : int|null
    - setFiatAmount() + setFiatAmount()  : void
    - setSatoshisPerByte() + setSatoshisPerByte()  : void
    - setTotalFee() + setTotalFee()  : void
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -328,6 +329,7 @@

    + protected float|null @@ -363,6 +365,7 @@

    + protected float|null @@ -398,6 +401,7 @@

    + protected int|null @@ -447,6 +451,7 @@

    + @@ -480,6 +485,7 @@

    + @@ -517,6 +523,7 @@

    + @@ -554,6 +561,7 @@

    + @@ -589,6 +597,7 @@

    +

    Parameters
    @@ -632,6 +641,7 @@

    +

    Parameters
    @@ -675,6 +685,7 @@

    +

    Parameters
    @@ -720,6 +731,7 @@

    + @@ -842,23 +854,23 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-Refund.html b/docs/classes/BitPaySDK-Model-Invoice-Refund.html index 0e85f4a3..e863ba3b 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Refund.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Refund.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,139 +221,139 @@

    - $amount + $amount  : float
    - $buyerPaysRefundFee + $buyerPaysRefundFee  : bool|null
    - $currency + $currency  : string
    - $guid + $guid  : string|null
    - $id + $id  : string|null
    - $immediate + $immediate  : bool|null
    - $invoice + $invoice  : string|null
    - $invoiceId + $invoiceId  : string|null
    - $lastRefundNotification + $lastRefundNotification  : string|null
    - $notificationURL + $notificationURL  : string|null
    - $preview + $preview  : bool|null
    - $reference + $reference  : string|null
    - $refundAddress + $refundAddress  : string|null
    - $refundFee + $refundFee  : float|null
    - $requestDate + $requestDate  : string|null
    - $status + $status  : string|null
    - $supportRequest + $supportRequest  : string|null
    - $token + $token  : string
    - $transactionAmount + $transactionAmount  : float|null
    - $transactionCurrency + $transactionCurrency  : string|null
    - $transactionRefundFee + $transactionRefundFee  : float|null
    - $txid + $txid  : string|null
    - $type + $type  : string|null
    @@ -366,21 +367,21 @@

    - __construct() + __construct()  : mixed
    Constructor, create Refund object
    - getAmount() + getAmount()  : float
    Gets amount to be refunded in the invoice currency
    - getBuyerPaysRefundFee() + getBuyerPaysRefundFee()  : bool|null
    @@ -388,14 +389,14 @@

    than the merchant
    - getCurrency() + getCurrency()  : string
    Gets reference currency used for the refund, the same as the currency used to create the invoice
    - getGuid() + getGuid()  : string|null
    @@ -403,14 +404,14 @@

    the invoice with an order ID in their system
    - getId() + getId()  : string|null
    Gets the ID of the refund
    - getImmediate() + getImmediate()  : bool|null
    @@ -418,119 +419,119 @@

    on submission or at the time of processing
    - getInvoice() + getInvoice()  : string|null
    Gets the ID of the invoice being refunded
    - getInvoiceId() + getInvoiceId()  : string|null
    Gets the ID of the invoice to refund
    - getLastRefundNotification() + getLastRefundNotification()  : string|null
    Gets the last time notification of buyer was attempted
    - getNotificationURL() + getNotificationURL()  : string|null
    Gets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
    - getPreview() + getPreview()  : bool|null
    Whether to create the refund request as a preview
    - getReference() + getReference()  : string|null
    Present only if specified in the request to create the refund. This is your reference label for this refund.
    - getRefundAddress() + getRefundAddress()  : string|null
    Gets the wallet address that the refund will return the funds to, added by the customer.
    - getRefundFee() + getRefundFee()  : float|null
    Gets the amount of refund fee expressed in terms of pricing currency
    - getRequestDate() + getRequestDate()  : string|null
    Gets the date the refund was requested
    - getStatus() + getStatus()  : string|null
    Gets the refund lifecycle status of the request
    - getSupportRequest() + getSupportRequest()  : string|null
    Gets the ID of the associated support request for the refund.
    - getToken() + getToken()  : string
    Gets API token
    - getTransactionAmount() + getTransactionAmount()  : float|null
    Gets amount to be refunded in terms of the transaction currency.
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    Gets the currency used for the invoice transaction.
    - getTransactionRefundFee() + getTransactionRefundFee()  : float|null
    Gets the refund fee expressed in terms of transaction currency.
    - getTxid() + getTxid()  : string|null
    Gets the transaction ID of the refund once executed.
    - getType() + getType()  : string|null
    @@ -540,161 +541,161 @@

    <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
    - setAmount() + setAmount()  : void
    Sets amount to be refunded
    - setBuyerPaysRefundFee() + setBuyerPaysRefundFee()  : void
    Sets whether the buyer should pay the refund fee rather
    - setCurrency() + setCurrency()  : void
    Sets currency used for the refund
    - setGuid() + setGuid()  : void
    Sets guid
    - setId() + setId()  : void
    Sets id of the refund
    - setImmediate() + setImmediate()  : void
    Sets immediate value
    - setInvoice() + setInvoice()  : void
    Sets the id of the invoice being refunded
    - setInvoiceId() + setInvoiceId()  : void
    Sets invoice id
    - setLastRefundNotification() + setLastRefundNotification()  : void
    Sets last refund notification
    - setNotificationURL() + setNotificationURL()  : void
    Sets URL to which BitPay sends webhook notifications. HTTPS is mandatory.
    - setPreview() + setPreview()  : void
    Sets preview
    - setReference() + setReference()  : void
    Sets reference label for refund
    - setRefundAddress() + setRefundAddress()  : void
    Sets the wallet address that the refund will return the funds to, added by the customer.
    - setRefundFee() + setRefundFee()  : void
    Sets amount of the refund fee
    - setRequestDate() + setRequestDate()  : void
    Sets request date
    - setStatus() + setStatus()  : void
    Sets refund status
    - setSupportRequest() + setSupportRequest()  : void
    Sets the ID of the associated support request for the refund.
    - setToken() + setToken()  : void
    Sets API token
    - setTransactionAmount() + setTransactionAmount()  : void
    Sets amount to be refunded in terms of the transaction currency.
    - setTransactionCurrency() + setTransactionCurrency()  : void
    Sets the currency used for the invoice transaction.
    - setTransactionRefundFee() + setTransactionRefundFee()  : void
    Sets the refund fee expressed in terms of transaction currency.
    - setTxid() + setTxid()  : void
    Sets the transaction ID of the refund once executed.
    - setType() + setType()  : void
    @@ -704,7 +705,7 @@

    <li>full (fixed rate): A full refund of the amount paid at the fixed rate.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -745,6 +746,7 @@

    + protected float @@ -780,6 +782,7 @@

    + protected bool|null @@ -815,6 +818,7 @@

    + protected string @@ -850,6 +854,7 @@

    + protected string|null @@ -885,6 +890,7 @@

    + protected string|null @@ -920,6 +926,7 @@

    + protected bool|null @@ -955,6 +962,7 @@

    + protected string|null @@ -990,6 +998,7 @@

    + protected string|null @@ -1025,6 +1034,7 @@

    + protected string|null @@ -1060,6 +1070,7 @@

    + protected string|null @@ -1095,6 +1106,7 @@

    + protected bool|null @@ -1130,6 +1142,7 @@

    + protected string|null @@ -1165,6 +1178,7 @@

    + protected string|null @@ -1200,6 +1214,7 @@

    + protected float|null @@ -1235,6 +1250,7 @@

    + protected string|null @@ -1270,6 +1286,7 @@

    + protected string|null @@ -1305,6 +1322,7 @@

    + protected string|null @@ -1340,6 +1358,7 @@

    + protected string @@ -1375,6 +1394,7 @@

    + protected float|null @@ -1410,6 +1430,7 @@

    + protected string|null @@ -1445,6 +1466,7 @@

    + protected float|null @@ -1480,6 +1502,7 @@

    + protected string|null @@ -1515,6 +1538,7 @@

    + protected string|null @@ -1563,6 +1587,7 @@

    +

    Parameters
    @@ -1623,6 +1648,7 @@

    + @@ -1662,6 +1688,7 @@

    + @@ -1700,6 +1727,7 @@

    + @@ -1739,6 +1767,7 @@

    + @@ -1777,6 +1806,7 @@

    + @@ -1816,6 +1846,7 @@

    + @@ -1854,6 +1885,7 @@

    + @@ -1892,6 +1924,7 @@

    + @@ -1930,6 +1963,7 @@

    + @@ -1968,6 +2002,7 @@

    + @@ -2006,6 +2041,7 @@

    + @@ -2041,6 +2077,7 @@

    +

    It will be passed-through on each response for you to identify the refund in your system. Maximum string length is 100 characters

    @@ -2085,6 +2122,7 @@

    + @@ -2123,6 +2161,7 @@

    + @@ -2161,6 +2200,7 @@

    + @@ -2199,6 +2239,7 @@

    + @@ -2237,6 +2278,7 @@

    + @@ -2275,6 +2317,7 @@

    + @@ -2313,6 +2356,7 @@

    + @@ -2351,6 +2395,7 @@

    + @@ -2389,6 +2434,7 @@

    + @@ -2427,6 +2473,7 @@

    + @@ -2465,6 +2512,7 @@

    +

    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.
    • @@ -2512,6 +2560,7 @@

    +

    Parameters
    @@ -2556,6 +2605,7 @@

    +

    Parameters
    @@ -2600,6 +2650,7 @@

    +

    Parameters
    @@ -2644,6 +2695,7 @@

    +

    Parameters
    @@ -2688,6 +2740,7 @@

    +

    Parameters
    @@ -2732,6 +2785,7 @@

    +

    Parameters
    @@ -2776,6 +2830,7 @@

    +

    Parameters
    @@ -2820,6 +2875,7 @@

    +

    Parameters
    @@ -2864,6 +2920,7 @@

    +

    Parameters
    @@ -2908,6 +2965,7 @@

    +

    Parameters
    @@ -2952,6 +3010,7 @@

    +

    Parameters
    @@ -2996,6 +3055,7 @@

    +

    Parameters
    @@ -3042,6 +3102,7 @@

    +

    Parameters
    @@ -3086,6 +3147,7 @@

    +

    Parameters
    @@ -3130,6 +3192,7 @@

    +

    Parameters
    @@ -3174,6 +3237,7 @@

    +

    Parameters
    @@ -3218,6 +3282,7 @@

    +

    Parameters
    @@ -3262,6 +3327,7 @@

    +

    Parameters
    @@ -3306,6 +3372,7 @@

    +

    Parameters
    @@ -3350,6 +3417,7 @@

    +

    Parameters
    @@ -3394,6 +3462,7 @@

    +

    Parameters
    @@ -3438,6 +3507,7 @@

    +

    Parameters
    @@ -3484,6 +3554,7 @@

    +

    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.
    • @@ -3539,6 +3610,7 @@

    + @@ -3661,83 +3733,83 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html b/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html index 621d9834..b27680fb 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html +++ b/docs/classes/BitPaySDK-Model-Invoice-RefundInfo.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,19 +221,19 @@

    - $amounts + $amounts  : array<string|int, mixed>|null
    - $currency + $currency  : string|null
    - $supportRequest + $supportRequest  : string|null
    @@ -246,55 +247,55 @@

    - __construct() + __construct()  : mixed
    - getAmounts() + getAmounts()  : array<string|int, mixed>|null
    Gets amounts
    - getCurrency() + getCurrency()  : string|null
    Gets currency
    - getSupportRequest() + getSupportRequest()  : string|null
    Gets support request
    - setAmounts() + setAmounts()  : void
    Set amounts
    - setCurrency() + setCurrency()  : void
    Sets currency
    - setSupportRequest() + setSupportRequest()  : void
    Sets support request
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -335,6 +336,7 @@

    + protected array<string|int, mixed>|null @@ -370,6 +372,7 @@

    + protected string|null @@ -405,6 +408,7 @@

    + protected string|null @@ -454,6 +458,7 @@

    + @@ -485,6 +490,7 @@

    +

    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 @@ -532,6 +538,7 @@

    +

    For a refunded invoice, this field will contain the base currency selected for the refund. Typically the same as the invoice currency.

    @@ -577,6 +584,7 @@

    +

    For a refunded invoice, this field will contain the refund requestId once executed.

    @@ -621,6 +629,7 @@

    +

    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 @@ -672,6 +681,7 @@

    +

    For a refunded invoice, this field will contain the base currency selected for the refund. Typically the same as the invoice currency.

    @@ -721,6 +731,7 @@

    +

    For a refunded invoice, this field will contain the refund requestId once executed.

    @@ -772,6 +783,7 @@

    + @@ -898,23 +910,23 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html b/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html index 3ae2c418..791b59af 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html +++ b/docs/classes/BitPaySDK-Model-Invoice-RefundStatus.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,14 +210,14 @@

    - CANCELLED + CANCELLED  = "cancelled"
    Refund was canceled by merchant action. Immediate refunds cannot be canceled outside of preview state
    - CREATED + CREATED  = "created"
    @@ -224,28 +225,28 @@

    and the required data is collected
    - FAILURE + FAILURE  = "failure"
    Refund failed during processing (this is really more of an internal state)
    - PENDING + PENDING  = "pending"
    Refund is in process of being fulfilled
    - PREVIEW + PREVIEW  = "preview"
    No funds deducted, refund will not proceed automatically
    - SUCCESS + SUCCESS  = "success"
    @@ -282,6 +283,7 @@

    Refund was canceled by merchant action. Immediate refunds cannot be canceled outside of preview state

    + public mixed @@ -314,6 +316,7 @@

    Funds deducted/allocated if immediate, will proceed when transactions are confirmed and the required data is collected

    + public mixed @@ -345,6 +348,7 @@

    Refund failed during processing (this is really more of an internal state)

    + public mixed @@ -376,6 +380,7 @@

    Refund is in process of being fulfilled

    + public mixed @@ -407,6 +412,7 @@

    No funds deducted, refund will not proceed automatically

    + public mixed @@ -438,6 +444,7 @@

    Refund was successfully processed

    + public mixed @@ -567,12 +574,12 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html b/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html index 3e781a27..689f1a67 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html +++ b/docs/classes/BitPaySDK-Model-Invoice-RefundWebhook.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,115 +221,115 @@

    - $amount + $amount  : float|null
    - $buyerPaysRefundFee + $buyerPaysRefundFee  : bool|null
    - $currency + $currency  : string|null
    - $guid + $guid  : string|null
    - $id + $id  : string|null
    - $immediate + $immediate  : bool|null
    - $invoice + $invoice  : string|null
    - $lastRefundNotification + $lastRefundNotification  : string|null
    - $reference + $reference  : string|null
    - $refundAddress + $refundAddress  : string|null
    - $refundFee + $refundFee  : float|null
    - $requestDate + $requestDate  : string|null
    - $status + $status  : string|null
    - $supportRequest + $supportRequest  : string|null
    - $transactionAmount + $transactionAmount  : float|null
    - $transactionCurrency + $transactionCurrency  : string|null
    - $transactionRefundFee + $transactionRefundFee  : float|null
    - $txid + $txid  : string|null
    - $type + $type  : string|null
    @@ -342,235 +343,235 @@

    - getAmount() + getAmount()  : float|null
    - getBuyerPaysRefundFee() + getBuyerPaysRefundFee()  : bool|null
    - getCurrency() + getCurrency()  : string|null
    - getGuid() + getGuid()  : string|null
    - getId() + getId()  : string|null
    - getImmediate() + getImmediate()  : bool|null
    - getInvoice() + getInvoice()  : string|null
    - getLastRefundNotification() + getLastRefundNotification()  : string|null
    - getReference() + getReference()  : string|null
    - getRefundAddress() + getRefundAddress()  : string|null
    - getRefundFee() + getRefundFee()  : float|null
    - getRequestDate() + getRequestDate()  : string|null
    - getStatus() + getStatus()  : string|null
    - getSupportRequest() + getSupportRequest()  : string|null
    - getTransactionAmount() + getTransactionAmount()  : float|null
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    - getTransactionRefundFee() + getTransactionRefundFee()  : float|null
    - getTxid() + getTxid()  : string|null
    - getType() + getType()  : string|null
    - setAmount() + setAmount()  : void
    - setBuyerPaysRefundFee() + setBuyerPaysRefundFee()  : void
    - setCurrency() + setCurrency()  : void
    - setGuid() + setGuid()  : void
    - setId() + setId()  : void
    - setImmediate() + setImmediate()  : void
    - setInvoice() + setInvoice()  : void
    - setLastRefundNotification() + setLastRefundNotification()  : void
    - setReference() + setReference()  : void
    - setRefundAddress() + setRefundAddress()  : void
    - setRefundFee() + setRefundFee()  : void
    - setRequestDate() + setRequestDate()  : void
    - setStatus() + setStatus()  : void
    - setSupportRequest() + setSupportRequest()  : void
    - setTransactionAmount() + setTransactionAmount()  : void
    - setTransactionCurrency() + setTransactionCurrency()  : void
    - setTransactionRefundFee() + setTransactionRefundFee()  : void
    - setTxid() + setTxid()  : void
    - setType() + setType()  : void
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -610,6 +611,7 @@

    + protected float|null @@ -645,6 +647,7 @@

    + protected bool|null @@ -680,6 +683,7 @@

    + protected string|null @@ -715,6 +719,7 @@

    + protected string|null @@ -750,6 +755,7 @@

    + protected string|null @@ -785,6 +791,7 @@

    + protected bool|null @@ -820,6 +827,7 @@

    + protected string|null @@ -855,6 +863,7 @@

    + protected string|null @@ -890,6 +899,7 @@

    + protected string|null @@ -925,6 +935,7 @@

    + protected string|null @@ -960,6 +971,7 @@

    + protected float|null @@ -995,6 +1007,7 @@

    + protected string|null @@ -1030,6 +1043,7 @@

    + protected string|null @@ -1065,6 +1079,7 @@

    + protected string|null @@ -1100,6 +1115,7 @@

    + protected float|null @@ -1135,6 +1151,7 @@

    + protected string|null @@ -1170,6 +1187,7 @@

    + protected float|null @@ -1205,6 +1223,7 @@

    + protected string|null @@ -1240,6 +1259,7 @@

    + protected string|null @@ -1289,6 +1309,7 @@

    + @@ -1326,6 +1347,7 @@

    + @@ -1363,6 +1385,7 @@

    + @@ -1400,6 +1423,7 @@

    + @@ -1437,6 +1461,7 @@

    + @@ -1474,6 +1499,7 @@

    + @@ -1511,6 +1537,7 @@

    + @@ -1548,6 +1575,7 @@

    + @@ -1585,6 +1613,7 @@

    + @@ -1622,6 +1651,7 @@

    + @@ -1659,6 +1689,7 @@

    + @@ -1696,6 +1727,7 @@

    + @@ -1733,6 +1765,7 @@

    + @@ -1770,6 +1803,7 @@

    + @@ -1807,6 +1841,7 @@

    + @@ -1844,6 +1879,7 @@

    + @@ -1881,6 +1917,7 @@

    + @@ -1918,6 +1955,7 @@

    + @@ -1955,6 +1993,7 @@

    + @@ -1990,6 +2029,7 @@

    +

    Parameters
    @@ -2033,6 +2073,7 @@

    +

    Parameters
    @@ -2076,6 +2117,7 @@

    +

    Parameters
    @@ -2119,6 +2161,7 @@

    +

    Parameters
    @@ -2162,6 +2205,7 @@

    +

    Parameters
    @@ -2205,6 +2249,7 @@

    +

    Parameters
    @@ -2248,6 +2293,7 @@

    +

    Parameters
    @@ -2291,6 +2337,7 @@

    +

    Parameters
    @@ -2334,6 +2381,7 @@

    +

    Parameters
    @@ -2377,6 +2425,7 @@

    +

    Parameters
    @@ -2420,6 +2469,7 @@

    +

    Parameters
    @@ -2463,6 +2513,7 @@

    +

    Parameters
    @@ -2506,6 +2557,7 @@

    +

    Parameters
    @@ -2549,6 +2601,7 @@

    +

    Parameters
    @@ -2592,6 +2645,7 @@

    +

    Parameters
    @@ -2635,6 +2689,7 @@

    +

    Parameters
    @@ -2678,6 +2733,7 @@

    +

    Parameters
    @@ -2721,6 +2777,7 @@

    +

    Parameters
    @@ -2764,6 +2821,7 @@

    +

    Parameters
    @@ -2809,6 +2867,7 @@

    + @@ -2931,70 +2990,70 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-Shopper.html b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html index 47c5eefb..1f121142 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Shopper.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html @@ -157,6 +157,7 @@

    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.

    @@ -222,7 +223,7 @@

    - $user + $user  : string|null
    @@ -236,27 +237,27 @@

    - __construct() + __construct()  : mixed
    - getUser() + getUser()  : string|null
    Gets user
    - setUser() + setUser()  : void
    Sets user
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -297,6 +298,7 @@

    + protected string|null @@ -346,6 +348,7 @@

    + @@ -377,6 +380,7 @@

    +

    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.

    @@ -422,6 +426,7 @@

    +

    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.

    @@ -474,6 +479,7 @@

    + @@ -600,17 +606,17 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html index 42e6f09b..1fbe634a 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html +++ b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrencies.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,127 +221,127 @@

    - $bch + $bch  : SupportedTransactionCurrency
    - $btc + $btc  : SupportedTransactionCurrency
    - $busd + $busd  : SupportedTransactionCurrency
    - $busdM + $busdM  : SupportedTransactionCurrency
    - $dai + $dai  : SupportedTransactionCurrency
    - $daiM + $daiM  : SupportedTransactionCurrency
    - $doge + $doge  : SupportedTransactionCurrency
    - $eth + $eth  : SupportedTransactionCurrency
    - $ethM + $ethM  : SupportedTransactionCurrency
    - $euroc + $euroc  : SupportedTransactionCurrency
    - $gusd + $gusd  : SupportedTransactionCurrency
    - $ltc + $ltc  : SupportedTransactionCurrency
    - $matic + $matic  : SupportedTransactionCurrency
    - $maticE + $maticE  : SupportedTransactionCurrency
    - $pax + $pax  : SupportedTransactionCurrency
    - $shibM + $shibM  : SupportedTransactionCurrency
    - $usdc + $usdc  : SupportedTransactionCurrency
    - $usdcM + $usdcM  : SupportedTransactionCurrency
    - $wbtc + $wbtc  : SupportedTransactionCurrency
    - $wbtcM + $wbtcM  : SupportedTransactionCurrency
    - $xrp + $xrp  : SupportedTransactionCurrency
    @@ -354,308 +355,308 @@

    - __construct() + __construct()  : mixed
    SupportedTransactionCurrencies constructor.
    - getBCH() + getBCH()  : SupportedTransactionCurrency
    Gets BCH.
    - getBTC() + getBTC()  : SupportedTransactionCurrency
    Gets BTC.
    - getBUSD() + getBUSD()  : SupportedTransactionCurrency
    Gets BUSD.
    - getBusdM() + getBusdM()  : SupportedTransactionCurrency
    Gets BUSD_m.
    - getDAI() + getDAI()  : SupportedTransactionCurrency
    Gets DAI.
    - getDaiM() + getDaiM()  : SupportedTransactionCurrency
    Gets DAI_m.
    - getDOGE() + getDOGE()  : SupportedTransactionCurrency
    Gets DOGE.
    - getETH() + getETH()  : SupportedTransactionCurrency
    Gets ETH.
    - getEthM() + getEthM()  : SupportedTransactionCurrency
    Gets ETC_m.
    - getEUROC() + getEUROC()  : SupportedTransactionCurrency
    Gets EUROC.
    - getGUSD() + getGUSD()  : SupportedTransactionCurrency
    Gets GUSD.
    - getLTC() + getLTC()  : SupportedTransactionCurrency
    Gets LTC.
    - getMATIC() + getMATIC()  : SupportedTransactionCurrency
    Gets MATIC.
    - getMaticE() + getMaticE()  : SupportedTransactionCurrency
    Gets MATIC_e
    - getPAX() + getPAX()  : SupportedTransactionCurrency
    Gets PAX.
    - getShibM() + getShibM()  : SupportedTransactionCurrency
    Gets SHIB_m.
    - getUSDC() + getUSDC()  : SupportedTransactionCurrency
    Gets USDC.
    - getUsdcM() + getUsdcM()  : SupportedTransactionCurrency
    Gets USDC_m.
    - getWBTC() + getWBTC()  : SupportedTransactionCurrency
    Gets WBTC.
    - getWbtcM() + getWbtcM()  : SupportedTransactionCurrency
    Gets WBTC_m.
    - getXRP() + getXRP()  : SupportedTransactionCurrency
    Gets XRP.
    - setBCH() + setBCH()  : void
    Sets BCH.
    - setBTC() + setBTC()  : void
    Sets BTC.
    - setBUSD() + setBUSD()  : void
    Sets BUSD.
    - setBusdM() + setBusdM()  : void
    Sets BUSD_m.
    - setDAI() + setDAI()  : void
    Sets DAI.
    - setDaiM() + setDaiM()  : void
    Sets DAI_m.
    - setDOGE() + setDOGE()  : void
    Sets DOGE.
    - setETH() + setETH()  : void
    Sets ETH.
    - setEthM() + setEthM()  : void
    Sets ETC_m.
    - setEUROC() + setEUROC()  : void
    Sets EUROC.
    - setGUSD() + setGUSD()  : void
    Sets GUSD.
    - setLTC() + setLTC()  : void
    Sets LTC.
    - setMATIC() + setMATIC()  : void
    Sets MATIC.
    - setMaticE() + setMaticE()  : void
    Sets MATIC_e.
    - setPAX() + setPAX()  : void
    Sets PAX.
    - setShibM() + setShibM()  : void
    Sets SHIB_m.
    - setUSDC() + setUSDC()  : void
    Sets USDC.
    - setUsdcM() + setUsdcM()  : void
    Sets USDC_m.
    - setWBTC() + setWBTC()  : void
    Sets WBTC.
    - setWbtcM() + setWbtcM()  : void
    Sets WBTC_m.
    - setXRP() + setXRP()  : void
    Sets XRP.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -696,6 +697,7 @@

    + protected SupportedTransactionCurrency @@ -731,6 +733,7 @@

    + protected SupportedTransactionCurrency @@ -766,6 +769,7 @@

    + protected SupportedTransactionCurrency @@ -801,6 +805,7 @@

    + protected SupportedTransactionCurrency @@ -836,6 +841,7 @@

    + protected SupportedTransactionCurrency @@ -871,6 +877,7 @@

    + protected SupportedTransactionCurrency @@ -906,6 +913,7 @@

    + protected SupportedTransactionCurrency @@ -941,6 +949,7 @@

    + protected SupportedTransactionCurrency @@ -976,6 +985,7 @@

    + protected SupportedTransactionCurrency @@ -1011,6 +1021,7 @@

    + protected SupportedTransactionCurrency @@ -1046,6 +1057,7 @@

    + protected SupportedTransactionCurrency @@ -1081,6 +1093,7 @@

    + protected SupportedTransactionCurrency @@ -1116,6 +1129,7 @@

    + protected SupportedTransactionCurrency @@ -1151,6 +1165,7 @@

    + protected SupportedTransactionCurrency @@ -1186,6 +1201,7 @@

    + protected SupportedTransactionCurrency @@ -1221,6 +1237,7 @@

    + protected SupportedTransactionCurrency @@ -1256,6 +1273,7 @@

    + protected SupportedTransactionCurrency @@ -1291,6 +1309,7 @@

    + protected SupportedTransactionCurrency @@ -1326,6 +1345,7 @@

    + protected SupportedTransactionCurrency @@ -1361,6 +1381,7 @@

    + protected SupportedTransactionCurrency @@ -1396,6 +1417,7 @@

    + protected SupportedTransactionCurrency @@ -1446,6 +1468,7 @@

    + @@ -1480,6 +1503,7 @@

    + @@ -1518,6 +1542,7 @@

    + @@ -1556,6 +1581,7 @@

    + @@ -1594,6 +1620,7 @@

    + @@ -1632,6 +1659,7 @@

    + @@ -1670,6 +1698,7 @@

    + @@ -1708,6 +1737,7 @@

    + @@ -1746,6 +1776,7 @@

    + @@ -1784,6 +1815,7 @@

    + @@ -1822,6 +1854,7 @@

    + @@ -1860,6 +1893,7 @@

    + @@ -1898,6 +1932,7 @@

    + @@ -1936,6 +1971,7 @@

    + @@ -1974,6 +2010,7 @@

    + @@ -2012,6 +2049,7 @@

    + @@ -2050,6 +2088,7 @@

    + @@ -2088,6 +2127,7 @@

    + @@ -2126,6 +2166,7 @@

    + @@ -2164,6 +2205,7 @@

    + @@ -2202,6 +2244,7 @@

    + @@ -2240,6 +2283,7 @@

    + @@ -2276,6 +2320,7 @@

    +

    Parameters
    @@ -2322,6 +2367,7 @@

    +

    Parameters
    @@ -2368,6 +2414,7 @@

    +

    Parameters
    @@ -2412,6 +2459,7 @@

    +

    Parameters
    @@ -2456,6 +2504,7 @@

    +

    Parameters
    @@ -2500,6 +2549,7 @@

    +

    Parameters
    @@ -2544,6 +2594,7 @@

    +

    Parameters
    @@ -2588,6 +2639,7 @@

    +

    Parameters
    @@ -2634,6 +2686,7 @@

    +

    Parameters
    @@ -2678,6 +2731,7 @@

    +

    Parameters
    @@ -2722,6 +2776,7 @@

    +

    Parameters
    @@ -2768,6 +2823,7 @@

    +

    Parameters
    @@ -2812,6 +2868,7 @@

    +

    Parameters
    @@ -2856,6 +2913,7 @@

    +

    Parameters
    @@ -2900,6 +2958,7 @@

    +

    Parameters
    @@ -2946,6 +3005,7 @@

    +

    Parameters
    @@ -2990,6 +3050,7 @@

    +

    Parameters
    @@ -3036,6 +3097,7 @@

    +

    Parameters
    @@ -3080,6 +3142,7 @@

    +

    Parameters
    @@ -3124,6 +3187,7 @@

    +

    Parameters
    @@ -3168,6 +3232,7 @@

    +

    Parameters
    @@ -3216,6 +3281,7 @@

    + @@ -3338,77 +3404,77 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html index db1d681b..955cad38 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html +++ b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html @@ -158,6 +158,7 @@

    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.

    @@ -223,13 +224,13 @@

    - $enabled + $enabled  : bool|null
    - $reason + $reason  : string|null
    @@ -243,42 +244,42 @@

    - __construct() + __construct()  : mixed
    SupportedTransactionCurrency constructor.
    - getEnabled() + getEnabled()  : bool|null
    Sets enabled.
    - getReason() + getReason()  : string|null
    Sets reason.
    - setEnabled() + setEnabled()  : void
    Gets enabled.
    - setReason() + setReason()  : void
    Gets reason.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -319,6 +320,7 @@

    + protected bool|null @@ -354,6 +356,7 @@

    + protected string|null @@ -404,6 +407,7 @@

    + @@ -438,6 +442,7 @@

    + @@ -476,6 +481,7 @@

    + @@ -512,6 +518,7 @@

    +

    Parameters
    @@ -558,6 +565,7 @@

    +

    Parameters
    @@ -606,6 +614,7 @@

    + @@ -728,20 +737,20 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html b/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html index ec236838..8ea594aa 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html +++ b/docs/classes/BitPaySDK-Model-Invoice-UniversalCodes.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,13 +221,13 @@

    - $paymentString + $paymentString  : string|null
    - $verificationLink + $verificationLink  : string|null
    @@ -240,41 +241,41 @@

    - __construct() + __construct()  : mixed
    - getPaymentString() + getPaymentString()  : string|null
    Gets payment string
    - getVerificationLink() + getVerificationLink()  : string|null
    Gets verification link
    - setPaymentString() + setPaymentString()  : void
    Sets payment string
    - setVerificationLink() + setVerificationLink()  : void
    Sets verification link
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -315,6 +316,7 @@

    + protected string|null @@ -350,6 +352,7 @@

    + protected string|null @@ -399,6 +402,7 @@

    + @@ -430,6 +434,7 @@

    +

    Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.

    @@ -474,6 +479,7 @@

    +

    Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.

    @@ -514,6 +520,7 @@

    +

    Payment protocol URL for selected wallet, defaults to BitPay URL if no wallet selected.

    @@ -562,6 +569,7 @@

    +

    Link to bring user to BitPay ID flow, only present when bitpayIdRequired is true.

    @@ -613,6 +621,7 @@

    + @@ -739,20 +748,20 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Ledger-Buyer.html b/docs/classes/BitPaySDK-Model-Ledger-Buyer.html index 22a71fb2..02be3880 100644 --- a/docs/classes/BitPaySDK-Model-Ledger-Buyer.html +++ b/docs/classes/BitPaySDK-Model-Ledger-Buyer.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,61 +220,61 @@

    - $buyerAddress1 + $buyerAddress1  : string|null
    - $buyerAddress2 + $buyerAddress2  : string|null
    - $buyerCity + $buyerCity  : string|null
    - $buyerCountry + $buyerCountry  : string|null
    - $buyerEmail + $buyerEmail  : string|null
    - $buyerName + $buyerName  : string|null
    - $buyerNotify + $buyerNotify  : bool|null
    - $buyerPhone + $buyerPhone  : string|null
    - $buyerState + $buyerState  : string|null
    - $buyerZip + $buyerZip  : string|null
    @@ -287,153 +288,153 @@

    - __construct() + __construct()  : mixed
    - getBuyerAddress1() + getBuyerAddress1()  : string|null
    Gets address 1
    - getBuyerAddress2() + getBuyerAddress2()  : string|null
    Gets address2
    - getBuyerCity() + getBuyerCity()  : string|null
    Gets city
    - getBuyerCountry() + getBuyerCountry()  : string|null
    Gets country
    - getBuyerEmail() + getBuyerEmail()  : string|null
    Gets email
    - getBuyerName() + getBuyerName()  : string|null
    Gets name
    - getBuyerNotify() + getBuyerNotify()  : bool|null
    Gets notify
    - getBuyerPhone() + getBuyerPhone()  : string|null
    Gets phone
    - getBuyerState() + getBuyerState()  : string|null
    Gets state
    - getBuyerZip() + getBuyerZip()  : string|null
    Gets zip
    - setBuyerAddress1() + setBuyerAddress1()  : void
    Sets address1
    - setBuyerAddress2() + setBuyerAddress2()  : void
    Sets address2
    - setBuyerCity() + setBuyerCity()  : void
    Sets city
    - setBuyerCountry() + setBuyerCountry()  : void
    Sets country
    - setBuyerEmail() + setBuyerEmail()  : void
    Sets email
    - setBuyerName() + setBuyerName()  : void
    Sets name
    - setBuyerNotify() + setBuyerNotify()  : void
    Sets notify
    - setBuyerPhone() + setBuyerPhone()  : void
    Sets phone
    - setBuyerState() + setBuyerState()  : void
    Sets state
    - setBuyerZip() + setBuyerZip()  : void
    Sets zip
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -474,6 +475,7 @@

    + protected string|null @@ -509,6 +511,7 @@

    + protected string|null @@ -544,6 +547,7 @@

    + protected string|null @@ -579,6 +583,7 @@

    + protected string|null @@ -614,6 +619,7 @@

    + protected string|null @@ -649,6 +655,7 @@

    + protected string|null @@ -684,6 +691,7 @@

    + protected bool|null @@ -719,6 +727,7 @@

    + protected string|null @@ -754,6 +763,7 @@

    + protected string|null @@ -789,6 +799,7 @@

    + protected string|null @@ -838,6 +849,7 @@

    + @@ -872,6 +884,7 @@

    + @@ -914,6 +927,7 @@

    + @@ -956,6 +970,7 @@

    + @@ -998,6 +1013,7 @@

    + @@ -1040,6 +1056,7 @@

    + @@ -1082,6 +1099,7 @@

    + @@ -1124,6 +1142,7 @@

    + @@ -1166,6 +1185,7 @@

    + @@ -1208,6 +1228,7 @@

    + @@ -1250,6 +1271,7 @@

    + @@ -1290,6 +1312,7 @@

    +

    Parameters
    @@ -1336,6 +1359,7 @@

    +

    Parameters
    @@ -1382,6 +1406,7 @@

    +

    Parameters
    @@ -1428,6 +1453,7 @@

    +

    Parameters
    @@ -1474,6 +1500,7 @@

    +

    Parameters
    @@ -1520,6 +1547,7 @@

    +

    Parameters
    @@ -1566,6 +1594,7 @@

    +

    Parameters
    @@ -1612,6 +1641,7 @@

    +

    Parameters
    @@ -1658,6 +1688,7 @@

    +

    Parameters
    @@ -1704,6 +1735,7 @@

    +

    Parameters
    @@ -1752,6 +1784,7 @@

    + @@ -1878,44 +1911,44 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Ledger-Ledger.html b/docs/classes/BitPaySDK-Model-Ledger-Ledger.html index 05b30dd4..03cda271 100644 --- a/docs/classes/BitPaySDK-Model-Ledger-Ledger.html +++ b/docs/classes/BitPaySDK-Model-Ledger-Ledger.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,13 +220,13 @@

    - $balance + $balance  : float|null
    - $currency + $currency  : string|null
    @@ -239,41 +240,41 @@

    - __construct() + __construct()  : mixed
    - getBalance() + getBalance()  : float|null
    Gets Ledger balance in the corresponding currency
    - getCurrency() + getCurrency()  : string|null
    Gets Ledger currency
    - setBalance() + setBalance()  : void
    Sets Ledger balance in the corresponding currency
    - setCurrency() + setCurrency()  : void
    Sets Ledger currency
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -314,6 +315,7 @@

    + protected float|null @@ -349,6 +351,7 @@

    + protected string|null @@ -398,6 +401,7 @@

    + @@ -432,6 +436,7 @@

    + @@ -474,6 +479,7 @@

    + @@ -514,6 +520,7 @@

    +

    Parameters
    @@ -560,6 +567,7 @@

    +

    Parameters
    @@ -608,6 +616,7 @@

    + @@ -734,20 +743,20 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html b/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html index 707aeb39..a8ec951f 100644 --- a/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html +++ b/docs/classes/BitPaySDK-Model-Ledger-LedgerEntry.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,91 +220,91 @@

    - $amount + $amount  : float|null
    - $buyerFields + $buyerFields  : Buyer
    - $code + $code  : int|null
    - $currency + $currency  : string|null
    - $description + $description  : string|null
    - $id + $id  : string|null
    - $invoiceAmount + $invoiceAmount  : float|null
    - $invoiceCurrency + $invoiceCurrency  : string|null
    - $invoiceId + $invoiceId  : string|null
    - $scale + $scale  : int|null
    - $supportRequest + $supportRequest  : string|null
    - $timestamp + $timestamp  : string|null
    - $transactionCurrency + $transactionCurrency  : string|null
    - $txType + $txType  : string|null
    - $type + $type  : string|null
    @@ -317,223 +318,223 @@

    - __construct() + __construct()  : mixed
    - getAmount() + getAmount()  : float|null
    Gets Ledger entry amount, relative to the scale.
    - getBuyerFields() + getBuyerFields()  : Buyer
    Gets buyer fields
    - getCode() + getCode()  : int|null
    Gets code
    - getCurrency() + getCurrency()  : string|null
    Gets Ledger entry currency for the corresponding amount
    - getDescription() + getDescription()  : string|null
    Gets description
    - getId() + getId()  : string|null
    Gets Ledger resource Id
    - getInvoiceAmount() + getInvoiceAmount()  : float|null
    Gets Invoice price in the invoice original currency
    - getInvoiceCurrency() + getInvoiceCurrency()  : string|null
    Gets Currency used for invoice creation
    - getInvoiceId() + getInvoiceId()  : string|null
    Gets BitPay invoice Id
    - getScale() + getScale()  : int|null
    Gets scale
    - getSupportRequest() + getSupportRequest()  : string|null
    Gets The refund requestId
    - getTimestamp() + getTimestamp()  : string|null
    Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    Gets Cryptocurrency selected by the consumer when paying an invoice.
    - getTxType() + getTxType()  : string|null
    Gets tx type
    - getType() + getType()  : string|null
    Gets type
    - setAmount() + setAmount()  : void
    Sets Ledger entry amount, relative to the scale.
    - setBuyerFields() + setBuyerFields()  : void
    Sets buyer fields
    - setCode() + setCode()  : void
    Sets code
    - setCurrency() + setCurrency()  : void
    Sets Ledger entry currency for the corresponding amount
    - setDescription() + setDescription()  : void
    Sets description
    - setId() + setId()  : void
    Sets Ledger resource Id
    - setInvoiceAmount() + setInvoiceAmount()  : void
    Sets Invoice price in the invoice original currency
    - setInvoiceCurrency() + setInvoiceCurrency()  : void
    Sets Currency used for invoice creation
    - setInvoiceId() + setInvoiceId()  : void
    Sets BitPay invoice Id
    - setScale() + setScale()  : void
    Sets scale
    - setSupportRequest() + setSupportRequest()  : void
    Sets The refund requestId
    - setTimestamp() + setTimestamp()  : void
    Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - setTransactionCurrency() + setTransactionCurrency()  : void
    Sets Cryptocurrency selected by the consumer when paying an invoice.
    - setTxType() + setTxType()  : void
    Sets tx type
    - setType() + setType()  : void
    Sets type
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -574,6 +575,7 @@

    + protected float|null @@ -609,6 +611,7 @@

    + protected Buyer @@ -644,6 +647,7 @@

    + protected int|null @@ -679,6 +683,7 @@

    + protected string|null @@ -714,6 +719,7 @@

    + protected string|null @@ -749,6 +755,7 @@

    + protected string|null @@ -784,6 +791,7 @@

    + protected float|null @@ -819,6 +827,7 @@

    + protected string|null @@ -854,6 +863,7 @@

    + protected string|null @@ -889,6 +899,7 @@

    + protected int|null @@ -924,6 +935,7 @@

    + protected string|null @@ -959,6 +971,7 @@

    + protected string|null @@ -994,6 +1007,7 @@

    + protected string|null @@ -1029,6 +1043,7 @@

    + protected string|null @@ -1064,6 +1079,7 @@

    + protected string|null @@ -1113,6 +1129,7 @@

    + @@ -1144,6 +1161,7 @@

    +

    The decimal amount can be obtained by dividing the amount field by the scale parameter.

    @@ -1184,6 +1202,7 @@

    +

    If provided by the merchant in the buyer object during invoice creation

    @@ -1224,6 +1243,7 @@

    +

    Contains the Ledger entry code. See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes

    @@ -1272,6 +1292,7 @@

    + @@ -1311,6 +1332,7 @@

    +

    Ledger entry description. Also contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)

    @@ -1359,6 +1381,7 @@

    + @@ -1401,6 +1424,7 @@

    + @@ -1443,6 +1467,7 @@

    + @@ -1485,6 +1510,7 @@

    + @@ -1524,6 +1550,7 @@

    +

    Power of 10 used for conversion

    @@ -1571,6 +1598,7 @@

    + @@ -1613,6 +1641,7 @@

    + @@ -1655,6 +1684,7 @@

    + @@ -1694,6 +1724,7 @@

    +

    [DEPRECRATED] see type

    @@ -1738,6 +1769,7 @@

    +

    Contains the Ledger entry name. See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes

    @@ -1783,6 +1815,7 @@

    +

    The decimal amount can be obtained by dividing the amount field by the scale parameter.

    @@ -1832,6 +1865,7 @@

    +

    Parameters
    @@ -1877,6 +1911,7 @@

    +

    Contains the Ledger entry code. See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes

    @@ -1927,6 +1962,7 @@

    +

    Parameters
    @@ -1972,6 +2008,7 @@

    +

    Ledger entry description. Also contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)

    @@ -2022,6 +2059,7 @@

    +

    Parameters
    @@ -2068,6 +2106,7 @@

    +

    Parameters
    @@ -2114,6 +2153,7 @@

    +

    Parameters
    @@ -2160,6 +2200,7 @@

    +

    Parameters
    @@ -2205,6 +2246,7 @@

    +

    Power of 10 used for conversion

    @@ -2254,6 +2296,7 @@

    +

    Parameters
    @@ -2300,6 +2343,7 @@

    +

    Parameters
    @@ -2346,6 +2390,7 @@

    +

    Parameters
    @@ -2391,6 +2436,7 @@

    +

    [DEPRECRATED] see type

    @@ -2439,6 +2485,7 @@

    +

    Contains the Ledger entry name. See the list of Ledger Entry Codes: https://bitpay.com/api/?php#ledger-entry-codes

    @@ -2491,6 +2538,7 @@

    + @@ -2617,59 +2665,59 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-Payout.html b/docs/classes/BitPaySDK-Model-Payout-Payout.html index 5436025d..79cfa153 100644 --- a/docs/classes/BitPaySDK-Model-Payout-Payout.html +++ b/docs/classes/BitPaySDK-Model-Payout-Payout.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,139 +220,139 @@

    - $accountId + $accountId  : string|null
    - $amount + $amount  : float|null
    - $code + $code  : int|null
    - $currency + $currency  : string|null
    - $dateExecuted + $dateExecuted  : string|null
    - $effectiveDate + $effectiveDate  : string|null
    - $email + $email  : string|null
    - $exchangeRates + $exchangeRates  : array<string|int, mixed>|null
    - $groupId + $groupId  : string|null
    - $id + $id  : string|null
    - $ignoreEmails + $ignoreEmails  : bool
    - $label + $label  : string|null
    - $ledgerCurrency + $ledgerCurrency  : string|null
    - $message + $message  : string|null
    - $notificationEmail + $notificationEmail  : string|null
    - $notificationURL + $notificationURL  : string|null
    - $recipientId + $recipientId  : string|null
    - $reference + $reference  : string|null
    - $requestDate + $requestDate  : string|null
    - $shopperId + $shopperId  : string|null
    - $status + $status  : string|null
    - $token + $token  : string|null
    - $transactions + $transactions  : array<string|int, PayoutTransaction>
    @@ -365,21 +366,21 @@

    - __construct() + __construct()  : mixed
    Constructor, create a request Payout object.
    - formatAmount() + formatAmount()  : void
    Change amount value based on precision rounding.
    - getAccountId() + getAccountId()  : string
    @@ -387,161 +388,161 @@

    assigned by BitPay for a given account during the onboarding process.
    - getAmount() + getAmount()  : float|null
    Gets amount of cryptocurrency sent to the requested address.
    - getCode() + getCode()  : int|null
    This field will be returned in case of error and contain an error code.
    - getCurrency() + getCurrency()  : string|null
    Gets currency code set for the batch amount (ISO 4217 3-character currency code).
    - getDateExecuted() + getDateExecuted()  : string|null
    Gets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
    - getEffectiveDate() + getEffectiveDate()  : string|null
    Gets Ledger currency code (ISO 4217 3-character currency code)
    - getEmail() + getEmail()  : string
    Gets email.
    - getExchangeRates() + getExchangeRates()  : array<string|int, mixed>|null
    Gets exchange rates keyed by source and target currencies.
    - getGroupId() + getGroupId()  : string|null
    Gets group id.
    - getId() + getId()  : string|null
    Gets Payout request id.
    - getLabel() + getLabel()  : string
    Gets label.
    - getLedgerCurrency() + getLedgerCurrency()  : string|null
    Gets Ledger currency code (ISO 4217 3-character currency code
    - getMessage() + getMessage()  : string
    Gets message.
    - getNotificationEmail() + getNotificationEmail()  : string
    Gets notification email.
    - getNotificationURL() + getNotificationURL()  : string
    Gets notification url.
    - getRecipientId() + getRecipientId()  : string
    Gets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
    - getReference() + getReference()  : string
    Gets reference.
    - getRequestDate() + getRequestDate()  : string|null
    Gets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
    - getShopperId() + getShopperId()  : string
    Gets shopper id.
    - getStatus() + getStatus()  : string|null
    Gets payout request status.
    - getToken() + getToken()  : string
    Gets resource token.
    - getTransactions() + getTransactions()  : array<string|int, PayoutTransaction>
    Gets transactions. Contains the cryptocurrency transaction details for the executed payout request.
    - isIgnoreEmails() + isIgnoreEmails()  : bool
    Gets boolean to prevent email updates on a specific payout.
    - setAccountId() + setAccountId()  : void
    @@ -549,161 +550,161 @@

    assigned by BitPay for a given account during the onboarding process.
    - setAmount() + setAmount()  : void
    Sets amount of cryptocurrency sent to the requested address.
    - setCode() + setCode()  : void
    Sets error code.
    - setCurrency() + setCurrency()  : void
    Sets currency code set for the batch amount (ISO 4217 3-character currency code).
    - setDateExecuted() + setDateExecuted()  : void
    Sets date and time (UTC) when BitPay executed the payout. ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
    - setEffectiveDate() + setEffectiveDate()  : void
    Sets effective date and time (UTC) for the payout.
    - setEmail() + setEmail()  : void
    Sets email.
    - setExchangeRates() + setExchangeRates()  : void
    Sets exchange rates keyed by source and target currencies.
    - setGroupId() + setGroupId()  : void
    Sets group id.
    - setId() + setId()  : void
    Sets Payout request id.
    - setIgnoreEmails() + setIgnoreEmails()  : void
    Sets boolean to prevent email updates on a specific payout.
    - setLabel() + setLabel()  : void
    Sets label.
    - setLedgerCurrency() + setLedgerCurrency()  : void
    Sets Ledger currency code (ISO 4217 3-character currency code)
    - setMessage() + setMessage()  : void
    Sets message.
    - setNotificationEmail() + setNotificationEmail()  : void
    Sets notification email.
    - setNotificationURL() + setNotificationURL()  : void
    Sets notification url.
    - setRecipientId() + setRecipientId()  : void
    Sets BitPay recipient id. Assigned by BitPay for a given recipient email during the onboarding process.
    - setReference() + setReference()  : void
    Sets reference.
    - setRequestDate() + setRequestDate()  : void
    Sets date and time (UTC) when BitPay received the batch. ISO-8601 format `yyyy-mm-ddThh:mm:ssZ`.
    - setShopperId() + setShopperId()  : void
    Sets shopper id.
    - setStatus() + setStatus()  : void
    Sets payout request status.
    - setToken() + setToken()  : void
    Sets resource token.
    - setTransactions() + setTransactions()  : void
    Sets transactions. Contains the cryptocurrency transaction details for the executed payout request.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -744,6 +745,7 @@

    + protected string|null @@ -779,6 +781,7 @@

    + protected float|null @@ -814,6 +817,7 @@

    + protected int|null @@ -849,6 +853,7 @@

    + protected string|null @@ -884,6 +889,7 @@

    + protected string|null @@ -919,6 +925,7 @@

    + protected string|null @@ -954,6 +961,7 @@

    + protected string|null @@ -989,6 +997,7 @@

    + protected array<string|int, mixed>|null @@ -1024,6 +1033,7 @@

    + protected string|null @@ -1059,6 +1069,7 @@

    + protected string|null @@ -1094,6 +1105,7 @@

    + protected bool @@ -1129,6 +1141,7 @@

    + protected string|null @@ -1164,6 +1177,7 @@

    + protected string|null @@ -1199,6 +1213,7 @@

    + protected string|null @@ -1234,6 +1249,7 @@

    + protected string|null @@ -1269,6 +1285,7 @@

    + protected string|null @@ -1304,6 +1321,7 @@

    + protected string|null @@ -1339,6 +1357,7 @@

    + protected string|null @@ -1374,6 +1393,7 @@

    + protected string|null @@ -1409,6 +1429,7 @@

    + protected string|null @@ -1444,6 +1465,7 @@

    + protected string|null @@ -1479,6 +1501,7 @@

    + protected string|null @@ -1514,6 +1537,7 @@

    + protected array<string|int, PayoutTransaction> @@ -1562,6 +1586,7 @@

    +

    Parameters
    @@ -1630,6 +1655,7 @@

    +

    Parameters
    @@ -1677,6 +1703,7 @@

    + @@ -1715,6 +1742,7 @@

    + @@ -1753,6 +1781,7 @@

    + @@ -1791,6 +1820,7 @@

    + @@ -1829,6 +1859,7 @@

    + @@ -1864,6 +1895,7 @@

    +

    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.

    @@ -1923,6 +1955,7 @@

    +

    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.

    @@ -1968,6 +2001,7 @@

    + @@ -2006,6 +2040,7 @@

    + @@ -2044,6 +2079,7 @@

    + @@ -2079,6 +2115,7 @@

    +

    For merchant use, pass through - can be the customer name or unique merchant reference assigned by the merchant to the recipient.

    @@ -2120,6 +2157,7 @@

    +

    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.

    @@ -2179,6 +2217,7 @@

    +

    In case of error, this field will contain a description message. Set to null if the request is successful.

    @@ -2219,6 +2258,7 @@

    +

    Merchant email address for notification of payout status change.

    @@ -2259,6 +2299,7 @@

    +

    URL to which BitPay sends webhook notifications. HTTPS is mandatory.

    @@ -2302,6 +2343,7 @@

    + @@ -2337,6 +2379,7 @@

    +

    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.

    @@ -2382,6 +2425,7 @@

    + @@ -2417,6 +2461,7 @@

    +

    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. @@ -2462,6 +2507,7 @@

    +

    The possible values are:

    diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html b/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html index d6bbbb9c..deb46191 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutGroupFailed.html @@ -158,6 +158,7 @@

    +

    Tags @@ -209,19 +210,19 @@

    - $errMessage + $errMessage  : string
    - $payee + $payee  : string|null
    - $payoutId + $payoutId  : string|null
    @@ -235,37 +236,37 @@

    - getErrorMessage() + getErrorMessage()  : string
    - getPayee() + getPayee()  : string|null
    - getPayoutId() + getPayoutId()  : string|null
    - setErrorMessage() + setErrorMessage()  : void
    - setPayee() + setPayee()  : void
    - setPayoutId() + setPayoutId()  : void
    @@ -305,6 +306,7 @@

    + private string @@ -340,6 +342,7 @@

    + private string|null @@ -375,6 +378,7 @@

    + private string|null @@ -424,6 +428,7 @@

    + @@ -461,6 +466,7 @@

    + @@ -498,6 +504,7 @@

    + @@ -533,6 +540,7 @@

    +

    Parameters
    @@ -576,6 +584,7 @@

    +

    Parameters
    @@ -619,6 +628,7 @@

    +

    Parameters
    @@ -749,21 +759,21 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html index 5ae4b022..372692f9 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipient.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,49 +220,49 @@

    - $email + $email  : string|null
    - $guid + $guid  : string|null
    - $id + $id  : string|null
    - $label + $label  : string|null
    - $notificationURL + $notificationURL  : string|null
    - $shopperId + $shopperId  : string|null
    - $status + $status  : string|null
    - $token + $token  : string|null
    @@ -275,126 +276,126 @@

    - __construct() + __construct()  : mixed
    Constructor, create a minimal Recipient object.
    - getEmail() + getEmail()  : string|null
    Gets email.
    - getGuid() + getGuid()  : string|null
    Gets guid.
    - getId() + getId()  : string|null
    Gets id.
    - getLabel() + getLabel()  : string|null
    Gets label.
    - getNotificationURL() + getNotificationURL()  : string|null
    Gets notification url.
    - getShopperId() + getShopperId()  : string|null
    Gets Shopper ID.
    - getStatus() + getStatus()  : string|null
    Gets status.
    - getToken() + getToken()  : string|null
    Gets token.
    - setEmail() + setEmail()  : void
    Sets email.
    - setGuid() + setGuid()  : void
    Sets guid.
    - setId() + setId()  : void
    Sets id.
    - setLabel() + setLabel()  : void
    Sets label.
    - setNotificationURL() + setNotificationURL()  : void
    Sets notification url.
    - setShopperId() + setShopperId()  : void
    Sets Shopper ID.
    - setStatus() + setStatus()  : void
    Sets status.
    - setToken() + setToken()  : void
    Sets token.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -435,6 +436,7 @@

    + protected string|null @@ -470,6 +472,7 @@

    + protected string|null @@ -505,6 +508,7 @@

    + protected string|null @@ -540,6 +544,7 @@

    + protected string|null @@ -575,6 +580,7 @@

    + protected string|null @@ -610,6 +616,7 @@

    + protected string|null @@ -645,6 +652,7 @@

    + protected string|null @@ -680,6 +688,7 @@

    + protected string|null @@ -728,6 +737,7 @@

    +

    Parameters
    @@ -795,6 +805,7 @@

    + @@ -833,6 +844,7 @@

    + @@ -871,6 +883,7 @@

    + @@ -909,6 +922,7 @@

    + @@ -947,6 +961,7 @@

    + @@ -985,6 +1000,7 @@

    + @@ -1023,6 +1039,7 @@

    + @@ -1061,6 +1078,7 @@

    + @@ -1097,6 +1115,7 @@

    +

    Parameters
    @@ -1141,6 +1160,7 @@

    +

    Parameters
    @@ -1185,6 +1205,7 @@

    +

    Parameters
    @@ -1229,6 +1250,7 @@

    +

    Parameters
    @@ -1273,6 +1295,7 @@

    +

    Parameters
    @@ -1317,6 +1340,7 @@

    +

    Parameters
    @@ -1361,6 +1385,7 @@

    +

    Parameters
    @@ -1405,6 +1430,7 @@

    +

    Parameters
    @@ -1451,6 +1477,7 @@

    + @@ -1573,38 +1600,38 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html index 897f9906..d1fbee22 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,19 +220,19 @@

    - $guid + $guid  : string|null
    - $recipients + $recipients  : array<string|int, mixed>
    - $token + $token  : string|null
    @@ -245,56 +246,56 @@

    - __construct() + __construct()  : mixed
    Constructor, create an recipient-full request PayoutBatch object.
    - getGuid() + getGuid()  : string|null
    Gets guid.
    - getRecipients() + getRecipients()  : array<string|int, PayoutRecipient>
    Gets an array with all recipients.
    - getToken() + getToken()  : string|null
    Gets token.
    - setGuid() + setGuid()  : void
    Sets guid.
    - setRecipients() + setRecipients()  : void
    Sets array with all recipients.
    - setToken() + setToken()  : void
    Sets token.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -335,6 +336,7 @@

    + protected string|null @@ -370,6 +372,7 @@

    + protected array<string|int, mixed> @@ -405,6 +408,7 @@

    + protected string|null @@ -453,6 +457,7 @@

    +

    Parameters
    @@ -501,6 +506,7 @@

    + @@ -539,6 +545,7 @@

    + @@ -577,6 +584,7 @@

    + @@ -613,6 +621,7 @@

    +

    Parameters
    @@ -657,6 +666,7 @@

    +

    Parameters
    @@ -716,6 +726,7 @@

    +

    Parameters
    @@ -762,6 +773,7 @@

    + @@ -884,23 +896,23 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html index d39f29ea..cc2ba62a 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,56 +210,56 @@

    - CANCELLED + CANCELLED  = 'cancelled'
    Cancelled status.
    - COMPLETE + COMPLETE  = 'complete'
    Complete status
    - FAILED + FAILED  = 'failed'
    Failed status.
    - FUNDED + FUNDED  = 'funded'
    Funded status.
    - NEW + NEW  = 'new'
    New status.
    - PAID + PAID  = 'paid'
    Paid status.
    - PROCESSING + PROCESSING  = 'processing'
    Processing status
    - UNPAID + UNPAID  = 'unpaid'
    @@ -295,6 +296,7 @@

    Cancelled status.

    + public mixed @@ -326,6 +328,7 @@

    Complete status

    + public mixed @@ -357,6 +360,7 @@

    Failed status.

    + public mixed @@ -388,6 +392,7 @@

    Funded status.

    + public mixed @@ -419,6 +424,7 @@

    New status.

    + public mixed @@ -450,6 +456,7 @@

    Paid status.

    + public mixed @@ -481,6 +488,7 @@

    Processing status

    + public mixed @@ -512,6 +520,7 @@

    Unpaid status.

    + public mixed @@ -641,14 +650,14 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html b/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html index 062a863c..5a8561dc 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutTransaction.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,25 +221,25 @@

    - $amount + $amount  : float|null
    - $confirmations + $confirmations  : int|null
    - $date + $date  : string|null
    - $txid + $txid  : string|null
    @@ -252,69 +253,69 @@

    - __construct() + __construct()  : mixed
    - getAmount() + getAmount()  : float|null
    Gets Amount of cryptocurrency sent to the requested address.
    - getConfirmations() + getConfirmations()  : int|null
    Gets the number of confirmations the transaction has received.
    - getDate() + getDate()  : string|null
    Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
    - getTxid() + getTxid()  : string|null
    Gets Cryptocurrency transaction hash for the executed payout.
    - setAmount() + setAmount()  : void
    Sets Amount of cryptocurrency sent to the requested address.
    - setConfirmations() + setConfirmations()  : void
    Sets the number of confirmations the transaction has received.
    - setDate() + setDate()  : void
    Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
    - setTxid() + setTxid()  : void
    Sets Cryptocurrency transaction hash for the executed payout.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -355,6 +356,7 @@

    + protected float|null @@ -390,6 +392,7 @@

    + protected int|null @@ -425,6 +428,7 @@

    + protected string|null @@ -460,6 +464,7 @@

    + protected string|null @@ -509,6 +514,7 @@

    + @@ -543,6 +549,7 @@

    + @@ -585,6 +592,7 @@

    + @@ -620,6 +628,7 @@

    +

    ISO-8601 format yyyy-mm-ddThh:mm:ssZ.

    @@ -667,6 +676,7 @@

    + @@ -707,6 +717,7 @@

    +

    Parameters
    @@ -753,6 +764,7 @@

    +

    Parameters
    @@ -796,6 +808,7 @@

    +

    ISO-8601 format yyyy-mm-ddThh:mm:ssZ.

    @@ -845,6 +858,7 @@

    +

    Parameters
    @@ -893,6 +907,7 @@

    + @@ -1019,26 +1034,26 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutWebhook.html b/docs/classes/BitPaySDK-Model-Payout-PayoutWebhook.html index 62c65365..17c7c6bc 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutWebhook.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutWebhook.html @@ -161,6 +161,7 @@

    +

    Table of Contents @@ -182,115 +183,115 @@

    - $accountId + $accountId  : string|null
    - $currency + $currency  : string|null
    - $dateExecuted + $dateExecuted  : string|null
    - $effectiveDate + $effectiveDate  : string|null
    - $email + $email  : string|null
    - $exchangeRates + $exchangeRates  : array<string|int, mixed>|null
    - $groupId + $groupId  : string|null
    - $id + $id  : string|null
    - $label + $label  : string|null
    - $ledgerCurrency + $ledgerCurrency  : string|null
    - $notificationEmail + $notificationEmail  : string|null
    - $notificationURL + $notificationURL  : string|null
    - $price + $price  : float|null
    - $recipientId + $recipientId  : string|null
    - $reference + $reference  : string|null
    - $requestDate + $requestDate  : string|null
    - $shopperId + $shopperId  : string|null
    - $status + $status  : string|null
    - $transactions + $transactions  : array<string|int, mixed>|null
    @@ -304,229 +305,229 @@

    - getAccountId() + getAccountId()  : string|null
    - getCurrency() + getCurrency()  : string|null
    - getDateExecuted() + getDateExecuted()  : string|null
    - getEffectiveDate() + getEffectiveDate()  : string|null
    - getEmail() + getEmail()  : string|null
    - getExchangeRates() + getExchangeRates()  : array<string|int, mixed>|null
    - getGroupId() + getGroupId()  : string|null
    - getId() + getId()  : string|null
    - getLabel() + getLabel()  : string|null
    - getLedgerCurrency() + getLedgerCurrency()  : string|null
    - getNotificationEmail() + getNotificationEmail()  : string|null
    - getNotificationURL() + getNotificationURL()  : string|null
    - getPrice() + getPrice()  : float|null
    - getRecipientId() + getRecipientId()  : string|null
    - getReference() + getReference()  : string|null
    - getRequestDate() + getRequestDate()  : string|null
    - getShopperId() + getShopperId()  : string|null
    - getStatus() + getStatus()  : string|null
    - getTransactions() + getTransactions()  : array<string|int, mixed>|null
    - setAccountId() + setAccountId()  : void
    - setCurrency() + setCurrency()  : void
    - setDateExecuted() + setDateExecuted()  : void
    - setEffectiveDate() + setEffectiveDate()  : void
    - setEmail() + setEmail()  : void
    - setExchangeRates() + setExchangeRates()  : void
    - setGroupId() + setGroupId()  : void
    - setId() + setId()  : void
    - setLabel() + setLabel()  : void
    - setLedgerCurrency() + setLedgerCurrency()  : void
    - setNotificationEmail() + setNotificationEmail()  : void
    - setNotificationURL() + setNotificationURL()  : void
    - setPrice() + setPrice()  : void
    - setRecipientId() + setRecipientId()  : void
    - setReference() + setReference()  : void
    - setRequestDate() + setRequestDate()  : void
    - setShopperId() + setShopperId()  : void
    - setStatus() + setStatus()  : void
    - setTransactions() + setTransactions()  : void
    @@ -566,6 +567,7 @@

    + protected string|null @@ -601,6 +603,7 @@

    + protected string|null @@ -636,6 +639,7 @@

    + protected string|null @@ -671,6 +675,7 @@

    + protected string|null @@ -706,6 +711,7 @@

    + protected string|null @@ -741,6 +747,7 @@

    + protected array<string|int, mixed>|null @@ -776,6 +783,7 @@

    + protected string|null @@ -811,6 +819,7 @@

    + protected string|null @@ -846,6 +855,7 @@

    + protected string|null @@ -881,6 +891,7 @@

    + protected string|null @@ -916,6 +927,7 @@

    + protected string|null @@ -951,6 +963,7 @@

    + protected string|null @@ -986,6 +999,7 @@

    + protected float|null @@ -1021,6 +1035,7 @@

    + protected string|null @@ -1056,6 +1071,7 @@

    + protected string|null @@ -1091,6 +1107,7 @@

    + protected string|null @@ -1126,6 +1143,7 @@

    + protected string|null @@ -1161,6 +1179,7 @@

    + protected string|null @@ -1196,6 +1215,7 @@

    + protected array<string|int, mixed>|null @@ -1245,6 +1265,7 @@

    + @@ -1282,6 +1303,7 @@

    + @@ -1319,6 +1341,7 @@

    + @@ -1356,6 +1379,7 @@

    + @@ -1393,6 +1417,7 @@

    + @@ -1430,6 +1455,7 @@

    + @@ -1467,6 +1493,7 @@

    + @@ -1504,6 +1531,7 @@

    + @@ -1541,6 +1569,7 @@

    + @@ -1578,6 +1607,7 @@

    + @@ -1615,6 +1645,7 @@

    + @@ -1652,6 +1683,7 @@

    + @@ -1689,6 +1721,7 @@

    + @@ -1726,6 +1759,7 @@

    + @@ -1763,6 +1797,7 @@

    + @@ -1800,6 +1835,7 @@

    + @@ -1837,6 +1873,7 @@

    + @@ -1874,6 +1911,7 @@

    + @@ -1911,6 +1949,7 @@

    + @@ -1946,6 +1985,7 @@

    +

    Parameters
    @@ -1989,6 +2029,7 @@

    +

    Parameters
    @@ -2032,6 +2073,7 @@

    +

    Parameters
    @@ -2075,6 +2117,7 @@

    +

    Parameters
    @@ -2118,6 +2161,7 @@

    +

    Parameters
    @@ -2161,6 +2205,7 @@

    +

    Parameters
    @@ -2204,6 +2249,7 @@

    +

    Parameters
    @@ -2247,6 +2293,7 @@

    +

    Parameters
    @@ -2290,6 +2337,7 @@

    +

    Parameters
    @@ -2333,6 +2381,7 @@

    +

    Parameters
    @@ -2376,6 +2425,7 @@

    +

    Parameters
    @@ -2419,6 +2469,7 @@

    +

    Parameters
    @@ -2462,6 +2513,7 @@

    +

    Parameters
    @@ -2505,6 +2557,7 @@

    +

    Parameters
    @@ -2548,6 +2601,7 @@

    +

    Parameters
    @@ -2591,6 +2645,7 @@

    +

    Parameters
    @@ -2634,6 +2689,7 @@

    +

    Parameters
    @@ -2677,6 +2733,7 @@

    +

    Parameters
    @@ -2720,6 +2777,7 @@

    +

    Parameters
    @@ -2850,69 +2908,69 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html b/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html index 3f0c1476..7f806ce4 100644 --- a/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html +++ b/docs/classes/BitPaySDK-Model-Payout-RecipientReferenceMethod.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,21 +210,21 @@

    - EMAIL + EMAIL  = 1
    Email method will be used to target the recipient
    - RECIPIENT_ID + RECIPIENT_ID  = 2
    Recipient id will be used to target the recipient
    - SHOPPER_ID + SHOPPER_ID  = 3
    @@ -260,6 +261,7 @@

    Email method will be used to target the recipient

    + public mixed @@ -291,6 +293,7 @@

    Recipient id will be used to target the recipient

    + public mixed @@ -322,6 +325,7 @@

    Shopper id will be used to target the recipient

    + public mixed @@ -451,9 +455,9 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html b/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html index 79dce4a9..3a7f0980 100644 --- a/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html +++ b/docs/classes/BitPaySDK-Model-Payout-RecipientStatus.html @@ -150,6 +150,7 @@

    +

    Tags @@ -209,42 +210,42 @@

    - ACTIVE + ACTIVE  = 'active'
    Active recipient status.
    - INVITED + INVITED  = 'invited'
    Invited recipient status.
    - PAUSED + PAUSED  = 'paused'
    Paused recipient status.
    - REMOVED + REMOVED  = 'removed'
    Removed recipient status.
    - UNVERIFIED + UNVERIFIED  = 'unverified'
    Unverified recipient status.
    - VERIFIED + VERIFIED  = 'verified'
    @@ -281,6 +282,7 @@

    Active recipient status.

    + public mixed @@ -312,6 +314,7 @@

    Invited recipient status.

    + public mixed @@ -343,6 +346,7 @@

    Paused recipient status.

    + public mixed @@ -374,6 +378,7 @@

    Removed recipient status.

    + public mixed @@ -405,6 +410,7 @@

    Unverified recipient status.

    + public mixed @@ -436,6 +442,7 @@

    Verified recipient status.

    + public mixed @@ -565,12 +572,12 @@

  • Constants
    • diff --git a/docs/classes/BitPaySDK-Model-Payout-RecipientWebhook.html b/docs/classes/BitPaySDK-Model-Payout-RecipientWebhook.html index d2181ebe..e25d9c4b 100644 --- a/docs/classes/BitPaySDK-Model-Payout-RecipientWebhook.html +++ b/docs/classes/BitPaySDK-Model-Payout-RecipientWebhook.html @@ -161,6 +161,7 @@

    +

    Table of Contents @@ -182,31 +183,31 @@

    - $email + $email  : string|null
    - $id + $id  : string|null
    - $label + $label  : string|null
    - $shopperId + $shopperId  : string|null
    - $status + $status  : string|null
    @@ -220,61 +221,61 @@

    - getEmail() + getEmail()  : string|null
    - getId() + getId()  : string|null
    - getLabel() + getLabel()  : string|null
    - getShopperId() + getShopperId()  : string|null
    - getStatus() + getStatus()  : string|null
    - setEmail() + setEmail()  : void
    - setId() + setId()  : void
    - setLabel() + setLabel()  : void
    - setShopperId() + setShopperId()  : void
    - setStatus() + setStatus()  : void
    @@ -314,6 +315,7 @@

    + protected string|null @@ -349,6 +351,7 @@

    + protected string|null @@ -384,6 +387,7 @@

    + protected string|null @@ -419,6 +423,7 @@

    + protected string|null @@ -454,6 +459,7 @@

    + protected string|null @@ -503,6 +509,7 @@

    + @@ -540,6 +547,7 @@

    + @@ -577,6 +585,7 @@

    + @@ -614,6 +623,7 @@

    + @@ -651,6 +661,7 @@

    + @@ -690,6 +701,7 @@

    +

    Parameters
    @@ -733,6 +745,7 @@

    +

    Parameters
    @@ -776,6 +789,7 @@

    +

    Parameters
    @@ -819,6 +833,7 @@

    +

    Parameters
    @@ -862,6 +877,7 @@

    +

    Parameters
    @@ -994,27 +1010,27 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Rate-Rate.html b/docs/classes/BitPaySDK-Model-Rate-Rate.html index 841fab34..945452d0 100644 --- a/docs/classes/BitPaySDK-Model-Rate-Rate.html +++ b/docs/classes/BitPaySDK-Model-Rate-Rate.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,19 +220,19 @@

    - $code + $code  : string|null
    - $name + $name  : string|null
    - $rate + $rate  : float|null
    @@ -245,55 +246,55 @@

    - __construct() + __construct()  : mixed
    - getCode() + getCode()  : string|null
    Gets ISO 4217 3-character currency code
    - getName() + getName()  : string|null
    Gets detailed currency name
    - getRate() + getRate()  : float|null
    Gets rate for the requested baseCurrency /currency pair
    - setCode() + setCode()  : void
    Sets ISO 4217 3-character currency code
    - setName() + setName()  : void
    Sets detailed currency name
    - setRate() + setRate()  : void
    Sets rate for the requested baseCurrency /currency pair
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -334,6 +335,7 @@

    + protected string|null @@ -369,6 +371,7 @@

    + protected string|null @@ -404,6 +407,7 @@

    + protected float|null @@ -453,6 +457,7 @@

    + @@ -487,6 +492,7 @@

    + @@ -529,6 +535,7 @@

    + @@ -571,6 +578,7 @@

    + @@ -611,6 +619,7 @@

    +

    Parameters
    @@ -657,6 +666,7 @@

    +

    Parameters
    @@ -703,6 +713,7 @@

    +

    Parameters
    @@ -751,6 +762,7 @@

    + @@ -877,23 +889,23 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Rate-Rates.html b/docs/classes/BitPaySDK-Model-Rate-Rates.html index 4b0600a7..0b96a263 100644 --- a/docs/classes/BitPaySDK-Model-Rate-Rates.html +++ b/docs/classes/BitPaySDK-Model-Rate-Rates.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,7 +220,7 @@

    - $rates + $rates  : array<string|int, mixed>
    @@ -233,42 +234,42 @@

    - __construct() + __construct()  : mixed
    Rates constructor.
    - getRate() + getRate()  : float|null
    Gets rate for the requested currency code.
    - getRates() + getRates()  : array<string|int, mixed>
    Gets rates.
    - toArray() + toArray()  : array<string|int, array<string|int, mixed>>
    Return an array with rates value.
    - update() + update()  : void
    Update rates.
    - validateRates() + validateRates()  : void
    @@ -308,6 +309,7 @@

    + protected array<string|int, mixed> @@ -358,6 +360,7 @@

    +

    Parameters
    @@ -419,6 +422,7 @@

    +

    Parameters
    @@ -486,6 +490,7 @@

    + @@ -528,6 +533,7 @@

    + @@ -564,6 +570,7 @@

    +

    Parameters
    @@ -630,6 +637,7 @@

    +

    Parameters
    @@ -775,19 +783,19 @@
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html b/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html index 3c298d72..8d26b867 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html +++ b/docs/classes/BitPaySDK-Model-Settlement-InvoiceData.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,49 +221,49 @@

    - $currency + $currency  : string|null
    - $date + $date  : string|null
    - $orderId + $orderId  : string|null
    - $overPaidAmount + $overPaidAmount  : float|null
    - $payoutPercentage + $payoutPercentage  : array<string|int, mixed>|null
    - $price + $price  : float|null
    - $refundInfo + $refundInfo  : RefundInfo|null
    - $transactionCurrency + $transactionCurrency  : string|null
    @@ -276,125 +277,125 @@

    - __construct() + __construct()  : mixed
    - getCurrency() + getCurrency()  : string|null
    Gets Invoice currency
    - getDate() + getDate()  : string|null
    Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - getOrderId() + getOrderId()  : string|null
    Gets Invoice orderId provided during invoice creation.
    - getOverPaidAmount() + getOverPaidAmount()  : float|null
    Gets over paid amount
    - getPayoutPercentage() + getPayoutPercentage()  : array<string|int, mixed>|null
    Gets The payout percentage defined by the merchant on his BitPay account settings
    - getPrice() + getPrice()  : float|null
    Gets Invoice price in the invoice original currency
    - getRefundInfo() + getRefundInfo()  : RefundInfo|null
    Gets Object containing information about the refund executed for the invoice
    - getTransactionCurrency() + getTransactionCurrency()  : string|null
    Gets Cryptocurrency selected by the consumer when paying the invoice.
    - setCurrency() + setCurrency()  : void
    Sets Invoice currency
    - setDate() + setDate()  : void
    Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - setOrderId() + setOrderId()  : void
    Sets Invoice orderId provided during invoice creation.
    - setOverPaidAmount() + setOverPaidAmount()  : void
    Sets over paid amount
    - setPayoutPercentage() + setPayoutPercentage()  : void
    Sets The payout percentage defined by the merchant on his BitPay account settings
    - setPrice() + setPrice()  : void
    Sets Invoice price in the invoice original currency
    - setRefundInfo() + setRefundInfo()  : void
    Sets Object containing information about the refund executed for the invoice
    - setTransactionCurrency() + setTransactionCurrency()  : void
    Sets Cryptocurrency selected by the consumer when paying the invoice.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -435,6 +436,7 @@

    + protected string|null @@ -470,6 +472,7 @@

    + protected string|null @@ -505,6 +508,7 @@

    + protected string|null @@ -540,6 +544,7 @@

    + protected float|null @@ -575,6 +580,7 @@

    + protected array<string|int, mixed>|null @@ -610,6 +616,7 @@

    + protected float|null @@ -645,6 +652,7 @@

    + protected RefundInfo|null @@ -680,6 +688,7 @@

    + protected string|null @@ -729,6 +738,7 @@

    + @@ -763,6 +773,7 @@

    + @@ -805,6 +816,7 @@

    + @@ -847,6 +859,7 @@

    + @@ -889,6 +902,7 @@

    + @@ -931,6 +945,7 @@

    + @@ -973,6 +988,7 @@

    + @@ -1015,6 +1031,7 @@

    + @@ -1053,6 +1070,7 @@

    + @@ -1093,6 +1111,7 @@

    +

    Parameters
    @@ -1139,6 +1158,7 @@

    +

    Parameters
    @@ -1185,6 +1205,7 @@

    +

    Parameters
    @@ -1231,6 +1252,7 @@

    +

    Parameters
    @@ -1277,6 +1299,7 @@

    +

    Parameters
    @@ -1323,6 +1346,7 @@

    +

    Parameters
    @@ -1369,6 +1393,7 @@

    +

    Parameters
    @@ -1413,6 +1438,7 @@

    +

    Parameters
    @@ -1461,6 +1487,7 @@

    + @@ -1587,38 +1614,38 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html b/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html index d0ed4c9d..3f5cae3f 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html +++ b/docs/classes/BitPaySDK-Model-Settlement-PayoutInfo.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,145 +221,145 @@

    - $account + $account  : string|null
    - $accountHolderAddress + $accountHolderAddress  : string|null
    - $accountHolderAddress2 + $accountHolderAddress2  : string|null
    - $accountHolderCity + $accountHolderCity  : string|null
    - $accountHolderCountry + $accountHolderCountry  : string|null
    - $accountHolderName + $accountHolderName  : string|null
    - $accountHolderPostalCode + $accountHolderPostalCode  : string|null
    - $additionalInformation + $additionalInformation  : string|null
    - $address + $address  : string|null
    - $bank + $bank  : string|null
    - $bankAddress + $bankAddress  : string|null
    - $bankAddress2 + $bankAddress2  : string|null
    - $bankCountry + $bankCountry  : string|null
    - $bankName + $bankName  : string|null
    - $city + $city  : string|null
    - $iban + $iban  : string|null
    - $label + $label  : string|null
    - $merchantEin + $merchantEin  : string|null
    - $name + $name  : string|null
    - $postal + $postal  : string|null
    - $routing + $routing  : string|null
    - $sort + $sort  : string|null
    - $swift + $swift  : string|null
    - $wire + $wire  : bool|null
    @@ -372,349 +373,349 @@

    - __construct() + __construct()  : mixed
    - getAccount() + getAccount()  : string|null
    Gets Bank account number of the merchant
    - getAccountHolderAddress() + getAccountHolderAddress()  : string|null
    Gets Bank account holder address
    - getAccountHolderAddress2() + getAccountHolderAddress2()  : string|null
    Gets Bank account holder address2
    - getAccountHolderCity() + getAccountHolderCity()  : string|null
    Gets Bank account holder city
    - getAccountHolderCountry() + getAccountHolderCountry()  : string|null
    Gets Bank account holder country
    - getAccountHolderName() + getAccountHolderName()  : string|null
    Gets Bank account holder name
    - getAccountHolderPostalCode() + getAccountHolderPostalCode()  : string|null
    Gets Bank account holder postal code
    - getAdditionalInformation() + getAdditionalInformation()  : string|null
    Gets additional information
    - getAddress() + getAddress()  : string|null
    Gets address
    - getBank() + getBank()  : string|null
    Gets Name of the bank used by the merchant
    - getBankAddress() + getBankAddress()  : string|null
    Gets bank address
    - getBankAddress2() + getBankAddress2()  : string|null
    Gets bank address 2
    - getBankCountry() + getBankCountry()  : string|null
    Gets Country where the merchant's bank account is located
    - getBankName() + getBankName()  : string|null
    Gets bank name
    - getCity() + getCity()  : string|null
    Gets City of the merchant bank, field return if the settlement currency is
    - getIban() + getIban()  : string|null
    Gets iban
    - getLabel() + getLabel()  : string|null
    Gets label
    - getMerchantEin() + getMerchantEin()  : string|null
    Gets merchant ein
    - getName() + getName()  : string|null
    Gets account holder name
    - getPostal() + getPostal()  : string|null
    Gets Postal code of the merchant bank, field return if the settlement currency is
    - getRouting() + getRouting()  : string|null
    Gets routing
    - getSort() + getSort()  : string|null
    Gets sort
    - getSwift() + getSwift()  : string|null
    Gets SWIFT/BIC code of the merchant's bank.
    - getWire() + getWire()  : bool|null
    Gets wire
    - setAccount() + setAccount()  : void
    Sets Bank account number of the merchant
    - setAccountHolderAddress() + setAccountHolderAddress()  : void
    Sets Bank account holder address2
    - setAccountHolderAddress2() + setAccountHolderAddress2()  : void
    Sets Bank account holder address2
    - setAccountHolderCity() + setAccountHolderCity()  : void
    Sets Bank account holder city
    - setAccountHolderCountry() + setAccountHolderCountry()  : void
    Sets Bank account holder country
    - setAccountHolderName() + setAccountHolderName()  : void
    Sets Bank account holder name
    - setAccountHolderPostalCode() + setAccountHolderPostalCode()  : void
    Sets Bank account holder postal code
    - setAdditionalInformation() + setAdditionalInformation()  : void
    Sets additional information
    - setAddress() + setAddress()  : void
    Sets address
    - setBank() + setBank()  : void
    Sets Name of the bank used by the merchant
    - setBankAddress() + setBankAddress()  : void
    Sets bank address
    - setBankAddress2() + setBankAddress2()  : void
    Sets bank address2
    - setBankCountry() + setBankCountry()  : void
    Sets Country where the merchant's bank account is located
    - setBankName() + setBankName()  : void
    Sets bank name
    - setCity() + setCity()  : void
    Sets city of the merchant bank
    - setIban() + setIban()  : void
    Sets iban
    - setLabel() + setLabel()  : void
    Sets label
    - setMerchantEin() + setMerchantEin()  : void
    Sets merchant ein
    - setName() + setName()  : void
    Sets account holder name
    - setPostal() + setPostal()  : void
    Sets Postal code of the merchant bank
    - setRouting() + setRouting()  : void
    Sets routing
    - setSort() + setSort()  : void
    Sets sort
    - setSwift() + setSwift()  : void
    Sets SWIFT/BIC code of the merchant's bank.
    - setWire() + setWire()  : void
    Sets wire
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -755,6 +756,7 @@

    + protected string|null @@ -790,6 +792,7 @@

    + protected string|null @@ -825,6 +828,7 @@

    + protected string|null @@ -860,6 +864,7 @@

    + protected string|null @@ -895,6 +900,7 @@

    + protected string|null @@ -930,6 +936,7 @@

    + protected string|null @@ -965,6 +972,7 @@

    + protected string|null @@ -1000,6 +1008,7 @@

    + protected string|null @@ -1035,6 +1044,7 @@

    + protected string|null @@ -1070,6 +1080,7 @@

    + protected string|null @@ -1105,6 +1116,7 @@

    + protected string|null @@ -1140,6 +1152,7 @@

    + protected string|null @@ -1175,6 +1188,7 @@

    + protected string|null @@ -1210,6 +1224,7 @@

    + protected string|null @@ -1245,6 +1260,7 @@

    + protected string|null @@ -1280,6 +1296,7 @@

    + protected string|null @@ -1315,6 +1332,7 @@

    + protected string|null @@ -1350,6 +1368,7 @@

    + protected string|null @@ -1385,6 +1404,7 @@

    + protected string|null @@ -1420,6 +1440,7 @@

    + protected string|null @@ -1455,6 +1476,7 @@

    + protected string|null @@ -1490,6 +1512,7 @@

    + protected string|null @@ -1525,6 +1548,7 @@

    + protected string|null @@ -1560,6 +1584,7 @@

    + protected bool|null @@ -1609,6 +1634,7 @@

    + @@ -1643,6 +1669,7 @@

    + @@ -1685,6 +1712,7 @@

    + @@ -1727,6 +1755,7 @@

    + @@ -1769,6 +1798,7 @@

    + @@ -1811,6 +1841,7 @@

    + @@ -1853,6 +1884,7 @@

    + @@ -1895,6 +1927,7 @@

    + @@ -1934,6 +1967,7 @@

    +

    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

    @@ -1979,6 +2013,7 @@

    +

    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), @@ -2031,6 +2066,7 @@

    + @@ -2070,6 +2106,7 @@

    +

    Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object

    @@ -2114,6 +2151,7 @@

    +

    Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object

    @@ -2161,6 +2199,7 @@

    + @@ -2200,6 +2239,7 @@

    +

    Name of the bank used by the merchant. Field returned if "wire": true in the "payoutInfo" object

    @@ -2247,6 +2287,7 @@

    + @@ -2286,6 +2327,7 @@

    +

    The merchant's bank account number, in the IBAN (International Bank Account Number) format. Field returned if "wire": true in the "payoutInfo" object

    @@ -2331,6 +2373,7 @@

    +

    As indicated by the merchant in his settlement settings

    @@ -2375,6 +2418,7 @@

    +

    for merchants receiving USD settlements via local ACH, this field contains the merchant's EIN

    @@ -2422,6 +2466,7 @@

    + @@ -2464,6 +2509,7 @@

    + @@ -2503,6 +2549,7 @@

    +

    for merchants receiving USD settlements via local ACH, this field contains the ABA provided by the merchant

    @@ -2547,6 +2594,7 @@

    +

    used to pass country specific bank fields: BSB for AUD

    @@ -2590,6 +2638,7 @@

    + @@ -2629,6 +2678,7 @@

    +

    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)

    @@ -2675,6 +2725,7 @@

    +

    Parameters
    @@ -2721,6 +2772,7 @@

    +

    Parameters
    @@ -2767,6 +2819,7 @@

    +

    Parameters
    @@ -2813,6 +2866,7 @@

    +

    Parameters
    @@ -2859,6 +2913,7 @@

    +

    Parameters
    @@ -2905,6 +2960,7 @@

    +

    Parameters
    @@ -2951,6 +3007,7 @@

    +

    Parameters
    @@ -2997,6 +3054,7 @@

    +

    Parameters
    @@ -3043,6 +3101,7 @@

    +

    Parameters
    @@ -3089,6 +3148,7 @@

    +

    Parameters
    @@ -3135,6 +3195,7 @@

    +

    Parameters
    @@ -3181,6 +3242,7 @@

    +

    Parameters
    @@ -3227,6 +3289,7 @@

    +

    Parameters
    @@ -3273,6 +3336,7 @@

    +

    Parameters
    @@ -3319,6 +3383,7 @@

    +

    Parameters
    @@ -3365,6 +3430,7 @@

    +

    Parameters
    @@ -3411,6 +3477,7 @@

    +

    Parameters
    @@ -3457,6 +3524,7 @@

    +

    Parameters
    @@ -3503,6 +3571,7 @@

    +

    Parameters
    @@ -3549,6 +3618,7 @@

    +

    Parameters
    @@ -3595,6 +3665,7 @@

    +

    Parameters
    @@ -3641,6 +3712,7 @@

    +

    Parameters
    @@ -3687,6 +3759,7 @@

    +

    Parameters
    @@ -3733,6 +3806,7 @@

    +

    Parameters
    @@ -3781,6 +3855,7 @@

    + @@ -3907,86 +3982,86 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html b/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html index 1f0a8c93..a1e87cc6 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html +++ b/docs/classes/BitPaySDK-Model-Settlement-RefundInfo.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,25 +221,25 @@

    - $amounts + $amounts  : array<string|int, mixed>|null
    - $currency + $currency  : string|null
    - $refundRequestEid + $refundRequestEid  : string|null
    - $supportRequest + $supportRequest  : string|null
    @@ -252,69 +253,69 @@

    - __construct() + __construct()  : mixed
    - getAmounts() + getAmounts()  : array<string|int, mixed>|null
    Gets amounts.
    - getCurrency() + getCurrency()  : string|null
    Gets currency.
    - getRefundRequestEid() + getRefundRequestEid()  : string
    Gets Refund Request Eid.
    - getSupportRequest() + getSupportRequest()  : string|null
    Gets support request.
    - setAmounts() + setAmounts()  : void
    Sets amounts.
    - setCurrency() + setCurrency()  : void
    Sets currency.
    - setRefundRequestEid() + setRefundRequestEid()  : void
    Sets Refund Request Eid.
    - setSupportRequest() + setSupportRequest()  : void
    Sets support request.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -355,6 +356,7 @@

    + protected array<string|int, mixed>|null @@ -390,6 +392,7 @@

    + protected string|null @@ -425,6 +428,7 @@

    + protected string|null @@ -460,6 +464,7 @@

    + protected string|null @@ -509,6 +514,7 @@

    + @@ -540,6 +546,7 @@

    +

    This object will contain the crypto currency amount refunded by BitPay to the consumer

    @@ -580,6 +587,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the settlement. Supported settlement currencies are listed on Settlement Docs

    @@ -624,6 +632,7 @@

    + @@ -663,6 +672,7 @@

    +

    BitPay support request ID associated to the refund

    @@ -708,6 +718,7 @@

    +

    Parameters
    @@ -751,6 +762,7 @@

    +

    ISO 4217 3-character currency code. This is the currency associated with the settlement. Supported settlement currencies are listed on Settlement Docs

    @@ -801,6 +813,7 @@

    +

    Parameters
    @@ -844,6 +857,7 @@

    +

    BitPay support request ID associated to the refund

    @@ -895,6 +909,7 @@

    + @@ -1021,26 +1036,26 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-Settlement.html b/docs/classes/BitPaySDK-Model-Settlement-Settlement.html index d0bef299..9edd9f7d 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-Settlement.html +++ b/docs/classes/BitPaySDK-Model-Settlement-Settlement.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,103 +221,103 @@

    - $accountId + $accountId  : string|null
    - $closingDate + $closingDate  : string|null
    - $currency + $currency  : string|null
    - $dateCompleted + $dateCompleted  : string|null
    - $dateCreated + $dateCreated  : string|null
    - $dateExecuted + $dateExecuted  : string|null
    - $id + $id  : string|null
    - $ledgerEntries + $ledgerEntries  : array<string|int, mixed>
    - $ledgerEntriesSum + $ledgerEntriesSum  : float|null
    - $openingBalance + $openingBalance  : float|null
    - $openingDate + $openingDate  : string|null
    - $payoutInfo + $payoutInfo  : PayoutInfo|null
    - $status + $status  : string|null
    - $token + $token  : string|null
    - $totalAmount + $totalAmount  : float|null
    - $withHoldings + $withHoldings  : array<string|int, mixed>
    - $withHoldingsSum + $withHoldingsSum  : float|null
    @@ -330,251 +331,251 @@

    - __construct() + __construct()  : mixed
    - getAccountId() + getAccountId()  : string|null
    Gets account id
    - getClosingDate() + getClosingDate()  : string|null
    Gets closing date.
    - getCurrency() + getCurrency()  : string|null
    Gets currency
    - getDateCompleted() + getDateCompleted()  : string|null
    Gets date completed
    - getDateCreated() + getDateCreated()  : string|null
    Gets date created
    - getDateExecuted() + getDateExecuted()  : string|null
    Gets date executed
    - getId() + getId()  : string|null
    Gets id
    - getLedgerEntries() + getLedgerEntries()  : array<string|int, SettlementLedgerEntry>
    Gets Array of ledger entries listing the various debits and credits which are settled in the report.
    - getLedgerEntriesSum() + getLedgerEntriesSum()  : float|null
    Gets ledger entries sum.
    - getOpeningBalance() + getOpeningBalance()  : float|null
    Gets Balance of the ledger at the openingDate
    - getOpeningDate() + getOpeningDate()  : string|null
    Gets opening date
    - getPayoutInfo() + getPayoutInfo()  : PayoutInfo|null
    Gets Object containing the settlement info provided by the Merchant in his BitPay account settings
    - getStatus() + getStatus()  : string|null
    Gets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
    - getToken() + getToken()  : string|null
    Gets API token for the corresponding settlement resource.
    - getTotalAmount() + getTotalAmount()  : float|null
    Gets total amount sent to the merchant; 2 decimals.
    - getWithHoldings() + getWithHoldings()  : array<string|int, WithHoldings>
    Gets with holdings
    - getWithHoldingsSum() + getWithHoldingsSum()  : float|null
    Gets Sum of all amounts that are withheld from settlement
    - setAccountId() + setAccountId()  : void
    Sets account id
    - setClosingDate() + setClosingDate()  : void
    Sets closing date.
    - setCurrency() + setCurrency()  : void
    Sets currency
    - setDateCompleted() + setDateCompleted()  : void
    Sets date completed
    - setDateCreated() + setDateCreated()  : void
    Sets date created
    - setDateExecuted() + setDateExecuted()  : void
    Sets date executed
    - setId() + setId()  : void
    Sets id
    - setLedgerEntries() + setLedgerEntries()  : void
    Sets Array of ledger entries listing the various debits and credits which are settled in the report.
    - setLedgerEntriesSum() + setLedgerEntriesSum()  : void
    Sets ledger entries sum.
    - setOpeningBalance() + setOpeningBalance()  : void
    Sets Balance of the ledger at the openingDate
    - setOpeningDate() + setOpeningDate()  : void
    Sets opening date
    - setPayoutInfo() + setPayoutInfo()  : void
    Sets Object containing the settlement info provided by the Merchant in his BitPay account settings
    - setStatus() + setStatus()  : void
    Sets Status of the settlement. Possible statuses are "new", "processing", "rejected" and "completed".
    - setToken() + setToken()  : void
    Sets API token for the corresponding settlement resource.
    - setTotalAmount() + setTotalAmount()  : void
    Sets total amount sent to the merchant; 2 decimals.
    - setWithHoldings() + setWithHoldings()  : void
    Sets with holdings
    - setWithHoldingsSum() + setWithHoldingsSum()  : void
    Sets Sum of all amounts that are withheld from settlement
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -615,6 +616,7 @@

    + protected string|null @@ -650,6 +652,7 @@

    + protected string|null @@ -685,6 +688,7 @@

    + protected string|null @@ -720,6 +724,7 @@

    + protected string|null @@ -755,6 +760,7 @@

    + protected string|null @@ -790,6 +796,7 @@

    + protected string|null @@ -825,6 +832,7 @@

    + protected string|null @@ -860,6 +868,7 @@

    + protected array<string|int, mixed> @@ -895,6 +904,7 @@

    + protected float|null @@ -930,6 +940,7 @@

    + protected float|null @@ -965,6 +976,7 @@

    + protected string|null @@ -1000,6 +1012,7 @@

    + protected PayoutInfo|null @@ -1035,6 +1048,7 @@

    + protected string|null @@ -1070,6 +1084,7 @@

    + protected string|null @@ -1105,6 +1120,7 @@

    + protected float|null @@ -1140,6 +1156,7 @@

    + protected array<string|int, mixed> @@ -1175,6 +1192,7 @@

    + protected float|null @@ -1224,6 +1242,7 @@

    + @@ -1255,6 +1274,7 @@

    +

    String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.

    @@ -1295,6 +1315,7 @@

    +

    Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -1335,6 +1356,7 @@

    +

    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

    @@ -1376,6 +1398,7 @@

    +

    Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -1416,6 +1439,7 @@

    +

    Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -1456,6 +1480,7 @@

    +

    Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -1496,6 +1521,7 @@

    +

    String identifying the settlement; this id will also be in the description of the corresponding bank settlement.

    @@ -1536,6 +1562,7 @@

    +

    The total sum of all ledger entries is reported in the field ledgerEntriesSum. A description of all ledger codes can be found

    @@ -1577,6 +1604,7 @@

    +

    Sum of all ledger entries in the settlement, this means all the debits & credits which happened between openingDate and closingDate

    @@ -1621,6 +1649,7 @@

    + @@ -1656,6 +1685,7 @@

    +

    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

    @@ -1701,6 +1731,7 @@

    + @@ -1739,6 +1770,7 @@

    + @@ -1774,6 +1806,7 @@

    +

    This token is actually derived from the merchant facade token used during the query. This token is required to fetch the reconciliation report

    @@ -1815,6 +1848,7 @@

    +

    totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum

    @@ -1855,6 +1889,7 @@

    +

    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.

    @@ -1899,6 +1934,7 @@

    + @@ -1934,6 +1970,7 @@

    +

    String identifying the BitPay merchant. For internal use, this field can be ignored in merchant implementations.

    @@ -1980,6 +2017,7 @@

    +

    Date & time for last ledger entry used for the settlement. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -2026,6 +2064,7 @@

    +

    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

    @@ -2073,6 +2112,7 @@

    +

    Timestamp when the settlement was completed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -2119,6 +2159,7 @@

    +

    Timestamp when the settlement was created. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -2165,6 +2206,7 @@

    +

    Timestamp when the settlement was executed. UTC date, ISO-8601 format yyyy-mm-ddThh:mm:ssZ

    @@ -2211,6 +2253,7 @@

    +

    String identifying the settlement; this id will also be in the description of the corresponding bank settlement.

    @@ -2257,6 +2300,7 @@

    +

    The total sum of all ledger entries is reported in the field ledgerEntriesSum. A description of all ledger codes can be found

    @@ -2319,6 +2363,7 @@

    +

    Sum of all ledger entries in the settlement, this means all the debits & credits which happened between openingDate and closingDate

    @@ -2367,6 +2412,7 @@

    +

    Parameters
    @@ -2410,6 +2456,7 @@

    +

    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

    @@ -2459,6 +2506,7 @@

    +

    Parameters
    @@ -2503,6 +2551,7 @@

    +

    Parameters
    @@ -2546,6 +2595,7 @@

    +

    This token is actually derived from the merchant facade token used during the query. This token is required to fetch the reconciliation report

    @@ -2593,6 +2643,7 @@

    +

    totalAmount = openingBalance + ledgerEntriesSum - withholdingsSum

    @@ -2639,6 +2690,7 @@

    +

    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.

    @@ -2702,6 +2754,7 @@

    +

    Parameters
    @@ -2748,6 +2801,7 @@

    + @@ -2870,65 +2924,65 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html b/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html index ac41cc69..1a6d48a9 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html +++ b/docs/classes/BitPaySDK-Model-Settlement-SettlementLedgerEntry.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,43 +220,43 @@

    - $amount + $amount  : float|null
    - $code + $code  : int|null
    - $description + $description  : string|null
    - $invoiceData + $invoiceData  : InvoiceData
    - $invoiceId + $invoiceId  : string|null
    - $reference + $reference  : string|null
    - $timestamp + $timestamp  : string|null
    @@ -269,111 +270,111 @@

    - __construct() + __construct()  : mixed
    - getAmount() + getAmount()  : float|null
    Gets amount
    - getCode() + getCode()  : int|null
    Gets code
    - getDescription() + getDescription()  : string|null
    Gets Ledger entry description.
    - getInvoiceData() + getInvoiceData()  : InvoiceData
    Gets Invoice Data
    - getInvoiceId() + getInvoiceId()  : string|null
    Gets BitPay invoice Id
    - getReference() + getReference()  : string|null
    Gets reference
    - getTimestamp() + getTimestamp()  : string|null
    Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - setAmount() + setAmount()  : void
    Sets amount
    - setCode() + setCode()  : void
    Sets code
    - setDescription() + setDescription()  : void
    Sets Ledger entry description.
    - setInvoiceData() + setInvoiceData()  : void
    Sets Invoice Data
    - setInvoiceId() + setInvoiceId()  : void
    Sets BitPay invoice Id
    - setReference() + setReference()  : void
    Sets reference
    - setTimestamp() + setTimestamp()  : void
    Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -414,6 +415,7 @@

    + protected float|null @@ -449,6 +451,7 @@

    + protected int|null @@ -484,6 +487,7 @@

    + protected string|null @@ -519,6 +523,7 @@

    + protected InvoiceData @@ -554,6 +559,7 @@

    + protected string|null @@ -589,6 +595,7 @@

    + protected string|null @@ -624,6 +631,7 @@

    + protected string|null @@ -673,6 +681,7 @@

    + @@ -704,6 +713,7 @@

    +

    Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)

    @@ -748,6 +758,7 @@

    +

    Contains the Ledger entry code

    @@ -792,6 +803,7 @@

    +

    This field often contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)

    @@ -837,6 +849,7 @@

    +

    Object containing relevant information from the paid invoice

    @@ -880,6 +893,7 @@

    + @@ -922,6 +936,7 @@

    + @@ -964,6 +979,7 @@

    + @@ -1003,6 +1019,7 @@

    +

    Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)

    @@ -1051,6 +1068,7 @@

    +

    Contains the Ledger entry code

    @@ -1099,6 +1117,7 @@

    +

    This field often contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)

    @@ -1148,6 +1167,7 @@

    +

    Object containing relevant information from the paid invoice

    @@ -1197,6 +1217,7 @@

    +

    Parameters
    @@ -1243,6 +1264,7 @@

    +

    Parameters
    @@ -1289,6 +1311,7 @@

    +

    Parameters
    @@ -1337,6 +1360,7 @@

    + @@ -1463,35 +1487,35 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html b/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html index 8b5b7c6f..ffcaaad3 100644 --- a/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html +++ b/docs/classes/BitPaySDK-Model-Settlement-WithHoldings.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,37 +220,37 @@

    - $amount + $amount  : float|null
    - $bankCountry + $bankCountry  : string|null
    - $code + $code  : string|null
    - $description + $description  : string|null
    - $label + $label  : string|null
    - $notes + $notes  : string|null
    @@ -263,98 +264,98 @@

    - __construct() + __construct()  : mixed
    WithHoldings constructor.
    - getAmount() + getAmount()  : float|null
    Gets amount.
    - getBankCountry() + getBankCountry()  : string|null
    Gets bank country.
    - getCode() + getCode()  : string|null
    Gets code.
    - getDescription() + getDescription()  : string|null
    Gets description.
    - getLabel() + getLabel()  : string|null
    Gets label.
    - getNotes() + getNotes()  : string|null
    Gets notes.
    - setAmount() + setAmount()  : void
    Sets amount.
    - setBankCountry() + setBankCountry()  : void
    Sets bank country.
    - setCode() + setCode()  : void
    Sets code.
    - setDescription() + setDescription()  : void
    Sets description.
    - setLabel() + setLabel()  : void
    Sets label.
    - setNotes() + setNotes()  : void
    Sets notes.
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -395,6 +396,7 @@

    + protected float|null @@ -430,6 +432,7 @@

    + protected string|null @@ -465,6 +468,7 @@

    + protected string|null @@ -500,6 +504,7 @@

    + protected string|null @@ -535,6 +540,7 @@

    + protected string|null @@ -570,6 +576,7 @@

    + protected string|null @@ -620,6 +627,7 @@

    + @@ -654,6 +662,7 @@

    + @@ -692,6 +701,7 @@

    + @@ -730,6 +740,7 @@

    + @@ -768,6 +779,7 @@

    + @@ -806,6 +818,7 @@

    + @@ -844,6 +857,7 @@

    + @@ -880,6 +894,7 @@

    +

    Parameters
    @@ -926,6 +941,7 @@

    +

    Parameters
    @@ -972,6 +988,7 @@

    +

    Parameters
    @@ -1018,6 +1035,7 @@

    +

    Parameters
    @@ -1064,6 +1082,7 @@

    +

    Parameters
    @@ -1110,6 +1129,7 @@

    +

    Parameters
    @@ -1158,6 +1178,7 @@

    + @@ -1280,32 +1301,32 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Wallet-Currencies.html b/docs/classes/BitPaySDK-Model-Wallet-Currencies.html index dd972757..7b458390 100644 --- a/docs/classes/BitPaySDK-Model-Wallet-Currencies.html +++ b/docs/classes/BitPaySDK-Model-Wallet-Currencies.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,49 +221,49 @@

    - $code + $code  : string|null
    - $dappBrowser + $dappBrowser  : bool|null
    - $image + $image  : string|null
    - $p2p + $p2p  : bool|null
    - $payPro + $payPro  : bool|null
    - $qr + $qr  : CurrencyQr|null
    - $walletConnect + $walletConnect  : bool|null
    - $withdrawalFee + $withdrawalFee  : string|null
    @@ -276,125 +277,125 @@

    - __construct() + __construct()  : mixed
    - getCode() + getCode()  : string|null
    Gets code
    - getDappBrowser() + getDappBrowser()  : bool|null
    Gets Dapp Browser
    - getImage() + getImage()  : string|null
    Gets URL that displays currency image
    - getP2p() + getP2p()  : bool|null
    Gets p2p
    - getPayPro() + getPayPro()  : bool|null
    Gets pay pro
    - getQr() + getQr()  : CurrencyQr|null
    Gets CurrencyQr
    - getWalletConnect() + getWalletConnect()  : bool|null
    Gets wallet connect
    - getWithdrawalFee() + getWithdrawalFee()  : string|null
    Gets Custodial wallet withdrawal fee
    - setCode() + setCode()  : void
    Sets code
    - setDappBrowser() + setDappBrowser()  : void
    Sets Dapp Browser
    - setImage() + setImage()  : void
    Sets URL that displays currency image
    - setP2p() + setP2p()  : void
    Sets p2p
    - setPayPro() + setPayPro()  : void
    Sets pay pro
    - setQr() + setQr()  : void
    Sets CurrencyQr
    - setWalletConnect() + setWalletConnect()  : void
    Sets wallet connect
    - setWithdrawalFee() + setWithdrawalFee()  : void
    Sets Custodial wallet withdrawal fee
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -435,6 +436,7 @@

    + protected string|null @@ -470,6 +472,7 @@

    + protected bool|null @@ -505,6 +508,7 @@

    + protected string|null @@ -540,6 +544,7 @@

    + protected bool|null @@ -575,6 +580,7 @@

    + protected bool|null @@ -610,6 +616,7 @@

    + protected CurrencyQr|null @@ -645,6 +652,7 @@

    + protected bool|null @@ -680,6 +688,7 @@

    + protected string|null @@ -729,6 +738,7 @@

    + @@ -760,6 +770,7 @@

    +

    Identifying code for the currency

    @@ -804,6 +815,7 @@

    +

    Indicates that this payment method operates via a browser plugin interacting with the invoice

    @@ -851,6 +863,7 @@

    + @@ -890,6 +903,7 @@

    +

    Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)

    @@ -934,6 +948,7 @@

    +

    Whether or not BitPay Payment Protocol is supported on this particular currency option

    @@ -978,6 +993,7 @@

    +

    Object containing QR code related information to show for this payment method

    @@ -1022,6 +1038,7 @@

    +

    Whether or not this wallet supports walletConnect

    @@ -1069,6 +1086,7 @@

    + @@ -1108,6 +1126,7 @@

    +

    Identifying code for the currency

    @@ -1156,6 +1175,7 @@

    +

    Indicates that this payment method operates via a browser plugin interacting with the invoice

    @@ -1205,6 +1225,7 @@

    +

    Parameters
    @@ -1250,6 +1271,7 @@

    +

    Indicates that this is a peer to peer (p2p) payment method (as opposed to payment protocol)

    @@ -1298,6 +1320,7 @@

    +

    Whether or not BitPay Payment Protocol is supported on this particular currency option

    @@ -1346,6 +1369,7 @@

    +

    Object containing QR code related information to show for this payment method

    @@ -1394,6 +1418,7 @@

    +

    Whether or not this wallet supports walletConnect

    @@ -1443,6 +1468,7 @@

    +

    Parameters
    @@ -1491,6 +1517,7 @@

    + @@ -1617,38 +1644,38 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html b/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html index 73ca0d80..691f105a 100644 --- a/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html +++ b/docs/classes/BitPaySDK-Model-Wallet-CurrencyQr.html @@ -159,6 +159,7 @@

    +

    Tags @@ -220,13 +221,13 @@

    - $collapsed + $collapsed  : bool|null
    - $type + $type  : string|null
    @@ -240,41 +241,41 @@

    - __construct() + __construct()  : mixed
    - getCollapsed() + getCollapsed()  : bool|null
    Gets collapsed
    - getType() + getType()  : string|null
    Gets Type
    - setCollapsed() + setCollapsed()  : void
    Sets collapsed
    - setType() + setType()  : void
    Sets Type
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -315,6 +316,7 @@

    + protected bool|null @@ -350,6 +352,7 @@

    + protected string|null @@ -399,6 +402,7 @@

    + @@ -430,6 +434,7 @@

    +

    UI hint for BitPay invoice, generally not relevant to customer integrations

    @@ -474,6 +479,7 @@

    +

    The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)

    @@ -518,6 +524,7 @@

    +

    UI hint for BitPay invoice, generally not relevant to customer integrations

    @@ -566,6 +573,7 @@

    +

    The type of QR code to use (ex. BIP21, ADDRESS, BIP72b, BIP681, BIP681b, etc)

    @@ -617,6 +625,7 @@

    + @@ -743,20 +752,20 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Wallet-Wallet.html b/docs/classes/BitPaySDK-Model-Wallet-Wallet.html index 6e24fd0c..e5592f60 100644 --- a/docs/classes/BitPaySDK-Model-Wallet-Wallet.html +++ b/docs/classes/BitPaySDK-Model-Wallet-Wallet.html @@ -158,6 +158,7 @@

    +

    Tags @@ -219,55 +220,55 @@

    - $avatar + $avatar  : string|null
    - $currencies + $currencies  : Currencies
    - $displayName + $displayName  : string|null
    - $image + $image  : string|null
    - $invoiceDefault + $invoiceDefault  : string|null
    - $key + $key  : string|null
    - $offChainMode + $offChainMode  : bool|null
    - $payPro + $payPro  : bool|null
    - $uniCode + $uniCode  : string|null
    @@ -281,134 +282,134 @@

    - __construct() + __construct()  : mixed
    Constructor, create a minimal request Wallet object.
    - getAvatar() + getAvatar()  : string|null
    Gets avatar
    - getCurrencies() + getCurrencies()  : Currencies
    Gets currencies
    - getDisplayName() + getDisplayName()  : string|null
    Gets display name
    - getImage() + getImage()  : string|null
    Gets image
    - getInvoiceDefault() + getInvoiceDefault()  : string|null
    - getKey() + getKey()  : string|null
    Gets A unique identifier for the wallet
    - getOffChainMode() + getOffChainMode()  : bool|null
    - getPayPro() + getPayPro()  : bool|null
    Gets pay pro
    - getUniCode() + getUniCode()  : string|null
    - setAvatar() + setAvatar()  : void
    Sets avatar
    - setCurrencies() + setCurrencies()  : void
    Sets currencies
    - setDisplayName() + setDisplayName()  : void
    Sets display name
    - setImage() + setImage()  : void
    Sets image
    - setInvoiceDefault() + setInvoiceDefault()  : void
    - setKey() + setKey()  : void
    Sets A unique identifier for the wallet
    - setOffChainMode() + setOffChainMode()  : void
    - setPayPro() + setPayPro()  : void
    Sets pay pro
    - setUniCode() + setUniCode()  : void
    - toArray() + toArray()  : array<string|int, mixed>
    @@ -449,6 +450,7 @@

    + protected string|null @@ -484,6 +486,7 @@

    + protected Currencies @@ -519,6 +522,7 @@

    + protected string|null @@ -554,6 +558,7 @@

    + protected string|null @@ -589,6 +594,7 @@

    + protected string|null @@ -624,6 +630,7 @@

    + protected string|null @@ -659,6 +666,7 @@

    + protected bool|null @@ -694,6 +702,7 @@

    + protected bool|null @@ -729,6 +738,7 @@

    + protected string|null @@ -779,6 +789,7 @@

    + @@ -810,6 +821,7 @@

    +

    Filename of a wallet graphic (not fully qualified)

    @@ -854,6 +866,7 @@

    +

    Details of what currencies support payments for this wallet

    @@ -898,6 +911,7 @@

    +

    Human readable display name for the wallet

    @@ -942,6 +956,7 @@

    +

    URL that displays wallet avatar image

    @@ -988,6 +1003,7 @@

    + @@ -1026,6 +1042,7 @@

    + @@ -1067,6 +1084,7 @@

    + @@ -1102,6 +1120,7 @@

    +

    Whether or not the wallet supports ANY BitPay Payment Protocol options

    @@ -1148,6 +1167,7 @@

    + @@ -1183,6 +1203,7 @@

    +

    Filename of a wallet graphic (not fully qualified)

    @@ -1231,6 +1252,7 @@

    +

    Details of what currencies support payments for this wallet

    @@ -1279,6 +1301,7 @@

    +

    Human readable display name for the wallet

    @@ -1327,6 +1350,7 @@

    +

    URL that displays wallet avatar image

    @@ -1375,6 +1399,7 @@

    +

    Parameters
    @@ -1419,6 +1444,7 @@

    +

    Parameters
    @@ -1464,6 +1490,7 @@

    +

    Parameters
    @@ -1507,6 +1534,7 @@

    +

    Whether or not the wallet supports ANY BitPay Payment Protocol options

    @@ -1555,6 +1583,7 @@

    +

    Parameters
    @@ -1601,6 +1630,7 @@

    + @@ -1727,41 +1757,41 @@

    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-PosClient.html b/docs/classes/BitPaySDK-PosClient.html index f10e7f13..0bb57158 100644 --- a/docs/classes/BitPaySDK-PosClient.html +++ b/docs/classes/BitPaySDK-PosClient.html @@ -158,6 +158,7 @@

    +

    Tags @@ -209,31 +210,31 @@

    - $env + $env  : string
    - $restCli + $restCli  : RESTcli
    - $RESTcli + $RESTcli  : RESTcli
    - $token + $token  : Tokens
    - $tokenCache + $tokenCache  : Tokens
    @@ -247,145 +248,145 @@

    - __construct() + __construct()  : mixed
    Constructor for the BitPay SDK to use with the POS facade.
    - cancelInvoice() + cancelInvoice()  : Invoice
    Cancel a BitPay invoice.
    - cancelInvoiceByGuid() + cancelInvoiceByGuid()  : Invoice
    Cancel a BitPay invoice.
    - cancelPayout() + cancelPayout()  : bool
    Cancel a BitPay Payout.
    - cancelPayoutGroup() + cancelPayoutGroup()  : PayoutGroup
    - cancelRefund() + cancelRefund()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - cancelRefundByGuid() + cancelRefundByGuid()  : Refund
    Cancel a previously submitted refund request on a BitPay invoice.
    - createBill() + createBill()  : Bill
    Create a BitPay Bill.
    - createInvoice() + createInvoice()  : Invoice
    Create a BitPay invoice.
    - createPayoutGroup() + createPayoutGroup()  : PayoutGroup
    - createRefund() + createRefund()  : Refund
    Create a refund for a BitPay invoice.
    - createWithData() + createWithData()  : Client
    Constructor for use if the keys and SIN are managed by this library.
    - createWithFile() + createWithFile()  : Client
    Constructor for use if the keys and SIN are managed by this library.
    - deletePayoutRecipient() + deletePayoutRecipient()  : bool
    Delete a Payout Recipient.
    - deliverBill() + deliverBill()  : bool
    Deliver a BitPay Bill.
    - getBill() + getBill()  : Bill
    Retrieve a BitPay bill by bill id using the specified facade.
    - getBills() + getBills()  : array<string|int, Bill>
    Retrieve a collection of BitPay bills.
    - getCurrencies() + getCurrencies()  : array<string|int, mixed>
    Fetch the supported currencies.
    - getCurrencyPairRate() + getCurrencyPairRate()  : Rate
    Retrieve the rate for a cryptocurrency / fiat pair
    - getCurrencyRates() + getCurrencyRates()  : Rates
    Retrieve all the rates for a given cryptocurrency
    - getInvoice() + getInvoice()  : Invoice
    @@ -393,35 +394,35 @@

    authorized for the specified facade (the public facade requires no authorization).
    - getInvoiceByGuid() + getInvoiceByGuid()  : Invoice
    Retrieve a BitPay invoice by guid using the specified facade.
    - getInvoices() + getInvoices()  : array<string|int, Invoice>
    Retrieve a collection of BitPay invoices.
    - getLedgerEntries() + getLedgerEntries()  : array<string|int, LedgerEntry>
    Retrieve a list of ledgers by date range using the merchant facade.
    - getLedgers() + getLedgers()  : array<string|int, Ledger>
    Retrieve a list of ledgers using the merchant facade.
    - getPayout() + getPayout()  : Payout
    @@ -429,7 +430,7 @@

    for the payout facade.
    - getPayoutRecipient() + getPayoutRecipient()  : PayoutRecipient
    @@ -437,251 +438,251 @@

    payout facade.
    - getPayoutRecipients() + getPayoutRecipients()  : array<string|int, PayoutRecipient>
    Retrieve a collection of BitPay Payout Recipients.
    - getPayouts() + getPayouts()  : array<string|int, Payout>
    Retrieve a collection of BitPay payouts.
    - getRates() + getRates()  : Rates
    Retrieve the exchange rate table maintained by BitPay.
    - getRefund() + getRefund()  : Refund
    Retrieve a previously made refund request on a BitPay invoice.
    - getRefundByGuid() + getRefundByGuid()  : Refund
    Retrieve a previously made refund request on a BitPay invoice.
    - getRefunds() + getRefunds()  : array<string|int, Refund>
    Retrieve all refund requests on a BitPay invoice.
    - getSettlement() + getSettlement()  : Settlement
    Retrieves a summary of the specified settlement.
    - getSettlementReconciliationReport() + getSettlementReconciliationReport()  : Settlement
    Gets a detailed reconciliation report of the activity within the settlement period.
    - getSettlements() + getSettlements()  : array<string|int, Settlement>
    Retrieves settlement reports for the calling merchant filtered by query.
    - getSupportedWallets() + getSupportedWallets()  : array<string|int, Wallet>
    Retrieve all supported wallets.
    - getTokens() + getTokens()  : array<string|int, mixed>
    Get Tokens.
    - payInvoice() + payInvoice()  : Invoice
    Pay an invoice with a mock transaction
    - requestInvoiceNotification() + requestInvoiceNotification()  : bool
    Request a BitPay Invoice Webhook.
    - requestPayoutNotification() + requestPayoutNotification()  : bool
    Notify BitPay Payout.
    - requestPayoutRecipientNotification() + requestPayoutRecipientNotification()  : bool
    Notify BitPay Payout Recipient.
    - sendRefundNotification() + sendRefundNotification()  : bool
    Send a refund notification.
    - submitPayout() + submitPayout()  : Payout
    Submit a BitPay Payout.
    - submitPayoutRecipients() + submitPayoutRecipients()  : array<string|int, PayoutRecipient>
    Submit BitPay Payout Recipients.
    - updateBill() + updateBill()  : Bill
    Update a BitPay Bill.
    - updateInvoice() + updateInvoice()  : Invoice
    Update a BitPay invoice.
    - updatePayoutRecipient() + updatePayoutRecipient()  : PayoutRecipient
    Update a Payout Recipient.
    - updateRefund() + updateRefund()  : Refund
    Update the status of a BitPay invoice.
    - updateRefundByGuid() + updateRefundByGuid()  : Refund
    Update the status of a BitPay invoice.
    - getBillClient() + getBillClient()  : BillClient
    Gets bill client
    - getInvoiceClient() + getInvoiceClient()  : InvoiceClient
    Gets invoice client
    - getLedgerClient() + getLedgerClient()  : LedgerClient
    Gets ledger client
    - getPayoutClient() + getPayoutClient()  : PayoutClient
    Gets payout client
    - getPayoutRecipientsClient() + getPayoutRecipientsClient()  : PayoutRecipientsClient
    Gets payout recipients client
    - getRateClient() + getRateClient()  : RateClient
    Gets rate client
    - getRefundClient() + getRefundClient()  : RefundClient
    Gets refund client
    - getSettlementClient() + getSettlementClient()  : SettlementClient
    Gets settlement client
    - getWalletClient() + getWalletClient()  : WalletClient
    Gets wallet client
    - getConfigData() + getConfigData()  : array<string|int, mixed>
    - getTokenClient() + getTokenClient()  : TokenClient
    Gets token client
    - init() + init()  : void
    Initialize this object with the selected environment.
    - initKeys() + initKeys()  : PrivateKey|null
    @@ -721,6 +722,7 @@

    + protected string @@ -756,6 +758,7 @@

    + protected RESTcli @@ -791,6 +794,7 @@

    + protected RESTcli @@ -826,6 +830,7 @@

    + protected Tokens @@ -861,6 +866,7 @@

    + protected Tokens @@ -909,6 +915,7 @@

    +

    Parameters
    @@ -979,6 +986,7 @@

    +

    Parameters
    @@ -1073,6 +1081,7 @@

    +

    Parameters
    @@ -1167,6 +1176,7 @@

    +

    Parameters
    @@ -1249,6 +1259,7 @@

    +

    Parameters
    @@ -1330,6 +1341,7 @@

    +

    Parameters
    @@ -1409,6 +1421,7 @@

    +

    Parameters
    @@ -1488,6 +1501,7 @@

    +

    Parameters
    @@ -1589,6 +1603,7 @@

    +

    Parameters
    @@ -1689,6 +1704,7 @@

    +

    Parameters
    @@ -1770,6 +1786,7 @@

    +

    Parameters
    @@ -1916,6 +1933,7 @@

    +

    Parameters
    @@ -2026,6 +2044,7 @@

    +

    Parameters
    @@ -2091,6 +2110,7 @@

    +

    Parameters
    @@ -2178,6 +2198,7 @@

    +

    Parameters
    @@ -2279,6 +2300,7 @@

    +

    Parameters
    @@ -2380,6 +2402,7 @@

    +

    Parameters
    @@ -2463,6 +2486,7 @@

    +

    Tags @@ -2526,6 +2550,7 @@

    +

    Parameters
    @@ -2623,6 +2648,7 @@

    +

    Parameters
    @@ -2712,6 +2738,7 @@

    +

    Parameters
    @@ -2812,6 +2839,7 @@

    +

    The client must have been previously authorized for the specified facade.

    @@ -2916,6 +2944,7 @@

    +

    Parameters
    @@ -3045,6 +3074,7 @@

    +

    Parameters
    @@ -3152,6 +3182,7 @@

    +

    Tags @@ -3226,6 +3257,7 @@

    +

    Parameters
    @@ -3310,6 +3342,7 @@

    +

    Parameters
    @@ -3393,6 +3426,7 @@

    +

    Parameters
    @@ -3495,6 +3529,7 @@

    +

    Parameters
    @@ -3626,6 +3661,7 @@

    +

    Tags @@ -3693,6 +3729,7 @@

    +

    Parameters
    @@ -3780,6 +3817,7 @@

    +

    Parameters
    @@ -3867,6 +3905,7 @@

    +

    Parameters
    @@ -3942,6 +3981,7 @@

    +

    Parameters
    @@ -4025,6 +4065,7 @@

    +

    Parameters
    @@ -4116,6 +4157,7 @@

    +

    The limit and offset parameters specify pages for large query sets.

    @@ -4250,6 +4292,7 @@

    +

    Tags @@ -4321,6 +4364,7 @@

    +

    Tags @@ -4380,6 +4424,7 @@

    +

    Parameters
    @@ -4466,6 +4511,7 @@

    +

    Parameters
    @@ -4553,6 +4599,7 @@

    +

    Parameters
    @@ -4636,6 +4683,7 @@

    +

    Parameters
    @@ -4723,6 +4771,7 @@

    +

    Parameters
    @@ -4802,6 +4851,7 @@

    +

    Parameters
    @@ -4885,6 +4935,7 @@

    +

    Parameters
    @@ -4972,6 +5023,7 @@

    +

    Parameters
    @@ -5064,6 +5116,7 @@

    +

    Parameters
    @@ -5183,6 +5236,7 @@

    +

    Parameters
    @@ -5275,6 +5329,7 @@

    +

    Parameters
    @@ -5363,6 +5418,7 @@

    +

    Parameters
    @@ -5453,6 +5509,7 @@

    + @@ -5495,6 +5552,7 @@

    + @@ -5537,6 +5595,7 @@

    + @@ -5579,6 +5638,7 @@

    + @@ -5621,6 +5681,7 @@

    + @@ -5663,6 +5724,7 @@

    + @@ -5705,6 +5767,7 @@

    + @@ -5747,6 +5810,7 @@

    + @@ -5789,6 +5853,7 @@

    + @@ -5828,6 +5893,7 @@

    +

    Parameters
    @@ -5893,6 +5959,7 @@

    + @@ -5931,6 +5998,7 @@

    +

    Tags @@ -5977,6 +6045,7 @@

    +

    Parameters
    @@ -6141,80 +6210,80 @@
    Return values
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Tokens.html b/docs/classes/BitPaySDK-Tokens.html index 21b2317d..7ac26e94 100644 --- a/docs/classes/BitPaySDK-Tokens.html +++ b/docs/classes/BitPaySDK-Tokens.html @@ -155,6 +155,7 @@

    +

    Tags @@ -206,19 +207,19 @@

    - $merchant + $merchant  : string|null
    - $payout + $payout  : string|null
    - $pos + $pos  : string|null
    @@ -232,38 +233,38 @@

    - __construct() + __construct()  : mixed
    Tokens constructor.
    - getPayoutToken() + getPayoutToken()  : string|null
    - getTokenByFacade() + getTokenByFacade()  : string|null
    - loadFromArray() + loadFromArray()  : Tokens
    - setMerchantToken() + setMerchantToken()  : void
    - setPayoutToken() + setPayoutToken()  : void
    @@ -303,6 +304,7 @@

    + protected string|null @@ -338,6 +340,7 @@

    + protected string|null @@ -373,6 +376,7 @@

    + protected string|null @@ -421,6 +425,7 @@

    +

    Parameters
    @@ -480,6 +485,7 @@

    + @@ -515,6 +521,7 @@

    +

    Parameters
    @@ -577,6 +584,7 @@

    +

    Parameters
    @@ -624,6 +632,7 @@

    +

    Parameters
    @@ -667,6 +676,7 @@

    +

    Parameters
    @@ -797,21 +807,21 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Util-JsonMapperFactory.html b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html index a64b6176..97b08edd 100644 --- a/docs/classes/BitPaySDK-Util-JsonMapperFactory.html +++ b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html @@ -156,6 +156,7 @@

    +

    Tags @@ -208,7 +209,7 @@

    - create() + create()  : JsonMapper
    @@ -255,6 +256,7 @@

    + @@ -377,7 +379,7 @@

    Return values
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html index cd6b9c77..a5a7ef88 100644 --- a/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html +++ b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html @@ -157,6 +157,7 @@

    +

    Tags @@ -208,31 +209,31 @@

    - $baseUrl + $baseUrl  : string
    - $client + $client  : Client
    - $ecKey + $ecKey  : PrivateKey
    - $identity + $identity  : string
    - $proxy + $proxy  : string
    @@ -246,62 +247,62 @@

    - __construct() + __construct()  : mixed
    RESTcli constructor.
    - delete() + delete()  : string
    Send DELETE request.
    - get() + get()  : string
    Send GET request.
    - getJsonDataFromResponse() + getJsonDataFromResponse()  : string
    Parse Response object into json
    - init() + init()  : void
    Initialize Client.
    - post() + post()  : string
    Send POST request.
    - update() + update()  : string
    Send PUT request.
    - hasError() + hasError()  : bool
    - parseException() + parseException()  : void
    @@ -341,6 +342,7 @@

    + protected string @@ -376,6 +378,7 @@

    + protected Client @@ -411,6 +414,7 @@

    + protected PrivateKey @@ -446,6 +450,7 @@

    + protected string @@ -481,6 +486,7 @@

    + protected string @@ -529,6 +535,7 @@

    +

    Parameters
    @@ -602,6 +609,7 @@

    +

    Parameters
    @@ -680,6 +688,7 @@

    +

    Parameters
    @@ -769,6 +778,7 @@

    +

    Parameters
    @@ -834,6 +844,7 @@

    +

    Tags @@ -881,6 +892,7 @@

    +

    Parameters
    @@ -970,6 +982,7 @@

    +

    Parameters
    @@ -1047,6 +1060,7 @@

    +

    Parameters
    @@ -1094,6 +1108,7 @@

    +

    Parameters
    @@ -1247,26 +1262,26 @@
  • Properties
  • Methods
    • diff --git a/docs/css/base.css b/docs/css/base.css index 15c3998f..e50f4ae2 100644 --- a/docs/css/base.css +++ b/docs/css/base.css @@ -1216,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration. word-break: break-all; line-height: normal; } + + .phpdocumentor-on-this-page__content li.-deprecated { + text-decoration: line-through; + } } /* Used for screen readers and such */ diff --git a/docs/css/template.css b/docs/css/template.css index ba27e58b..3ade31a6 100644 --- a/docs/css/template.css +++ b/docs/css/template.css @@ -126,6 +126,10 @@ flex: 0 1 auto; } +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated { + text-decoration: line-through; +} + .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { flex: 1; white-space: nowrap; diff --git a/docs/files/src-bitpaysdk-client-billclient.html b/docs/files/src-bitpaysdk-client-billclient.html index a05810cf..232a3bb2 100644 --- a/docs/files/src-bitpaysdk-client-billclient.html +++ b/docs/files/src-bitpaysdk-client-billclient.html @@ -135,6 +135,7 @@

    BillClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-invoiceclient.html b/docs/files/src-bitpaysdk-client-invoiceclient.html index e9828b0c..45de5ece 100644 --- a/docs/files/src-bitpaysdk-client-invoiceclient.html +++ b/docs/files/src-bitpaysdk-client-invoiceclient.html @@ -135,6 +135,7 @@

    InvoiceClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-ledgerclient.html b/docs/files/src-bitpaysdk-client-ledgerclient.html index 12986068..2ea78b18 100644 --- a/docs/files/src-bitpaysdk-client-ledgerclient.html +++ b/docs/files/src-bitpaysdk-client-ledgerclient.html @@ -135,6 +135,7 @@

    LedgerClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-payoutclient.html b/docs/files/src-bitpaysdk-client-payoutclient.html index b24929be..b6f5ba4b 100644 --- a/docs/files/src-bitpaysdk-client-payoutclient.html +++ b/docs/files/src-bitpaysdk-client-payoutclient.html @@ -135,6 +135,7 @@

    PayoutClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html b/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html index a0c0b567..abcd021d 100644 --- a/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html +++ b/docs/files/src-bitpaysdk-client-payoutrecipientsclient.html @@ -135,6 +135,7 @@

    PayoutRecipientsClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-rateclient.html b/docs/files/src-bitpaysdk-client-rateclient.html index 320d47c8..ab31c9eb 100644 --- a/docs/files/src-bitpaysdk-client-rateclient.html +++ b/docs/files/src-bitpaysdk-client-rateclient.html @@ -135,6 +135,7 @@

    RateClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-refundclient.html b/docs/files/src-bitpaysdk-client-refundclient.html index e0296bf2..5fc53ec6 100644 --- a/docs/files/src-bitpaysdk-client-refundclient.html +++ b/docs/files/src-bitpaysdk-client-refundclient.html @@ -135,6 +135,7 @@

    RefundClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-settlementclient.html b/docs/files/src-bitpaysdk-client-settlementclient.html index 451aaae8..1ab073a0 100644 --- a/docs/files/src-bitpaysdk-client-settlementclient.html +++ b/docs/files/src-bitpaysdk-client-settlementclient.html @@ -135,6 +135,7 @@

    SettlementClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-tokenclient.html b/docs/files/src-bitpaysdk-client-tokenclient.html index 01173c82..74928e7a 100644 --- a/docs/files/src-bitpaysdk-client-tokenclient.html +++ b/docs/files/src-bitpaysdk-client-tokenclient.html @@ -135,6 +135,7 @@

    TokenClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client-walletclient.html b/docs/files/src-bitpaysdk-client-walletclient.html index 6c4fa07c..74ea06dd 100644 --- a/docs/files/src-bitpaysdk-client-walletclient.html +++ b/docs/files/src-bitpaysdk-client-walletclient.html @@ -135,6 +135,7 @@

    WalletClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-client.html b/docs/files/src-bitpaysdk-client.html index 8ae24af2..0bf7be07 100644 --- a/docs/files/src-bitpaysdk-client.html +++ b/docs/files/src-bitpaysdk-client.html @@ -135,6 +135,7 @@

    Client.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-env.html b/docs/files/src-bitpaysdk-env.html index 8d2d2d77..c997ef51 100644 --- a/docs/files/src-bitpaysdk-env.html +++ b/docs/files/src-bitpaysdk-env.html @@ -134,6 +134,7 @@

    Env.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-exceptions-bitpayapiexception.html b/docs/files/src-bitpaysdk-exceptions-bitpayapiexception.html index d36342d1..e1a5bb53 100644 --- a/docs/files/src-bitpaysdk-exceptions-bitpayapiexception.html +++ b/docs/files/src-bitpaysdk-exceptions-bitpayapiexception.html @@ -134,6 +134,7 @@

    BitPayApiException.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-exceptions-bitpayexception.html b/docs/files/src-bitpaysdk-exceptions-bitpayexception.html index 0bf6fbde..7700e593 100644 --- a/docs/files/src-bitpaysdk-exceptions-bitpayexception.html +++ b/docs/files/src-bitpaysdk-exceptions-bitpayexception.html @@ -134,6 +134,7 @@

    BitPayException.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-exceptions-bitpayexceptionprovider.html b/docs/files/src-bitpaysdk-exceptions-bitpayexceptionprovider.html index 958e377e..e80b13bb 100644 --- a/docs/files/src-bitpaysdk-exceptions-bitpayexceptionprovider.html +++ b/docs/files/src-bitpaysdk-exceptions-bitpayexceptionprovider.html @@ -134,6 +134,7 @@

    BitPayExceptionProvider.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-exceptions-bitpaygenericexception.html b/docs/files/src-bitpaysdk-exceptions-bitpaygenericexception.html index 8e6b4ad6..92b6f01a 100644 --- a/docs/files/src-bitpaysdk-exceptions-bitpaygenericexception.html +++ b/docs/files/src-bitpaysdk-exceptions-bitpaygenericexception.html @@ -134,6 +134,7 @@

    BitPayGenericException.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-exceptions-bitpayvalidationexception.html b/docs/files/src-bitpaysdk-exceptions-bitpayvalidationexception.html index f7e7d57f..be887ecd 100644 --- a/docs/files/src-bitpaysdk-exceptions-bitpayvalidationexception.html +++ b/docs/files/src-bitpaysdk-exceptions-bitpayvalidationexception.html @@ -134,6 +134,7 @@

    BitPayValidationException.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-logger-bitpaylogger.html b/docs/files/src-bitpaysdk-logger-bitpaylogger.html index 93d4bf68..f25dce23 100644 --- a/docs/files/src-bitpaysdk-logger-bitpaylogger.html +++ b/docs/files/src-bitpaysdk-logger-bitpaylogger.html @@ -135,6 +135,7 @@

    BitPayLogger.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-logger-emptylogger.html b/docs/files/src-bitpaysdk-logger-emptylogger.html index be494dfb..14465dca 100644 --- a/docs/files/src-bitpaysdk-logger-emptylogger.html +++ b/docs/files/src-bitpaysdk-logger-emptylogger.html @@ -135,6 +135,7 @@

    EmptyLogger.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-logger-loggerprovider.html b/docs/files/src-bitpaysdk-logger-loggerprovider.html index 29b43c21..170b5be2 100644 --- a/docs/files/src-bitpaysdk-logger-loggerprovider.html +++ b/docs/files/src-bitpaysdk-logger-loggerprovider.html @@ -135,6 +135,7 @@

    LoggerProvider.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-logger-monologloggerexample.html b/docs/files/src-bitpaysdk-logger-monologloggerexample.html index e3f4bfd4..78dde6c0 100644 --- a/docs/files/src-bitpaysdk-logger-monologloggerexample.html +++ b/docs/files/src-bitpaysdk-logger-monologloggerexample.html @@ -134,6 +134,7 @@

    MonologLoggerExample.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-bill-bill.html b/docs/files/src-bitpaysdk-model-bill-bill.html index 446c125f..862d3272 100644 --- a/docs/files/src-bitpaysdk-model-bill-bill.html +++ b/docs/files/src-bitpaysdk-model-bill-bill.html @@ -135,6 +135,7 @@

    Bill.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-bill-billstatus.html b/docs/files/src-bitpaysdk-model-bill-billstatus.html index 99830103..2c89be7a 100644 --- a/docs/files/src-bitpaysdk-model-bill-billstatus.html +++ b/docs/files/src-bitpaysdk-model-bill-billstatus.html @@ -135,6 +135,7 @@

    BillStatus.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-bill-item.html b/docs/files/src-bitpaysdk-model-bill-item.html index 1ef16f63..828dac98 100644 --- a/docs/files/src-bitpaysdk-model-bill-item.html +++ b/docs/files/src-bitpaysdk-model-bill-item.html @@ -135,6 +135,7 @@

    Item.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-currency.html b/docs/files/src-bitpaysdk-model-currency.html index d33814f4..578f4986 100644 --- a/docs/files/src-bitpaysdk-model-currency.html +++ b/docs/files/src-bitpaysdk-model-currency.html @@ -135,6 +135,7 @@

    Currency.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-facade.html b/docs/files/src-bitpaysdk-model-facade.html index b835d842..99af3d11 100644 --- a/docs/files/src-bitpaysdk-model-facade.html +++ b/docs/files/src-bitpaysdk-model-facade.html @@ -135,6 +135,7 @@

    Facade.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-buyer.html b/docs/files/src-bitpaysdk-model-invoice-buyer.html index 31fcea12..61fc1ae2 100644 --- a/docs/files/src-bitpaysdk-model-invoice-buyer.html +++ b/docs/files/src-bitpaysdk-model-invoice-buyer.html @@ -135,6 +135,7 @@

    Buyer.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-buyerfields.html b/docs/files/src-bitpaysdk-model-invoice-buyerfields.html index 13e6bac3..ffedd043 100644 --- a/docs/files/src-bitpaysdk-model-invoice-buyerfields.html +++ b/docs/files/src-bitpaysdk-model-invoice-buyerfields.html @@ -135,6 +135,7 @@

    BuyerFields.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html b/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html index b14fb53e..70b8c280 100644 --- a/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html +++ b/docs/files/src-bitpaysdk-model-invoice-buyerprovidedinfo.html @@ -135,6 +135,7 @@

    BuyerProvidedInfo.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-invoice.html b/docs/files/src-bitpaysdk-model-invoice-invoice.html index c5857c29..2f030b36 100644 --- a/docs/files/src-bitpaysdk-model-invoice-invoice.html +++ b/docs/files/src-bitpaysdk-model-invoice-invoice.html @@ -135,6 +135,7 @@

    Invoice.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-invoicerefundaddresses.html b/docs/files/src-bitpaysdk-model-invoice-invoicerefundaddresses.html index 7637e47a..0ea1b556 100644 --- a/docs/files/src-bitpaysdk-model-invoice-invoicerefundaddresses.html +++ b/docs/files/src-bitpaysdk-model-invoice-invoicerefundaddresses.html @@ -134,6 +134,7 @@

    InvoiceRefundAddresses.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html b/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html index 8fed4ee7..1f28ff7a 100644 --- a/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html +++ b/docs/files/src-bitpaysdk-model-invoice-invoicestatus.html @@ -135,6 +135,7 @@

    InvoiceStatus.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-invoicetransaction.html b/docs/files/src-bitpaysdk-model-invoice-invoicetransaction.html index 774bf195..28567264 100644 --- a/docs/files/src-bitpaysdk-model-invoice-invoicetransaction.html +++ b/docs/files/src-bitpaysdk-model-invoice-invoicetransaction.html @@ -134,6 +134,7 @@

    InvoiceTransaction.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-invoicewebhook.html b/docs/files/src-bitpaysdk-model-invoice-invoicewebhook.html index 60e12132..c63a2f70 100644 --- a/docs/files/src-bitpaysdk-model-invoice-invoicewebhook.html +++ b/docs/files/src-bitpaysdk-model-invoice-invoicewebhook.html @@ -135,6 +135,7 @@

    InvoiceWebhook.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html b/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html index 502d4e70..5db34ccd 100644 --- a/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html +++ b/docs/files/src-bitpaysdk-model-invoice-itemizeddetails.html @@ -135,6 +135,7 @@

    ItemizedDetails.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-minerfees.html b/docs/files/src-bitpaysdk-model-invoice-minerfees.html index 17a66e49..67c7822e 100644 --- a/docs/files/src-bitpaysdk-model-invoice-minerfees.html +++ b/docs/files/src-bitpaysdk-model-invoice-minerfees.html @@ -135,6 +135,7 @@

    MinerFees.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html b/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html index 07bf2272..fbf627a1 100644 --- a/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html +++ b/docs/files/src-bitpaysdk-model-invoice-minerfeesitem.html @@ -135,6 +135,7 @@

    MinerFeesItem.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-refund.html b/docs/files/src-bitpaysdk-model-invoice-refund.html index 6eab1a9b..3e881741 100644 --- a/docs/files/src-bitpaysdk-model-invoice-refund.html +++ b/docs/files/src-bitpaysdk-model-invoice-refund.html @@ -135,6 +135,7 @@

    Refund.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-refundinfo.html b/docs/files/src-bitpaysdk-model-invoice-refundinfo.html index 0be3a2c7..adc937ac 100644 --- a/docs/files/src-bitpaysdk-model-invoice-refundinfo.html +++ b/docs/files/src-bitpaysdk-model-invoice-refundinfo.html @@ -135,6 +135,7 @@

    RefundInfo.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-refundstatus.html b/docs/files/src-bitpaysdk-model-invoice-refundstatus.html index db82a35a..6889a38e 100644 --- a/docs/files/src-bitpaysdk-model-invoice-refundstatus.html +++ b/docs/files/src-bitpaysdk-model-invoice-refundstatus.html @@ -135,6 +135,7 @@

    RefundStatus.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html b/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html index 88d1c888..cb8b1f28 100644 --- a/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html +++ b/docs/files/src-bitpaysdk-model-invoice-refundwebhook.html @@ -135,6 +135,7 @@

    RefundWebhook.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-shopper.html b/docs/files/src-bitpaysdk-model-invoice-shopper.html index 1e3d6229..f99c43c0 100644 --- a/docs/files/src-bitpaysdk-model-invoice-shopper.html +++ b/docs/files/src-bitpaysdk-model-invoice-shopper.html @@ -135,6 +135,7 @@

    Shopper.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html index 4dcbafe9..55d6d78d 100644 --- a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html +++ b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrencies.html @@ -135,6 +135,7 @@

    SupportedTransactionCurrencies.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html index e7a65adc..d5b53b18 100644 --- a/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html +++ b/docs/files/src-bitpaysdk-model-invoice-supportedtransactioncurrency.html @@ -135,6 +135,7 @@

    SupportedTransactionCurrency.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-invoice-universalcodes.html b/docs/files/src-bitpaysdk-model-invoice-universalcodes.html index c98ecaf1..e369b7b6 100644 --- a/docs/files/src-bitpaysdk-model-invoice-universalcodes.html +++ b/docs/files/src-bitpaysdk-model-invoice-universalcodes.html @@ -135,6 +135,7 @@

    UniversalCodes.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-ledger-buyer.html b/docs/files/src-bitpaysdk-model-ledger-buyer.html index 97b41b72..a1cbfec3 100644 --- a/docs/files/src-bitpaysdk-model-ledger-buyer.html +++ b/docs/files/src-bitpaysdk-model-ledger-buyer.html @@ -135,6 +135,7 @@

    Buyer.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-ledger-ledger.html b/docs/files/src-bitpaysdk-model-ledger-ledger.html index 61b45cdd..572c4cf0 100644 --- a/docs/files/src-bitpaysdk-model-ledger-ledger.html +++ b/docs/files/src-bitpaysdk-model-ledger-ledger.html @@ -135,6 +135,7 @@

    Ledger.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html b/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html index b04ad852..8df77631 100644 --- a/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html +++ b/docs/files/src-bitpaysdk-model-ledger-ledgerentry.html @@ -135,6 +135,7 @@

    LedgerEntry.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payout.html b/docs/files/src-bitpaysdk-model-payout-payout.html index 36ef96e6..33d88e04 100644 --- a/docs/files/src-bitpaysdk-model-payout-payout.html +++ b/docs/files/src-bitpaysdk-model-payout-payout.html @@ -135,6 +135,7 @@

    Payout.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutgroup.html b/docs/files/src-bitpaysdk-model-payout-payoutgroup.html index 86b1c561..f5537376 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutgroup.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutgroup.html @@ -134,6 +134,7 @@

    PayoutGroup.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html b/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html index dfe7b071..eb841a57 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutgroupfailed.html @@ -135,6 +135,7 @@

    PayoutGroupFailed.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html b/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html index c32f8113..d516da2f 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutrecipient.html @@ -135,6 +135,7 @@

    PayoutRecipient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html b/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html index 76d74536..d3eb7928 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutrecipients.html @@ -135,6 +135,7 @@

    PayoutRecipients.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutstatus.html b/docs/files/src-bitpaysdk-model-payout-payoutstatus.html index e08fb1a1..d8b36742 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutstatus.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutstatus.html @@ -135,6 +135,7 @@

    PayoutStatus.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payouttransaction.html b/docs/files/src-bitpaysdk-model-payout-payouttransaction.html index ca3cfc14..0b5496a2 100644 --- a/docs/files/src-bitpaysdk-model-payout-payouttransaction.html +++ b/docs/files/src-bitpaysdk-model-payout-payouttransaction.html @@ -135,6 +135,7 @@

    PayoutTransaction.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-payoutwebhook.html b/docs/files/src-bitpaysdk-model-payout-payoutwebhook.html index 7886e149..337105ba 100644 --- a/docs/files/src-bitpaysdk-model-payout-payoutwebhook.html +++ b/docs/files/src-bitpaysdk-model-payout-payoutwebhook.html @@ -135,6 +135,7 @@

    PayoutWebhook.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html b/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html index 44c1fded..d5dffd7d 100644 --- a/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html +++ b/docs/files/src-bitpaysdk-model-payout-recipientreferencemethod.html @@ -135,6 +135,7 @@

    RecipientReferenceMethod.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-recipientstatus.html b/docs/files/src-bitpaysdk-model-payout-recipientstatus.html index 8b363241..c4abd154 100644 --- a/docs/files/src-bitpaysdk-model-payout-recipientstatus.html +++ b/docs/files/src-bitpaysdk-model-payout-recipientstatus.html @@ -135,6 +135,7 @@

    RecipientStatus.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-payout-recipientwebhook.html b/docs/files/src-bitpaysdk-model-payout-recipientwebhook.html index b35edd84..78d9cfed 100644 --- a/docs/files/src-bitpaysdk-model-payout-recipientwebhook.html +++ b/docs/files/src-bitpaysdk-model-payout-recipientwebhook.html @@ -135,6 +135,7 @@

    RecipientWebhook.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-rate-rate.html b/docs/files/src-bitpaysdk-model-rate-rate.html index 5e98bc10..9fe63543 100644 --- a/docs/files/src-bitpaysdk-model-rate-rate.html +++ b/docs/files/src-bitpaysdk-model-rate-rate.html @@ -135,6 +135,7 @@

    Rate.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-rate-rates.html b/docs/files/src-bitpaysdk-model-rate-rates.html index 5ad22d58..8c0489d9 100644 --- a/docs/files/src-bitpaysdk-model-rate-rates.html +++ b/docs/files/src-bitpaysdk-model-rate-rates.html @@ -135,6 +135,7 @@

    Rates.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-invoicedata.html b/docs/files/src-bitpaysdk-model-settlement-invoicedata.html index 5335020f..a6dfa135 100644 --- a/docs/files/src-bitpaysdk-model-settlement-invoicedata.html +++ b/docs/files/src-bitpaysdk-model-settlement-invoicedata.html @@ -135,6 +135,7 @@

    InvoiceData.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html b/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html index ae2060f5..f2940075 100644 --- a/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html +++ b/docs/files/src-bitpaysdk-model-settlement-payoutinfo.html @@ -135,6 +135,7 @@

    PayoutInfo.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-refundinfo.html b/docs/files/src-bitpaysdk-model-settlement-refundinfo.html index 728ce61f..a31e6d0c 100644 --- a/docs/files/src-bitpaysdk-model-settlement-refundinfo.html +++ b/docs/files/src-bitpaysdk-model-settlement-refundinfo.html @@ -135,6 +135,7 @@

    RefundInfo.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-settlement.html b/docs/files/src-bitpaysdk-model-settlement-settlement.html index beb9e4b0..3f40048a 100644 --- a/docs/files/src-bitpaysdk-model-settlement-settlement.html +++ b/docs/files/src-bitpaysdk-model-settlement-settlement.html @@ -135,6 +135,7 @@

    Settlement.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html b/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html index 86258824..87590c97 100644 --- a/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html +++ b/docs/files/src-bitpaysdk-model-settlement-settlementledgerentry.html @@ -135,6 +135,7 @@

    SettlementLedgerEntry.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-settlement-withholdings.html b/docs/files/src-bitpaysdk-model-settlement-withholdings.html index 56ce4393..667a6d4d 100644 --- a/docs/files/src-bitpaysdk-model-settlement-withholdings.html +++ b/docs/files/src-bitpaysdk-model-settlement-withholdings.html @@ -135,6 +135,7 @@

    WithHoldings.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-wallet-currencies.html b/docs/files/src-bitpaysdk-model-wallet-currencies.html index 072ca803..edcc24e6 100644 --- a/docs/files/src-bitpaysdk-model-wallet-currencies.html +++ b/docs/files/src-bitpaysdk-model-wallet-currencies.html @@ -135,6 +135,7 @@

    Currencies.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-wallet-currencyqr.html b/docs/files/src-bitpaysdk-model-wallet-currencyqr.html index 60e31638..643302e4 100644 --- a/docs/files/src-bitpaysdk-model-wallet-currencyqr.html +++ b/docs/files/src-bitpaysdk-model-wallet-currencyqr.html @@ -135,6 +135,7 @@

    CurrencyQr.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-model-wallet-wallet.html b/docs/files/src-bitpaysdk-model-wallet-wallet.html index 78251356..2fac3bb5 100644 --- a/docs/files/src-bitpaysdk-model-wallet-wallet.html +++ b/docs/files/src-bitpaysdk-model-wallet-wallet.html @@ -135,6 +135,7 @@

    Wallet.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-posclient.html b/docs/files/src-bitpaysdk-posclient.html index 06068775..1aaef268 100644 --- a/docs/files/src-bitpaysdk-posclient.html +++ b/docs/files/src-bitpaysdk-posclient.html @@ -135,6 +135,7 @@

    PosClient.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-tokens.html b/docs/files/src-bitpaysdk-tokens.html index a5684407..44ffc4fe 100644 --- a/docs/files/src-bitpaysdk-tokens.html +++ b/docs/files/src-bitpaysdk-tokens.html @@ -135,6 +135,7 @@

    Tokens.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-util-jsonmapperfactory.html b/docs/files/src-bitpaysdk-util-jsonmapperfactory.html index 2a71bf18..50268d8c 100644 --- a/docs/files/src-bitpaysdk-util-jsonmapperfactory.html +++ b/docs/files/src-bitpaysdk-util-jsonmapperfactory.html @@ -135,6 +135,7 @@

    JsonMapperFactory.php

    +

    Table of Contents diff --git a/docs/files/src-bitpaysdk-util-restcli-restcli.html b/docs/files/src-bitpaysdk-util-restcli-restcli.html index 8a895ddc..c92e4152 100644 --- a/docs/files/src-bitpaysdk-util-restcli-restcli.html +++ b/docs/files/src-bitpaysdk-util-restcli-restcli.html @@ -135,6 +135,7 @@

    RESTcli.php

    +

    Table of Contents diff --git a/src/BitPaySDK/Env.php b/src/BitPaySDK/Env.php index 41d11521..98f5053b 100644 --- a/src/BitPaySDK/Env.php +++ b/src/BitPaySDK/Env.php @@ -17,7 +17,7 @@ interface Env 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_v9.0.3"; + public const BITPAY_PLUGIN_INFO = "BitPay_PHP_Client_v9.0.4"; public const BITPAY_API_FRAME = "std"; public const BITPAY_API_FRAME_VERSION = "1.0.0"; }