net.joelinn.stripe.api

Class Charges

java.lang.Object

net.joelinn.stripe.api.AbstractApi

net.joelinn.stripe.api.Charges

public class Charges
extends AbstractApi

User: Joe Linn Date: 5/23/2014 Time: 12:08 PM

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
Charges(Client client)

Method Summary

Modifier and Type	Method and Description
protected String	buildUrl()
protected String	buildUrl(String chargeId)
ChargeResponse	captureCharge(String chargeId) Capture a charge for the full amount https://stripe.com/docs/api#charge_capture
ChargeResponse	captureCharge(String chargeId, Integer amount, Integer applicationFee) Capture a charge https://stripe.com/docs/api#charge_capture
ChargeResponse	createCharge(CreateChargeRequest request) Create a charge https://stripe.com/docs/api#create_charge
ChargeResponse	getCharge(String chargeId) Retrieve a charge https://stripe.com/docs/api#retrieve_charge
ListChargesResponse	listCharges(Integer limit) Retrieve a list of charges https://stripe.com/docs/api#list_charges
ChargeResponse	refundCharge(String chargeId) Refund the full amount of a charge https://stripe.com/docs/api#refund_charge
ChargeResponse	refundCharge(String chargeId, Integer amount, Integer refundApplicationFee) Refund a charge https://stripe.com/docs/api#refund_charge
ChargeResponse	updateCharge(String chargeId, String description, Map<String,Object> metadata) Update a charge https://stripe.com/docs/api#update_charge

Methods inherited from class java.lang.Object

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

Constructor Detail

Charges

public Charges(Client client)

Method Detail

createCharge

public ChargeResponse createCharge(CreateChargeRequest request)

Create a charge https://stripe.com/docs/api#create_charge

getCharge

public ChargeResponse getCharge(String chargeId)

Retrieve a charge https://stripe.com/docs/api#retrieve_charge

Parameters:

chargeId - the id of the charge to retrieve

updateCharge

public ChargeResponse updateCharge(String chargeId,
                                   String description,
                                   Map<String,Object> metadata)

Update a charge https://stripe.com/docs/api#update_charge

Parameters:

chargeId - the id of the charge to update

description - optional updated description

metadata - optional updated metadata

refundCharge

public ChargeResponse refundCharge(String chargeId)

Refund the full amount of a charge https://stripe.com/docs/api#refund_charge

Parameters:

chargeId - the id of the charge to refund

refundCharge

public ChargeResponse refundCharge(String chargeId,
                                   Integer amount,
                                   Integer refundApplicationFee)

Refund a charge https://stripe.com/docs/api#refund_charge

Parameters:

chargeId - the id of the charge to refund

amount - optional amount to refund

refundApplicationFee - optional refund application fee

captureCharge

public ChargeResponse captureCharge(String chargeId)

Capture a charge for the full amount https://stripe.com/docs/api#charge_capture

Parameters:

chargeId - the id of the charge to capture

captureCharge

public ChargeResponse captureCharge(String chargeId,
                                    Integer amount,
                                    Integer applicationFee)

Capture a charge https://stripe.com/docs/api#charge_capture

Parameters:

chargeId - the id of the charge to capture

amount - optional amount to capture

applicationFee - optional application fee

listCharges

public ListChargesResponse listCharges(Integer limit)

Retrieve a list of charges https://stripe.com/docs/api#list_charges

Parameters:

limit - optional number of charges to return

buildUrl

protected String buildUrl()

buildUrl

protected String buildUrl(String chargeId)