Constructor Detail

• RefundService

  public RefundService(HttpClient httpClient)

  Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.refunds().

Method Detail

• create

  public RefundService.RefundCreateRequest create()

  Creates a new refund object.

  This fails with:

  • refund_payment_invalid_state error if the linked payment isn’t either confirmed or paid_out.

  • total_amount_confirmation_invalid if the confirmation amount doesn’t match the total amount refunded for the payment. This safeguard is there to prevent two processes from creating refunds without awareness of each other.

  • number_of_refunds_exceeded if five or more refunds have already been created against the payment.

• list

  public RefundService.RefundListRequest<ListResponse<Refund>> list()

  Returns a cursor-paginated list of your refunds.

• all

  public RefundService.RefundListRequest<java.lang.Iterable<Refund>> all()

• get

  public RefundService.RefundGetRequest get(java.lang.String identity)

  Retrieves all details for a single refund

• update

  public RefundService.RefundUpdateRequest update(java.lang.String identity)

  Updates a refund object.