org.wisepersist.pinpayments.api

Interface ChargesApi

All Known Implementing Classes:

ChargesApiImpl

public interface ChargesApi

The charges API allows you to create new credit card charges, and to retrieve details of previous charges.

See Also:

Charges API

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.
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.

Method Detail

create

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

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

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

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

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

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

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

Returns a paginated list of all charges.

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

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

Returns a paginated list of charges matching the search criteria.

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

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

Returns the details of a charge.

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.