v8.8.0

Overview

This release adds the ability to cancel an invoice by GUID and addresses a few bugs.

Changes

• Added Dependabot!
• Added getRates() to retrieve the exchange rate table maintained by BitPay by baseCurrency
• Added getRate() to retrieve the rates for a cryptocurrency / fiat pair
• Added ability to retrieve an event token
• Added the ability to cancel an invoice by GUID
• Bumped version to 8.8.0

Bug fixes

• Invoices now respect a custom GUID passed to them

Details

Dependabot

Now that we have a more robust test suite, we have installed and configured Dependabot to contribute pull requests for package updates.

Get Rates (new)

public Rates getRates() throws RateQueryException {}

Get Rate (new)

public Rate getRate(String baseCurrency, String currency) throws RateQueryException {}

Retrieve an Event Token (new)

public InvoiceEventToken getInvoiceEventToken(String invoiceId) throws BitPayException {}

Cancel Invoice by GUID (new)

Default call, will set forceCancel false.

public Invoice cancelInvoiceByGuid(String guid) throws BitPayException {

Cancel Invoice by GUID

Allow for forceCancel to be set explicitly.

public Invoice cancelInvoiceByGuid(String guid, Boolean forceCancel) throws BitPayException {}

Invoices now respect a custom GUID passed to them (bug fix)

• If the Invoice object sent to createInvoice() has setGuid() set, that GUID will be used for the invoice
• If the Invoice object sent to createInvoice() does not have setGuid() set, a UUIDv4 will be generated for you

v8.7.0

Overview

This release adds the ability to create, get, update, and cancel refunds by GUID, which is:

A variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system.

Changes

• Added ability to create refund with a GUID in the method params
• Added ability to create a refund from a refund object
• Added ability to get refund by GUID
• Added ability to update refund by GUID
• Added ability to cancel refund by GUID

Details

Create Refund (Original, no change)

public Refund createRefund(String invoiceId, Double amount, Boolean preview, Boolean immediate, Boolean buyerPaysRefundFee, String reference) throws RefundCreationException, BitPayException {}

Create Refund with GUID (New)

public Refund createRefund(
        String invoiceId,
        Double amount,
        Boolean preview,
        Boolean immediate,
        Boolean buyerPaysRefundFee,
        String reference,
        String guid
    ) throws RefundCreationException, BitPayException {}

Create Refund by passing a Refund object (New)

We added this method to the Client to better align with other methods.

public Refund createRefund(Refund refund) throws
        RefundCreationException, BitPayException {}

Get Refund by GUID

public Refund getRefundByGuid(String guid) throws RefundQueryException, BitPayException {}

Update Refund by GUID

public Refund updateRefundByGuid(String guid, String status) throws RefundUpdateException, BitPayException {}

Cancel Refund by GUID

public Refund cancelRefundByGuid(String guid) throws RefundCancellationException, BitPayException {}

v8.6.2

Patch Release

This release moves the refundRequestEid field from com.bitpay.sdk.model.Invoice.RefundInfo to com.bitpay.sdk.model.Settlement.RefundInfo

v8.6.1

Patch Release

This release upgrades jackson-databind to version 2.14.0. Version 2.13.4.1 does not have a corresponding jackson-bom version.

v8.6.0

Overview

This release adds unit tests, new GitHub checks, upgrades jackson-databind, adds a new field, and many other minor updates.

Changed

• Added JUnit for unit tests
• Added code coverage for unit tests
• Added initial JavaDoc, with more detail coming in the next few minor releases
• JUnit now runs checks on branches (not `master) and pull requests (one check for each supported version of Java: 8, 11, and 17)
• Upgraded jackson-bind to 12.13.4.1
• Added the refundRequestEid field to the RefundInfo object
• Moved /apidocs to /docs to make the JavaDoc available via GitHub Pages
• Moved /docs to /guides
• Fixed a mapper with a duplicate JsonProperty in src/main/java/com/bitpay/sdk/model/Settlement/PayoutInfo.java and src/main/java/com/bitpay/sdk/model/Settlement/WithHoldings.java

v8.5.2208

What's New (⚠️= breaking changes):

Changed

• autoRedirect should set the value on the invoice
• forcedBuyerSelectedTransactionCurrency should set the value on the invoice
• Add new fields to Refund

v8.5.2207

What's New (⚠️= breaking changes):

Changed

• Fixed pay invoice method and updated testcase
• Removed boolean field complete in payInvoice method

v8.5.2206

What's New (⚠️= breaking changes):

Changed

• Updated Refund Webhook Model

Added

• Added image field in supported wallets

v8.5.2205

Added forcedBuyerSelectedTransactionCurrency to CreateInvoice.

Field Name: forcedBuyerSelectedTransactionCurrency
Description: Enables merchant to pre-select crypto currency on behalf of buyer
Type: String
Optional: Yes

To retrieve a list of supported currencies please see: https://bitpay.com/api/#rest-api-resources-currencies-retrieve-the-supported-currencies

v8.5.2204

What's New (⚠️= breaking changes):

Changed

Added

• Invoice Update: Get Invoice by guid