org.wisepersist.pinpayments.api.impl

Class ChargesApiImpl

java.lang.Object

org.wisepersist.pinpayments.api.impl.AbstractBaseApi

org.wisepersist.pinpayments.api.impl.ChargesApiImpl

All Implemented Interfaces:

ChargesApi

public class ChargesApiImpl
extends AbstractBaseApi
implements ChargesApi

Implementation of ChargesApi interface.

Constructor Summary

Constructors

Constructor and Description
ChargesApiImpl()

Method Summary

Modifier and Type	Method and Description
ChargeResponse	capture(java.lang.String chargeToken) Captures a previously authorised charge and returns its details.
ChargeResponse	create(Charge charge) Creates a new charge and returns its details.
ChargeResponse	fetch(java.lang.String chargeToken) Returns the details of a charge.
protected java.lang.String	getApiName()
ChargeListResponse	list(int page) Returns a paginated list of all charges.
ChargeListResponse	search(SearchCriteria searchCriteria) Returns a paginated list of charges matching the search criteria.

Methods inherited from class org.wisepersist.pinpayments.api.impl.AbstractBaseApi

executeList, executeSearch, getApiBase, getApiUrl, getDeletionResult, httpTransportForDelete, httpTransportForGet, httpTransportForPost, httpTransportForPut

Methods inherited from class java.lang.Object

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

Constructor Detail

ChargesApiImpl

public ChargesApiImpl()

Method Detail

create

public final ChargeResponse create(Charge charge)
                            throws java.io.IOException

Description copied from interface: ChargesApi

Creates a new charge and returns its details. This may be a long-running request.

Specified by:

create in interface ChargesApi

Parameters:

charge - The charge specified.

Returns:

The details of the new charge created.

Throws:

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

capture

public final ChargeResponse capture(java.lang.String chargeToken)
                             throws java.io.IOException

Description copied from interface: ChargesApi

Captures a previously authorised charge and returns its details. Currently, you can only capture the full amount that was originally authorised.

Specified by:

capture in interface ChargesApi

Parameters:

chargeToken - The charge token specified.

Returns:

The details of the charge captured.

Throws:

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

list

public final ChargeListResponse list(int page)
                              throws java.io.IOException

Description copied from interface: ChargesApi

Returns a paginated list of all charges.

Specified by:

list in interface ChargesApi

Parameters:

page - The page number specified.

Returns:

A paginated list of all charges.

Throws:

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

search

public final ChargeListResponse search(SearchCriteria searchCriteria)
                                throws java.io.IOException

Description copied from interface: ChargesApi

Returns a paginated list of charges matching the search criteria.

Specified by:

search in interface ChargesApi

Parameters:

searchCriteria - The search criteria specified.

Returns:

A paginated list of charges matching the search criteria.

Throws:

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

fetch

public final ChargeResponse fetch(java.lang.String chargeToken)
                           throws java.io.IOException

Description copied from interface: ChargesApi

Returns the details of a charge.

Specified by:

fetch in interface ChargesApi

Parameters:

chargeToken - The charge token specified.

Returns:

The details of the charge fetched.

Throws:

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

getApiName

protected final java.lang.String getApiName()

Specified by:

getApiName in class AbstractBaseApi