com.mangopay.core.APIs

Interface UserApi

All Known Implementing Classes:

UserApiImpl

public interface UserApi

Created by thepa on 18-Jan-17.

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.

Method Detail

get

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

Gets user.

Parameters:

userId - User identifier.

Returns:

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

Throws:

java.lang.Exception

create

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

Creates new user.

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

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

Creates new user.

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

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

Gets page of users.

Parameters:

pagination - Pagination object.

Returns:

Collection of User instances.

Throws:

java.lang.Exception

getAll

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

Gets first page of users.

Returns:

Collection of User instances.

Throws:

java.lang.Exception

getNatural

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

Gets natural user by its identifier,

Parameters:

userId - UserNatural identifier.

Returns:

UserNatural object returned from API.

Throws:

java.lang.Exception

getLegal

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

Gets legal user by its identifier.

Parameters:

userId - UserLegal identifier.

Returns:

UserLegal object returned from API.

Throws:

java.lang.Exception

update

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

Updates the user.

Parameters:

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

Returns:

Updated User object returned from API.

Throws:

java.lang.Exception

createBankAccount

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

Creates bank account for user.

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

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

Creates bank account for user.

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

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

Updates bank account.

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

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

Gets all bank accounts of user.

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

getActiveBankAccounts

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

Gets first page of all bank accounts of user.

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

getActiveBankAccounts

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

Gets all bank accounts of user.

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

getBankAccounts

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

Gets first page of all bank accounts of user.

Parameters:

userId - User identifier to get bank accounts of.

Returns:

Collection of bank accounts of user.

Throws:

java.lang.Exception

getBankAccount

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

Gets bank account of user.

Parameters:

userId - User identifier.

bankAccountId - Bank account identifier.

Returns:

Bank account object returned from API.

Throws:

java.lang.Exception

getBankAccountTransactions

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

Get first page of transactions for a bank account

Parameters:

bankAccountId - Bank account identifier

Returns:

Collection of transactions

Throws:

java.lang.Exception

getBankAccountTransactions

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

Get page of transactions fr a bank account

Parameters:

bankAccountId - Bank account identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of transactions

Throws:

java.lang.Exception

getWallets

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

Gets all wallets of user.

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

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

Gets first page of all wallets of user.

Parameters:

userId - User identifier to get bank accounts of.

Returns:

Collection of wallets of user.

Throws:

java.lang.Exception

getTransactions

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

Gets transactions for user.

Parameters:

userId - User identifier.

pagination - Pagination object.

filter - Filter object.

sorting - Sorting object.

Returns:

Collection of transactions of user.

Throws:

java.lang.Exception

getCards

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

Gets all cards for user.

Parameters:

userId - User identifier.

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of user's cards.

Throws:

java.lang.Exception

createKycPage

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

Creates KycPage from byte array.

Parameters:

userId - User identifier.

kycDocumentId - Kyc document identifier.

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

Throws:

java.lang.Exception

createKycPage

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

Creates KycPage from byte array.

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

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

Creates KycPage from file.

Parameters:

userId - User identifier.

kycDocumentId - Kyc document identifier.

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

Throws:

java.lang.Exception

createKycPage

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

Creates KycPage from file.

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

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

Creates KycDocument.

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

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

Creates KycDocument.

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

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

Gets KycDocument.

Parameters:

userId - User identifier.

kycDocumentId - KycDocument identifier.

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

updateKycDocument

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

Updates KycDocument.

Parameters:

userId - User identifier.

kycDocument - KycDocument entity instance to be updated.

Returns:

KycDocument object returned from API.

Throws:

java.lang.Exception

getKycDocuments

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

Gets all KYC documents for single user.

Parameters:

userId - User identifier.

pagination - Pagination.

sorting - Sorting object.

Returns:

List of KycDocuments returned from API.

Throws:

java.lang.Exception

getEMoney

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

Get pre authorizations for user

Parameters:

userId - User identifier

Returns:

A list of user pre authorizations

Throws:

java.lang.Exception

getPreAuthorizations

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

Get pre authorizations for user with pagination and sorting

Parameters:

userId - User identifier

pagination - Pagination

sorting - Sorting object

Returns:

A list of user pre authorizations given conditions

Throws:

java.lang.Exception

getPreAuthorizations

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

Get pre authorizations for user with pagination and sorting

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

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

Gets user block status.

Parameters:

userId - User identifier.

Returns:

User block status

Throws:

java.lang.Exception

getRegulatory

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

Gets user regulatory.

Parameters:

userId - User identifier.

Returns:

User block status

Throws:

java.lang.Exception