org.wisepersist.pinpayments.api.impl

Class RecipientsApiImpl

java.lang.Object

org.wisepersist.pinpayments.api.impl.AbstractBaseApi

org.wisepersist.pinpayments.api.impl.RecipientsApiImpl

All Implemented Interfaces:

RecipientsApi

public class RecipientsApiImpl
extends AbstractBaseApi
implements RecipientsApi

Implementation of RecipientsApi interface.

Constructor Summary

Constructors

Constructor and Description
RecipientsApiImpl()

Method Summary

Modifier and Type	Method and Description
RecipientResponse	create(Recipient recipient) Creates a new recipient and returns its details.
RecipientResponse	fetch(java.lang.String recipientToken) Returns the details of a recipient.
protected java.lang.String	getApiName()
RecipientListResponse	list(int page) Returns a paginated list of all recipients.
TransferListResponse	listTransfers(java.lang.String recipientToken, int page) Returns a paginated list of a recipient's transfers.
RecipientResponse	update(java.lang.String recipientToken, Recipient recipient) Updates the given details of a recipient and returns its details.

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

RecipientsApiImpl

public RecipientsApiImpl()

Method Detail

create

public final RecipientResponse create(Recipient recipient)
                               throws java.io.IOException

Description copied from interface: RecipientsApi

Creates a new recipient and returns its details.

Specified by:

create in interface RecipientsApi

Parameters:

recipient - The recipient specified.

Returns:

The details of the new recipient created.

Throws:

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

list

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

Description copied from interface: RecipientsApi

Returns a paginated list of all recipients.

Specified by:

list in interface RecipientsApi

Parameters:

page - The page number specified.

Returns:

A paginated list of all recipients.

Throws:

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

fetch

public final RecipientResponse fetch(java.lang.String recipientToken)
                              throws java.io.IOException

Description copied from interface: RecipientsApi

Returns the details of a recipient.

Specified by:

fetch in interface RecipientsApi

Parameters:

recipientToken - The recipient token specified.

Returns:

The details of the recipient fetched.

Throws:

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

update

public final RecipientResponse update(java.lang.String recipientToken,
                                      Recipient recipient)
                               throws java.io.IOException

Description copied from interface: RecipientsApi

Updates the given details of a recipient and returns its details.

Specified by:

update in interface RecipientsApi

Parameters:

recipientToken - The recipient token specified.

recipient - The recipient which contains new information specified.

Returns:

The details of the recipient updated.

Throws:

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

listTransfers

public final TransferListResponse listTransfers(java.lang.String recipientToken,
                                                int page)
                                         throws java.io.IOException

Description copied from interface: RecipientsApi

Returns a paginated list of a recipient's transfers.

Specified by:

listTransfers in interface RecipientsApi

Parameters:

recipientToken - The recipient token specified.

page - The page number specified.

Returns:

A paginated list of a recipient's transfers.

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