org.wisepersist.pinpayments.api

Interface TransfersApi

All Known Implementing Classes:

TransfersApiImpl

public interface TransfersApi

The transfers API allows you to send money to Australian bank accounts, and to retrieve details of previous transfers.

See Also:

Transfers API

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

Method Detail

create

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

Creates a new transfer and returns its details.

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

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

Returns a paginated list of all transfers.

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

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

Returns a paginated list of transfers matching the search criteria.

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

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

Returns the details of a transfer.

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

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

Returns the line items associated with transfer.

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.