net.joelinn.stripe.api

Class Refunds

java.lang.Object

net.joelinn.stripe.api.AbstractApi

net.joelinn.stripe.api.Refunds

public class Refunds
extends AbstractApi

User: Joe Linn Date: 7/28/2014 Time: 11:50 AM

Field Summary

Fields inherited from class net.joelinn.stripe.api.AbstractApi

client

Constructor Summary

Constructors

Constructor and Description
Refunds(Client client)

Method Summary

Modifier and Type	Method and Description
protected String	buildUrl(String chargeId)
protected String	buildUrl(String chargeId, String refundId)
RefundResponse	createRefund(String chargeId) Create a refund (refund a charge) https://stripe.com/docs/api#create_refund
RefundResponse	createRefund(String chargeId, CreateRefundRequest request) Create a refund (refund a charge) https://stripe.com/docs/api#create_refund
RefundResponse	getRefund(String chargeId, String refundId) Retrieve a refund https://stripe.com/docs/api#retrieve_refund
ListRefundsResponse	listRefunds(String chargeId, ListRequest listRequest) List all refunds associated with the given charge https://stripe.com/docs/api#list_refunds
RefundResponse	updateRefund(String chargeId, String refundId, Map<String,Object> metadata) Update the metadata of a refund https://stripe.com/docs/api#update_refund

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Refunds

public Refunds(Client client)

Method Detail

createRefund

public RefundResponse createRefund(String chargeId)

Create a refund (refund a charge) https://stripe.com/docs/api#create_refund

Parameters:

chargeId - the id of the charge to refund

Returns:

the results of the refund operation

createRefund

public RefundResponse createRefund(String chargeId,
                                   CreateRefundRequest request)

Create a refund (refund a charge) https://stripe.com/docs/api#create_refund

Parameters:

chargeId - the id of the charge to refund

request - optional refund request parameters

Returns:

the results of the refund operation

getRefund

public RefundResponse getRefund(String chargeId,
                                String refundId)

Retrieve a refund https://stripe.com/docs/api#retrieve_refund

Parameters:

chargeId - the id of the refunded charge

refundId - the id of the refund to be retrieved

Returns:

details regarding the requested refund

updateRefund

public RefundResponse updateRefund(String chargeId,
                                   String refundId,
                                   Map<String,Object> metadata)

Update the metadata of a refund https://stripe.com/docs/api#update_refund

Parameters:

chargeId - the id of the refunded charge

refundId - the id of the refund to be updated

metadata - new metadata for this refund

Returns:

the updated refund

listRefunds

public ListRefundsResponse listRefunds(String chargeId,
                                       ListRequest listRequest)

List all refunds associated with the given charge https://stripe.com/docs/api#list_refunds

Parameters:

chargeId - the id of the refunded charge

listRequest - optional list request parameters

Returns:

a list of refunds

buildUrl

protected String buildUrl(String chargeId)

buildUrl

protected String buildUrl(String chargeId,
                          String refundId)