org.wisepersist.pinpayments.api

Interface RecipientsApi

All Known Implementing Classes:

RecipientsApiImpl

public interface RecipientsApi

The recipients API allows you to post bank account details and retrieve a token that you can safely store in your app. You can send funds to recipients using the transfers API.

See Also:

Recipients API

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

Method Detail

create

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

Creates a new recipient and returns its details.

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

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

Returns a paginated list of all recipients.

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

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

Returns the details of a recipient.

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

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

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

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

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

Returns a paginated list of a recipient's transfers.

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.