com.mangopay.core.APIs

Interface MandateApi

All Known Implementing Classes:

MandateApiImpl

public interface MandateApi

Created by thepa on 18-Jan-17.

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

Method Detail

create

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

Creates new mandate.

Parameters:

mandate - Mandate instance to be created.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

create

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

Creates new mandate.

Parameters:

idempotencyKey - idempotency key for this request.

mandate - Mandate instance to be created.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

get

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

Gets mandate.

Parameters:

mandateId - Mandate identifier.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

getAll

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

Gets all mandates.

Parameters:

filters - Filters.

pagination - Pagination.

sorting - Sorting.

Returns:

List of Mandate instances returned from API.

Throws:

java.lang.Exception

getForUser

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

Gets mandates for user.

Parameters:

userId - User identifier.

filters - Filters.

pagination - Pagination.

sorting - Sorting.

Returns:

List of Mandate instances returned from API.

Throws:

java.lang.Exception

getForBankAccount

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

Gets mandates for bank account.

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

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

Cancels mandate.

Parameters:

mandateId - Mandate identifier.

Returns:

Mandate instance returned from API.

Throws:

java.lang.Exception

getTransfers

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

Get first page of mandate's transfers

Parameters:

mandateId - Mandate indentifier

Returns:

Collection of transfers

Throws:

java.lang.Exception

getTransfers

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

Get page of mandate's transfers

Parameters:

mandateId - Mandate identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of transfers

Throws:

java.lang.Exception

getTransfers

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

Get page of mandate's transfers

Parameters:

mandateId - Mandate identifier

pagination - Pagination object

sorting - Sorting object

filters - Status and/or ResultCode filters

Returns:

Collection of transfers

Throws:

java.lang.Exception