com.mangopay.core.APIs

Interface BankingAliasApi

All Known Implementing Classes:

BankingAliasApiImpl

public interface BankingAliasApi

API declaration for banking aliases.

Method Summary

Modifier and Type	Method and Description
BankingAlias	create(java.lang.String walletId, BankingAlias bankingAlias) Creates a new banking alias.
BankingAlias	create(java.lang.String idempotencyKey, java.lang.String walletId, BankingAlias bankingAlias) Creates a new banking alias.
BankingAlias	deactivate(java.lang.String bankingAliasId, BankingAlias bankingAlias) Deactivates a banking alias.
BankingAlias	get(java.lang.String bankingAliasId) Gets the banking alias.
java.util.List<BankingAlias>	listForWallet(java.lang.String walletId) Gets banking aliases for the wallet.
java.util.List<BankingAlias>	listForWallet(java.lang.String walletId, Pagination pagination) Gets banking aliases for the wallet.
java.util.List<BankingAlias>	listForWallet(java.lang.String walletId, Pagination pagination, FilterBankingAlias filter) Gets banking aliases for the wallet.
java.util.List<BankingAlias>	listForWallet(java.lang.String walletId, Pagination pagination, FilterBankingAlias filter, Sorting sorting) Gets banking aliases for the wallet.

Method Detail

create

BankingAlias create(java.lang.String walletId,
                    BankingAlias bankingAlias)
             throws java.lang.Exception

Creates a new banking alias.

Parameters:

bankingAlias - Banking alias instance to be created.

walletId - ID of the wallet for which the alias is being created.

Returns:

Banking alias instance returned from API.

Throws:

java.lang.Exception

create

BankingAlias create(java.lang.String idempotencyKey,
                    java.lang.String walletId,
                    BankingAlias bankingAlias)
             throws java.lang.Exception

Creates a new banking alias.

Parameters:

idempotencyKey - Idempotency key for this request.

walletId - ID of the wallet for which the alias is being created.

bankingAlias - Banking alias instance to be created.

Returns:

Banking alias instance returned from API.

Throws:

java.lang.Exception

get

BankingAlias get(java.lang.String bankingAliasId)
          throws java.lang.Exception

Gets the banking alias.

Parameters:

bankingAliasId - Banking alias identifier.

Returns:

Banking alias instance returned from API.

Throws:

java.lang.Exception

listForWallet

java.util.List<BankingAlias> listForWallet(java.lang.String walletId,
                                           Pagination pagination,
                                           FilterBankingAlias filter,
                                           Sorting sorting)
                                    throws java.lang.Exception

Gets banking aliases for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object

filter - Object to filter data.

sorting - Object to sort data.

Returns:

Banking aliases for wallet returned from API.

Throws:

java.lang.Exception

listForWallet

java.util.List<BankingAlias> listForWallet(java.lang.String walletId,
                                           Pagination pagination,
                                           FilterBankingAlias filter)
                                    throws java.lang.Exception

Gets banking aliases for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object

filter - Object to filter data.

Returns:

Banking aliases for wallet returned from API.

Throws:

java.lang.Exception

listForWallet

java.util.List<BankingAlias> listForWallet(java.lang.String walletId,
                                           Pagination pagination)
                                    throws java.lang.Exception

Gets banking aliases for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object

Returns:

Banking aliases for wallet returned from API.

Throws:

java.lang.Exception

listForWallet

java.util.List<BankingAlias> listForWallet(java.lang.String walletId)
                                    throws java.lang.Exception

Gets banking aliases for the wallet.

Parameters:

walletId - Wallet identifier.

Returns:

Banking aliases for wallet returned from API.

Throws:

java.lang.Exception

deactivate

BankingAlias deactivate(java.lang.String bankingAliasId,
                        BankingAlias bankingAlias)
                 throws java.lang.Exception

Deactivates a banking alias.

Parameters:

bankingAliasId - ID of the banking alias to be deactivated.

bankingAlias - Banking alias locally marked as deactivated.

Returns:

Throws:

java.lang.Exception