com.mangopay.core.APIs.implementation

Class TransferApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.TransferApiImpl

All Implemented Interfaces:

TransferApi

public class TransferApiImpl
extends ApiBase
implements TransferApi

API for transfers.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
TransferApiImpl(MangoPayApi root, com.google.gson.GsonBuilder gsonBuilder) Instantiates new TransferApiImpl object.

Method Summary

Modifier and Type	Method and Description
Transfer	create(java.lang.String idempotencyKey, Transfer transfer) Creates new transfer.
Transfer	create(Transfer transfer) Creates new transfer.
Refund	createRefund(java.lang.String transferId, Refund refund) Creates refund for transfer object.
Refund	createRefund(java.lang.String idempotencyKey, java.lang.String transferId, Refund refund) Creates refund for transfer object.
Transfer	get(java.lang.String transferId) Gets the transfer.
Refund	getRefund(java.lang.String transferId) Gets refund for transfer object.
java.util.List<Refund>	getRefunds(java.lang.String transferId) Get first page of transfer's refunds
java.util.List<Refund>	getRefunds(java.lang.String transferId, Pagination pagination, Sorting sorting) Get a page of transfer's refunds

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferApiImpl

public TransferApiImpl(MangoPayApi root,
                       com.google.gson.GsonBuilder gsonBuilder)

Instantiates new TransferApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

Method Detail

create

public Transfer create(Transfer transfer)
                throws java.lang.Exception

Description copied from interface: TransferApi

Creates new transfer.

Specified by:

create in interface TransferApi

Parameters:

transfer - Instance of Transfer class to be created.

Returns:

Transfer object returned from API.

Throws:

java.lang.Exception

create

public Transfer create(java.lang.String idempotencyKey,
                       Transfer transfer)
                throws java.lang.Exception

Description copied from interface: TransferApi

Creates new transfer.

Specified by:

create in interface TransferApi

Parameters:

idempotencyKey - idempotency key for this request.

transfer - Instance of Transfer class to be created.

Returns:

Transfer object returned from API.

Throws:

java.lang.Exception

get

public Transfer get(java.lang.String transferId)
             throws java.lang.Exception

Description copied from interface: TransferApi

Gets the transfer.

Specified by:

get in interface TransferApi

Parameters:

transferId - Transfer identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

createRefund

public Refund createRefund(java.lang.String transferId,
                           Refund refund)
                    throws java.lang.Exception

Description copied from interface: TransferApi

Creates refund for transfer object.

Specified by:

createRefund in interface TransferApi

Parameters:

transferId - Transfer identifier.

refund - Refund object to create.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

createRefund

public Refund createRefund(java.lang.String idempotencyKey,
                           java.lang.String transferId,
                           Refund refund)
                    throws java.lang.Exception

Description copied from interface: TransferApi

Creates refund for transfer object.

Specified by:

createRefund in interface TransferApi

Parameters:

idempotencyKey - idempotency key for this request.

transferId - Transfer identifier.

refund - Refund object to create.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

getRefund

public Refund getRefund(java.lang.String transferId)
                 throws java.lang.Exception

Description copied from interface: TransferApi

Gets refund for transfer object.

Specified by:

getRefund in interface TransferApi

Parameters:

transferId - Transfer identifier.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

getRefunds

public java.util.List<Refund> getRefunds(java.lang.String transferId)
                                  throws java.lang.Exception

Description copied from interface: TransferApi

Get first page of transfer's refunds

Specified by:

getRefunds in interface TransferApi

Parameters:

transferId - Transfer identifier

Returns:

Collection of transfer refunds

Throws:

java.lang.Exception

getRefunds

public java.util.List<Refund> getRefunds(java.lang.String transferId,
                                         Pagination pagination,
                                         Sorting sorting)
                                  throws java.lang.Exception

Description copied from interface: TransferApi

Get a page of transfer's refunds

Specified by:

getRefunds in interface TransferApi

Parameters:

transferId - Transfer identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of refunds

Throws:

java.lang.Exception