com.mangopay.core.APIs.implementation

Class UserApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.UserApiImpl

All Implemented Interfaces:

UserApi

public class UserApiImpl
extends ApiBase
implements UserApi

API for users.

Field Summary

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

root

Constructor Summary

Constructors

Constructor and Description
UserApiImpl(MangoPayApi root, com.google.gson.GsonBuilder gsonBuilder) Instantiates new UserApiImpl object.

Method Summary

Modifier and Type	Method and Description
User	create(java.lang.String idempotencyKey, User user) Creates new user.
User	create(User user) Creates new user.
BankAccount	createBankAccount(java.lang.String userId, BankAccount bankAccount) Creates bank account for user.
BankAccount	createBankAccount(java.lang.String idempotencyKey, java.lang.String userId, BankAccount bankAccount) Creates bank account for user.
KycDocument	createKycDocument(java.lang.String userId, KycDocumentType type, java.lang.String tag) Creates KycDocument.
KycDocument	createKycDocument(java.lang.String idempotencyKey, java.lang.String userId, KycDocumentType type, java.lang.String tag) Creates KycDocument.
void	createKycPage(java.lang.String userId, java.lang.String kycDocumentId, byte[] binaryData) Creates KycPage from byte array.
void	createKycPage(java.lang.String userId, java.lang.String kycDocumentId, java.lang.String filePath) Creates KycPage from file.
void	createKycPage(java.lang.String idempotencyKey, java.lang.String userId, java.lang.String kycDocumentId, byte[] binaryData) Creates KycPage from byte array.
void	createKycPage(java.lang.String idempotencyKey, java.lang.String userId, java.lang.String kycDocumentId, java.lang.String filePath) Creates KycPage from file.
User	get(java.lang.String userId) Gets user.
java.util.List<BankAccount>	getActiveBankAccounts(java.lang.String userId, boolean active) Gets first page of all bank accounts of user.
java.util.List<BankAccount>	getActiveBankAccounts(java.lang.String userId, boolean active, Pagination pagination, Sorting sorting) Gets all bank accounts of user.
java.util.List<User>	getAll() Gets first page of users.
java.util.List<User>	getAll(Pagination pagination, Sorting sorting) Gets page of users.
BankAccount	getBankAccount(java.lang.String userId, java.lang.String bankAccountId) Gets bank account of user.
java.util.List<BankAccount>	getBankAccounts(java.lang.String userId) Gets first page of all bank accounts of user.
java.util.List<BankAccount>	getBankAccounts(java.lang.String userId, Pagination pagination, Sorting sorting) Gets all bank accounts of user.
java.util.List<Transaction>	getBankAccountTransactions(java.lang.String bankAccountId) Get first page of transactions for a bank account
java.util.List<Transaction>	getBankAccountTransactions(java.lang.String bankAccountId, Pagination pagination, Sorting sorting) Get page of transactions fr a bank account
UserBlockStatus	getBlockStatus(java.lang.String userId) Gets user block status.
java.util.List<Card>	getCards(java.lang.String userId, Pagination pagination, Sorting sorting) Gets all cards for user.
EMoney	getEMoney(java.lang.String userId, java.lang.String year) Shows the e-money cash-in/cash-out amounts for a particular user.
EMoney	getEMoney(java.lang.String userId, java.lang.String year, CurrencyIso currencyIso) Shows the e-money cash-in/cash-out amounts for a particular user.
EMoney	getEMoney(java.lang.String userId, java.lang.String year, java.lang.String month) Shows the e-money cash-in/cash-out amounts for a particular user.
EMoney	getEMoney(java.lang.String userId, java.lang.String year, java.lang.String month, CurrencyIso currencyIso) Shows the e-money cash-in/cash-out amounts for a particular user.
KycDocument	getKycDocument(java.lang.String userId, java.lang.String kycDocumentId) Gets KycDocument.
java.util.List<KycDocument>	getKycDocuments(java.lang.String userId, Pagination pagination, Sorting sorting) Gets all KYC documents for single user.
UserLegal	getLegal(java.lang.String userId) Gets legal user by its identifier.
UserNatural	getNatural(java.lang.String userId) Gets natural user by its identifier,
java.util.List<CardPreAuthorization>	getPreAuthorizations(java.lang.String userId) Get pre authorizations for user
java.util.List<CardPreAuthorization>	getPreAuthorizations(java.lang.String userId, Pagination pagination, FilterPreAuthorizations filter, Sorting sorting) Get pre authorizations for user with pagination and sorting
java.util.List<CardPreAuthorization>	getPreAuthorizations(java.lang.String userId, Pagination pagination, Sorting sorting) Get pre authorizations for user with pagination and sorting
UserBlockStatus	getRegulatory(java.lang.String userId) Gets user regulatory.
java.util.List<Transaction>	getTransactions(java.lang.String userId, Pagination pagination, FilterTransactions filter, Sorting sorting) Gets transactions for user.
java.util.List<Wallet>	getWallets(java.lang.String userId) Gets first page of all wallets of user.
java.util.List<Wallet>	getWallets(java.lang.String userId, Pagination pagination, Sorting sorting) Gets all wallets of user.
User	update(User user) Updates the user.
BankAccount	updateBankAccount(java.lang.String userId, BankAccount bankAccount, java.lang.String bankAccountId) Updates bank account.
KycDocument	updateKycDocument(java.lang.String userId, KycDocument kycDocument) Updates KycDocument.

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

