org.wisepersist.pinpayments.api.impl

Class TransfersApiImpl

java.lang.Object

org.wisepersist.pinpayments.api.impl.AbstractBaseApi

org.wisepersist.pinpayments.api.impl.TransfersApiImpl

All Implemented Interfaces:

TransfersApi

public class TransfersApiImpl
extends AbstractBaseApi
implements TransfersApi

Implementation of TransfersApi interface.

Constructor Summary

Constructors

Constructor and Description
TransfersApiImpl()

Method Summary

Modifier and Type	Method and Description
TransferResponse	create(Transfer transfer) Creates a new transfer and returns its details.
TransferResponse	fetch(java.lang.String transferToken) Returns the details of a transfer.
protected java.lang.String	getApiName()
TransferListResponse	list(int page) Returns a paginated list of all transfers.
TransferLineItemListResponse	listLineItems(java.lang.String transferToken, int page) Returns the line items associated with transfer.
TransferListResponse	search(SearchCriteria searchCriteria) Returns a paginated list of transfers 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

TransfersApiImpl

public TransfersApiImpl()

Method Detail

create

public final TransferResponse create(Transfer transfer)
                              throws java.io.IOException

Description copied from interface: TransfersApi

Creates a new transfer and returns its details.

Specified by:

create in interface TransfersApi

Parameters:

transfer - The transfer specified.

Returns:

The details of the transfer created.

Throws:

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

list

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

Description copied from interface: TransfersApi

Returns a paginated list of all transfers.

Specified by:

list in interface TransfersApi

Parameters:

page - The page number specified.

Returns:

A paginated list of all transfers.

Throws:

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

search

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

Description copied from interface: TransfersApi

Returns a paginated list of transfers matching the search criteria.

Specified by:

search in interface TransfersApi

Parameters:

searchCriteria - The search criteria specified.

Returns:

A paginated list of transfers matching the search criteria.

Throws:

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

fetch

public final TransferResponse fetch(java.lang.String transferToken)
                             throws java.io.IOException

Description copied from interface: TransfersApi

Returns the details of a transfer.

Specified by:

fetch in interface TransfersApi

Parameters:

transferToken - The transfer token specified.

Returns:

The details of the transfer fetched.

Throws:

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

listLineItems

public final TransferLineItemListResponse listLineItems(java.lang.String transferToken,
                                                        int page)
                                                 throws java.io.IOException

Description copied from interface: TransfersApi

Returns the line items associated with transfer.

Specified by:

listLineItems in interface TransfersApi

Parameters:

transferToken - The transfer token specified.

page - The page number specified.

Returns:

The line items associated with transfer.

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