com.mangopay.core.APIs.implementation

Class MandateApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.MandateApiImpl

All Implemented Interfaces:

MandateApi

public class MandateApiImpl
extends ApiBase
implements MandateApi

API for mandates.

Field Summary

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

root

Constructor Summary

Constructors

Constructor and Description
MandateApiImpl(MangoPayApi root) Instantiates new MandateApiImpl object.

Method Summary

Modifier and Type	Method and Description
Mandate	cancel(java.lang.String mandateId) Cancels mandate.
Mandate	create(Mandate mandate) Creates new mandate.
Mandate	create(java.lang.String idempotencyKey, Mandate mandate) Creates new mandate.
Mandate	get(java.lang.String mandateId) Gets mandate.
java.util.List<Mandate>	getAll(FilterMandates filters, Pagination pagination, Sorting sorting) Gets all mandates.
java.util.List<Mandate>	getForBankAccount(java.lang.String userId, java.lang.String bankAccountId, FilterMandates filters, Pagination pagination, Sorting sorting) Gets mandates for bank account.
java.util.List<Mandate>	getForUser(java.lang.String userId, FilterMandates filters, Pagination pagination, Sorting sorting) Gets mandates for user.
java.util.List<Transfer>	getTransfers(java.lang.String mandateId) Get first page of mandate's transfers
java.util.List<Transfer>	getTransfers(java.lang.String mandateId, Pagination pagination, Sorting sorting) Get page of mandate's transfers
java.util.List<Transfer>	getTransfers(java.lang.String mandateId, Pagination pagination, Sorting sorting, FilterMandates filters) Get page of mandate's transfers

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

MandateApiImpl

public MandateApiImpl(MangoPayApi root)

Instantiates new MandateApiImpl object.

Parameters:

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

Method Detail

create

public Mandate create(Mandate mandate)
               throws java.lang.Exception

Description copied from interface: MandateApi

Creates new mandate.

Specified by:

create in interface MandateApi

Parameters:

mandate - Mandate instance to be created.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

create

public Mandate create(java.lang.String idempotencyKey,
                      Mandate mandate)
               throws java.lang.Exception

Description copied from interface: MandateApi

Creates new mandate.

Specified by:

create in interface MandateApi

Parameters:

idempotencyKey - idempotency key for this request.

mandate - Mandate instance to be created.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

get

public Mandate get(java.lang.String mandateId)
            throws java.lang.Exception

Description copied from interface: MandateApi

Gets mandate.

Specified by:

get in interface MandateApi

Parameters:

mandateId - Mandate identifier.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

getAll

public java.util.List<Mandate> getAll(FilterMandates filters,
                                      Pagination pagination,
                                      Sorting sorting)
                               throws java.lang.Exception

Description copied from interface: MandateApi

Gets all mandates.

Specified by:

getAll in interface MandateApi

Parameters:

filters - Filters.

pagination - Pagination.

sorting - Sorting.

Returns:

List of Mandate instances returned from API.

Throws:

java.lang.Exception

getForUser

public java.util.List<Mandate> getForUser(java.lang.String userId,
                                          FilterMandates filters,
                                          Pagination pagination,
                                          Sorting sorting)
                                   throws java.lang.Exception

Description copied from interface: MandateApi

Gets mandates for user.

Specified by:

getForUser in interface MandateApi

Parameters:

userId - User identifier.

filters - Filters.

pagination - Pagination.

sorting - Sorting.

Returns:

List of Mandate instances returned from API.

Throws:

java.lang.Exception

getForBankAccount

public java.util.List<Mandate> getForBankAccount(java.lang.String userId,
                                                 java.lang.String bankAccountId,
                                                 FilterMandates filters,
                                                 Pagination pagination,
                                                 Sorting sorting)
                                          throws java.lang.Exception

Description copied from interface: MandateApi

Gets mandates for bank account.

Specified by:

getForBankAccount in interface MandateApi

Parameters:

userId - User identifier.

bankAccountId - Bank account identifier.

filters - Filters.

pagination - Pagination.

sorting - Sorting.

Returns:

List of Mandate instances returned from API.

Throws:

java.lang.Exception

cancel

public Mandate cancel(java.lang.String mandateId)
               throws java.lang.Exception

Description copied from interface: MandateApi

Cancels mandate.

Specified by:

cancel in interface MandateApi

Parameters:

mandateId - Mandate identifier.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

getTransfers

public java.util.List<Transfer> getTransfers(java.lang.String mandateId)
                                      throws java.lang.Exception

Description copied from interface: MandateApi

Get first page of mandate's transfers

Specified by:

getTransfers in interface MandateApi

Parameters:

mandateId - Mandate indentifier

Returns:

Collection of transfers

Throws:

java.lang.Exception

getTransfers

public java.util.List<Transfer> getTransfers(java.lang.String mandateId,
                                             Pagination pagination,
                                             Sorting sorting)
                                      throws java.lang.Exception

Description copied from interface: MandateApi

Get page of mandate's transfers

Specified by:

getTransfers in interface MandateApi

Parameters:

mandateId - Mandate identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of transfers

Throws:

java.lang.Exception

getTransfers

public java.util.List<Transfer> getTransfers(java.lang.String mandateId,
                                             Pagination pagination,
                                             Sorting sorting,
                                             FilterMandates filters)
                                      throws java.lang.Exception

Description copied from interface: MandateApi

Get page of mandate's transfers

Specified by:

getTransfers in interface MandateApi

Parameters:

mandateId - Mandate identifier

pagination - Pagination object

sorting - Sorting object

filters - Status and/or ResultCode filters

Returns:

Collection of transfers

Throws:

java.lang.Exception