UserApiImpl

public UserApiImpl(MangoPayApi root,
                   com.google.gson.GsonBuilder gsonBuilder)

Instantiates new UserApiImpl object.

Parameters:

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

Method Detail

get

public User get(java.lang.String userId)
         throws java.lang.Exception

Description copied from interface: UserApi

Gets user.

Specified by:

get in interface UserApi

Parameters:

userId - User identifier.

Returns:

User instance returned from API, which is either of UserNatural or UserLegal type.

Throws:

java.lang.Exception

create

public User create(User user)
            throws java.lang.Exception

Description copied from interface: UserApi

Creates new user.

Specified by:

create in interface UserApi

Parameters:

user - User object to be created.

Returns:

User instance returned from API, which is either of UserNatural or UserLegal type.

Throws:

java.lang.Exception

create

public User create(java.lang.String idempotencyKey,
                   User user)
            throws java.lang.Exception

Description copied from interface: UserApi

Creates new user.

Specified by:

create in interface UserApi

Parameters:

idempotencyKey - idempotency key for this request.

user - User object to be created.

Returns:

User instance returned from API, which is either of UserNatural or UserLegal type.

Throws:

java.lang.Exception

getAll

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

Description copied from interface: UserApi

Gets page of users.

Specified by:

getAll in interface UserApi

Parameters:

pagination - Pagination object.

Returns:

Collection of User instances.

Throws:

java.lang.Exception

getAll

public java.util.List<User> getAll()
                            throws java.lang.Exception

Description copied from interface: UserApi

Gets first page of users.

Specified by:

getAll in interface UserApi

Returns:

Collection of User instances.

Throws:

java.lang.Exception

getNatural

public UserNatural getNatural(java.lang.String userId)
                       throws java.lang.Exception

Description copied from interface: UserApi

Gets natural user by its identifier,

Specified by:

getNatural in interface UserApi

Parameters:

userId - UserNatural identifier.

Returns:

UserNatural object returned from API.

Throws:

java.lang.Exception

getLegal

public UserLegal getLegal(java.lang.String userId)
                   throws java.lang.Exception

Description copied from interface: UserApi

Gets legal user by its identifier.

Specified by:

getLegal in interface UserApi

Parameters:

userId - UserLegal identifier.

Returns:

UserLegal object returned from API.

Throws:

java.lang.Exception

update

public User update(User user)
            throws java.lang.Exception

Description copied from interface: UserApi

Updates the user.

Specified by:

update in interface UserApi

Parameters:

user - Instance of UserNatural or UserLegal class to be updated.

Returns:

Updated User object returned from API.

Throws:

java.lang.Exception

createBankAccount

public BankAccount createBankAccount(java.lang.String userId,
                                     BankAccount bankAccount)
                              throws java.lang.Exception

Description copied from interface: UserApi

Creates bank account for user.

Specified by:

createBankAccount in interface UserApi

Parameters:

userId - User identifier to create bank account for.

bankAccount - Bank account object.

Returns:

Created bank account object returned from API.

Throws:

java.lang.Exception

createBankAccount

public BankAccount createBankAccount(java.lang.String idempotencyKey,
                                     java.lang.String userId,
                                     BankAccount bankAccount)
                              throws java.lang.Exception

Description copied from interface: UserApi

Creates bank account for user.

Specified by:

createBankAccount in interface UserApi

Parameters:

idempotencyKey - idempotency key for this request.

userId - User identifier to create bank account for.

bankAccount - Bank account object.

Returns:

