com.mangopay.core.APIs

Interface WalletApi

All Known Implementing Classes:

WalletApiImpl

public interface WalletApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
Wallet	create(java.lang.String idempotencyKey, Wallet wallet) Creates a new wallet.
Wallet	create(Wallet wallet) Creates a new wallet.
Wallet	get(java.lang.String walletId) Gets the wallet.
java.util.List<Transaction>	getTransactions(java.lang.String walletId) Gets transactions for the wallet.
java.util.List<Transaction>	getTransactions(java.lang.String walletId, Pagination pagination) Gets transactions for the wallet.
java.util.List<Transaction>	getTransactions(java.lang.String walletId, Pagination pagination, FilterTransactions filter) Gets transactions for the wallet.
java.util.List<Transaction>	getTransactions(java.lang.String walletId, Pagination pagination, FilterTransactions filter, Sorting sorting) Gets transactions for the wallet.
Wallet	update(Wallet wallet) Updates the wallet.

Method Detail

create

Wallet create(Wallet wallet)
       throws java.lang.Exception

Creates a new wallet.

Parameters:

wallet - Wallet instance to be created.

Returns:

Wallet instance returned from API.

Throws:

java.lang.Exception

create

Wallet create(java.lang.String idempotencyKey,
              Wallet wallet)
       throws java.lang.Exception

Creates a new wallet.

Parameters:

idempotencyKey - idempotency key for this request.

wallet - Wallet instance to be created.

Returns:

Wallet instance returned from API.

Throws:

java.lang.Exception

get

Wallet get(java.lang.String walletId)
    throws java.lang.Exception

Gets the wallet.

Parameters:

walletId - Wallet identifier.

Returns:

Wallet instance returned from API.

Throws:

java.lang.Exception

update

Wallet update(Wallet wallet)
       throws java.lang.Exception

Updates the wallet.

Parameters:

wallet - Wallet object to save.

Returns:

Wallet instance returned from API.

Throws:

java.lang.Exception

getTransactions

java.util.List<Transaction> getTransactions(java.lang.String walletId,
                                            Pagination pagination,
                                            FilterTransactions filter,
                                            Sorting sorting)
                                     throws java.lang.Exception

Gets transactions for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object.

filter - Object to filter data.

Returns:

Transactions for wallet returned from API.

Throws:

java.lang.Exception

getTransactions

java.util.List<Transaction> getTransactions(java.lang.String walletId,
                                            Pagination pagination,
                                            FilterTransactions filter)
                                     throws java.lang.Exception

Gets transactions for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object.

filter - Object to filter data.

Returns:

Transactions for wallet returned from API.

Throws:

java.lang.Exception

getTransactions

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

Gets transactions for the wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination object.

Returns:

Transactions for wallet returned from API.

Throws:

java.lang.Exception

getTransactions

java.util.List<Transaction> getTransactions(java.lang.String walletId)
                                     throws java.lang.Exception

Gets transactions for the wallet.

Parameters:

walletId - Wallet identifier.

Returns:

Transactions for wallet returned from API.

Throws:

java.lang.Exception