public interface MandateApi
| 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
|
Mandate create(Mandate mandate) throws java.lang.Exception
mandate - Mandate instance to be created.java.lang.ExceptionMandate create(java.lang.String idempotencyKey, Mandate mandate) throws java.lang.Exception
idempotencyKey - idempotency key for this request.mandate - Mandate instance to be created.java.lang.ExceptionMandate get(java.lang.String mandateId) throws java.lang.Exception
mandateId - Mandate identifier.java.lang.Exceptionjava.util.List<Mandate> getAll(FilterMandates filters, Pagination pagination, Sorting sorting) throws java.lang.Exception
filters - Filters.pagination - Pagination.sorting - Sorting.java.lang.Exceptionjava.util.List<Mandate> getForUser(java.lang.String userId, FilterMandates filters, Pagination pagination, Sorting sorting) throws java.lang.Exception
userId - User identifier.filters - Filters.pagination - Pagination.sorting - Sorting.java.lang.Exceptionjava.util.List<Mandate> getForBankAccount(java.lang.String userId, java.lang.String bankAccountId, FilterMandates filters, Pagination pagination, Sorting sorting) throws java.lang.Exception
userId - User identifier.bankAccountId - Bank account identifier.filters - Filters.pagination - Pagination.sorting - Sorting.java.lang.ExceptionMandate cancel(java.lang.String mandateId) throws java.lang.Exception
mandateId - Mandate identifier.java.lang.Exceptionjava.util.List<Transfer> getTransfers(java.lang.String mandateId) throws java.lang.Exception
mandateId - Mandate indentifierjava.lang.Exceptionjava.util.List<Transfer> getTransfers(java.lang.String mandateId, Pagination pagination, Sorting sorting) throws java.lang.Exception
mandateId - Mandate identifierpagination - Pagination objectsorting - Sorting objectjava.lang.Exceptionjava.util.List<Transfer> getTransfers(java.lang.String mandateId, Pagination pagination, Sorting sorting, FilterMandates filters) throws java.lang.Exception
mandateId - Mandate identifierpagination - Pagination objectsorting - Sorting objectfilters - Status and/or ResultCode filtersjava.lang.Exception