Created bank account object returned from API.

Throws:

java.lang.Exception

updateBankAccount

public BankAccount updateBankAccount(java.lang.String userId,
                                     BankAccount bankAccount,
                                     java.lang.String bankAccountId)
                              throws java.lang.Exception

Description copied from interface: UserApi

Updates bank account.

Specified by:

updateBankAccount in interface UserApi

Parameters:

userId - User identifier.

bankAccount - Bank account object.

bankAccountId - Bank account identifier.

Returns:

Updated bank account object returned from API.

Throws:

java.lang.Exception

getBankAccounts

public java.util.List<BankAccount> getBankAccounts(java.lang.String userId,
                                                   Pagination pagination,
                                                   Sorting sorting)
                                            throws java.lang.Exception

Description copied from interface: UserApi

Gets all bank accounts of user.

Specified by:

getBankAccounts in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of bank accounts of user.

Throws:

java.lang.Exception

getBankAccounts

public java.util.List<BankAccount> getBankAccounts(java.lang.String userId)
                                            throws java.lang.Exception

Description copied from interface: UserApi

Gets first page of all bank accounts of user.

Specified by:

getBankAccounts in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

Returns:

Collection of bank accounts of user.

Throws:

java.lang.Exception

getActiveBankAccounts

public java.util.List<BankAccount> getActiveBankAccounts(java.lang.String userId,
                                                         boolean active,
                                                         Pagination pagination,
                                                         Sorting sorting)
                                                  throws java.lang.Exception

Description copied from interface: UserApi

Gets all bank accounts of user.

Specified by:

getActiveBankAccounts in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

active - Identifier if the returned list should contain only active accounts.

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of bank accounts of user.

Throws:

java.lang.Exception

getActiveBankAccounts

public java.util.List<BankAccount> getActiveBankAccounts(java.lang.String userId,
                                                         boolean active)
                                                  throws java.lang.Exception

Description copied from interface: UserApi

Gets first page of all bank accounts of user.

Specified by:

getActiveBankAccounts in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

active - Identifier if the returned list should contain only active accounts.

Returns:

Collection of bank accounts of user.

Throws:

java.lang.Exception

getBankAccount

public BankAccount getBankAccount(java.lang.String userId,
                                  java.lang.String bankAccountId)
                           throws java.lang.Exception

Description copied from interface: UserApi

Gets bank account of user.

Specified by:

getBankAccount in interface UserApi

Parameters:

userId - User identifier.

bankAccountId - Bank account identifier.

Returns:

Bank account object returned from API.

Throws:

java.lang.Exception

getBankAccountTransactions

public java.util.List<Transaction> getBankAccountTransactions(java.lang.String bankAccountId)
                                                       throws java.lang.Exception

Description copied from interface: UserApi

Get first page of transactions for a bank account

Specified by:

getBankAccountTransactions in interface UserApi

Parameters:

bankAccountId - Bank account identifier

Returns:

Collection of transactions

Throws:

java.lang.Exception

getBankAccountTransactions

public java.util.List<Transaction> getBankAccountTransactions(java.lang.String bankAccountId,
                                                              Pagination pagination,
                                                              Sorting sorting)
                                                       throws java.lang.Exception

Description copied from interface: UserApi

Get page of transactions fr a bank account

Specified by:

getBankAccountTransactions in interface UserApi

Parameters:

bankAccountId - Bank account identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of transactions

Throws:

java.lang.Exception

getWallets

public java.util.List<Wallet> getWallets(java.lang.String userId,
                                         Pagination pagination,
                                         Sorting sorting)
                                  throws java.lang.Exception

Description copied from interface: UserApi

Gets all wallets of user.

Specified by:

getWallets in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of wallets of user.

Throws:

java.lang.Exception

getWallets

public java.util.List<Wallet> getWallets(java.lang.String userId)
                                  throws java.lang.Exception

Description copied from interface: UserApi

Gets first page of all wallets of user.

Specified by:

getWallets in interface UserApi

Parameters:

userId - User identifier to get bank accounts of.

Returns:

Collection of wallets of user.

Throws:

java.lang.Exception

getTransactions

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

Description copied from interface: UserApi

Gets transactions for user.

Specified by:

getTransactions in interface UserApi

Parameters:

userId - User identifier.

pagination - Pagination object.

filter - Filter object.

sorting - Sorting object.

Returns:

Collection of transactions of user.

Throws:

java.lang.Exception

getCards

