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 {}