org.wisepersist.pinpayments.api

Interface RefundsApi

All Known Implementing Classes:

RefundsApiImpl

public interface RefundsApi

The refunds API allows you to refund a charge, and retrieve the details of previous refunds.

See Also:

Refunds API

Method Summary

Modifier and Type	Method and Description
RefundResponse	create(java.lang.String chargeToken, Refund refund) Creates a new refund, and returns its details.
RefundResponse	fetch(java.lang.String refundToken) Returns details for a specific refund.
RefundListResponse	list(int page) Returns a paginated list of all refunds.
RefundListResponse	listForCharge(java.lang.String chargeToken, int page) Returns a list of all refunds for this charge.

Method Detail

list

RefundListResponse list(int page)
                 throws java.io.IOException

Returns a paginated list of all refunds.

Parameters:

page - The page number specified.

Returns:

A paginated list of all refunds.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

fetch

RefundResponse fetch(java.lang.String refundToken)
              throws java.io.IOException

Returns details for a specific refund.

Parameters:

refundToken - The refund token specified.

Returns:

The details of the refund fetched.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

create

RefundResponse create(java.lang.String chargeToken,
                      Refund refund)
               throws java.io.IOException

Creates a new refund, and returns its details.

Parameters:

chargeToken - The charge token specified.

refund - The refund to be created.

Returns:

The details of the refund created.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

listForCharge

RefundListResponse listForCharge(java.lang.String chargeToken,
                                 int page)
                          throws java.io.IOException

Returns a list of all refunds for this charge.

Parameters:

chargeToken - The charge token specified.

page - The page number specified.

Returns:

The list of all refunds for this charge.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.