public java.util.List<Card> getCards(java.lang.String userId,
                                     Pagination pagination,
                                     Sorting sorting)
                              throws java.lang.Exception

Description copied from interface: UserApi

Gets all cards for user.

Specified by:

getCards in interface UserApi

Parameters:

userId - User identifier.

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of user's cards.

Throws:

java.lang.Exception

createKycPage

public void createKycPage(java.lang.String userId,
                          java.lang.String kycDocumentId,
                          byte[] binaryData)
                   throws java.lang.Exception

Description copied from interface: UserApi

Creates KycPage from byte array.

Specified by:

createKycPage in interface UserApi

Parameters:

userId - User identifier.

kycDocumentId - Kyc document identifier.

binaryData - The byte array the KycPage will be created from.

Throws:

java.lang.Exception

createKycPage

public void createKycPage(java.lang.String idempotencyKey,
                          java.lang.String userId,
                          java.lang.String kycDocumentId,
                          byte[] binaryData)
                   throws java.lang.Exception

Description copied from interface: UserApi

Creates KycPage from byte array.

Specified by:

createKycPage in interface UserApi

Parameters:

idempotencyKey - idempotency key for this request.

userId - User identifier.

kycDocumentId - Kyc document identifier.

binaryData - The byte array the KycPage will be created from.

Throws:

java.lang.Exception

createKycPage

public void createKycPage(java.lang.String userId,
                          java.lang.String kycDocumentId,
                          java.lang.String filePath)
                   throws java.lang.Exception

Description copied from interface: UserApi

Creates KycPage from file.

Specified by:

createKycPage in interface UserApi

Parameters:

userId - User identifier.

kycDocumentId - Kyc document identifier.

filePath - Path to the file the KycPage will be created from.

Throws:

java.lang.Exception

createKycPage

public void createKycPage(java.lang.String idempotencyKey,
                          java.lang.String userId,
                          java.lang.String kycDocumentId,
                          java.lang.String filePath)
                   throws java.lang.Exception

Description copied from interface: UserApi

Creates KycPage from file.

Specified by:

createKycPage in interface UserApi

Parameters:

idempotencyKey - idempotency key for this request.

userId - User identifier.

kycDocumentId - Kyc document identifier.

filePath - Path to the file the KycPage will be created from.

Throws:

java.lang.Exception

createKycDocument

public KycDocument createKycDocument(java.lang.String userId,
                                     KycDocumentType type,
                                     java.lang.String tag)
                              throws java.lang.Exception

Description copied from interface: UserApi

Creates KycDocument.

Specified by:

createKycDocument in interface UserApi

Parameters:

userId - User identifier.

type - Type of KycDocument.

tag - Custom data that you can add to this item

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

createKycDocument

public KycDocument createKycDocument(java.lang.String idempotencyKey,
                                     java.lang.String userId,
                                     KycDocumentType type,
                                     java.lang.String tag)
                              throws java.lang.Exception

Description copied from interface: UserApi

Creates KycDocument.

Specified by:

createKycDocument in interface UserApi

Parameters:

idempotencyKey - idempotency key for this request.

userId - User identifier.

type - Type of KycDocument.

tag - Custom data that you can add to this item

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

getKycDocument

public KycDocument getKycDocument(java.lang.String userId,
                                  java.lang.String kycDocumentId)
                           throws java.lang.Exception

Description copied from interface: UserApi

Gets KycDocument.

Specified by:

getKycDocument in interface UserApi

Parameters:

userId - User identifier.

kycDocumentId - KycDocument identifier.

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

updateKycDocument

public KycDocument updateKycDocument(java.lang.String userId,
                                     KycDocument kycDocument)
                              throws java.lang.Exception

Description copied from interface: UserApi

Updates KycDocument.

Specified by:

updateKycDocument in interface UserApi

Parameters:

userId - User identifier.

kycDocument - KycDocument entity instance to be updated.

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

getKycDocuments

public java.util.List<KycDocument> getKycDocuments(java.lang.String userId,
                                                   Pagination pagination,
                                                   Sorting sorting)
                                            throws java.lang.Exception

Description copied from interface: UserApi

Gets all KYC documents for single user.

Specified by:

getKycDocuments in interface UserApi

Parameters:

userId - User identifier.

pagination - Pagination.

sorting - Sorting object.

Returns:

List of KycDocuments returned from API.

Throws:

java.lang.Exception

getEMoney

public EMoney getEMoney(java.lang.String userId,
                        java.lang.String year)
                 throws java.lang.Exception

Description copied from interface: UserApi

Shows the e-money cash-in/cash-out amounts for a particular user. Result will be in EUR due to lack of a specified currency.

Specified by:

getEMoney in interface UserApi

Parameters:

userId - Id of the user whose e-money data to get.

year - The year for which we want to get the e-money data.

Returns:

EMoney data for the specified user.

Throws:

java.lang.Exception

getEMoney

public EMoney getEMoney(java.lang.String userId,
                        java.lang.String year,
                        java.lang.String month)
                 throws java.lang.Exception

Description copied from interface: UserApi

Shows the e-money cash-in/cash-out amounts for a particular user. Result will be in EUR due to lack of a specified currency.

Specified by:

getEMoney in interface UserApi

Parameters:

userId - Id of the user whose e-money data to get.

year - The year for which we want to get the e-money data.

month - The month for which we want to get the e-money data.

Returns:

EMoney data for the specified user.

Throws:

java.lang.Exception

getEMoney

public EMoney getEMoney(java.lang.String userId,
                        java.lang.String year,
                        CurrencyIso currencyIso)
                 throws java.lang.Exception

Description copied from interface: UserApi

Shows the e-money cash-in/cash-out amounts for a particular user. The Currency parameter can be used to have the amounts specified in a certain currency.

Specified by:

getEMoney in interface UserApi

Parameters:

userId - Id of the user whose e-money data to get.

year - The year for which we want to get the e-money data.

currencyIso - Currency in which to format money amounts. If null, will be considered as EUR.

Returns:

EMoney data for the specified user.

Throws:

java.lang.Exception

getEMoney

public EMoney getEMoney(java.lang.String userId,
                        java.lang.String year,
                        java.lang.String month,
                        CurrencyIso currencyIso)
                 throws java.lang.Exception

Description copied from interface: UserApi

Shows the e-money cash-in/cash-out amounts for a particular user. The Currency parameter can be used to have the amounts specified in a certain currency.

Specified by:

getEMoney in interface UserApi

Parameters:

userId - Id of the user whose e-money data to get.

year - The year for which we want to get the e-money data.

month - The month for which we want to get the e-money data.

currencyIso - Currency in which to format money amounts. If null, will be considered as EUR.

Returns:

EMoney data for the specified user.

Throws:

java.lang.Exception

getPreAuthorizations

public java.util.List<CardPreAuthorization> getPreAuthorizations(java.lang.String userId)
                                                          throws java.lang.Exception

Description copied from interface: UserApi

Get pre authorizations for user

Specified by:

getPreAuthorizations in interface UserApi

Parameters:

userId - User identifier

Returns:

A list of user pre authorizations

Throws:

java.lang.Exception

getPreAuthorizations

public java.util.List<CardPreAuthorization> getPreAuthorizations(java.lang.String userId,
                                                                 Pagination pagination,
                                                                 Sorting sorting)
                                                          throws java.lang.Exception

Description copied from interface: UserApi

Get pre authorizations for user with pagination and sorting

Specified by:

getPreAuthorizations in interface UserApi

Parameters:

userId - User identifier

pagination - Pagination

sorting - Sorting object

Returns:

A list of user pre authorizations given conditions

Throws:

java.lang.Exception

getPreAuthorizations

public java.util.List<CardPreAuthorization> getPreAuthorizations(java.lang.String userId,
                                                                 Pagination pagination,
                                                                 FilterPreAuthorizations filter,
                                                                 Sorting sorting)
                                                          throws java.lang.Exception

Description copied from interface: UserApi

Get pre authorizations for user with pagination and sorting

Specified by:

getPreAuthorizations in interface UserApi

Parameters:

userId - User identifier

pagination - Pagination

filter - PreAuthorization filters

sorting - Sorting object

Returns:

A list of user pre authorizations given conditions

Throws:

java.lang.Exception

getBlockStatus

public UserBlockStatus getBlockStatus(java.lang.String userId)
                               throws java.lang.Exception

Description copied from interface: UserApi

Gets user block status.

Specified by:

getBlockStatus in interface UserApi

Parameters:

userId - User identifier.

Returns:

User block status

Throws:

java.lang.Exception

getRegulatory

public UserBlockStatus getRegulatory(java.lang.String userId)
                              throws java.lang.Exception

Description copied from interface: UserApi

Gets user regulatory.

Specified by:

getRegulatory in interface UserApi

Parameters:

userId - User identifier.

Returns:

User block status

Throws:

java.lang.Exception