com.mangopay.core.APIs.implementation

Class ClientApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.ClientApiImpl

All Implemented Interfaces:

ClientApi

public class ClientApiImpl
extends ApiBase
implements ClientApi

API for clients.

Field Summary

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

root

Constructor Summary

Constructors

Constructor and Description
ClientApiImpl(MangoPayApi root) Instantiates new ClientApiImpl object.

Method Summary

Modifier and Type	Method and Description
BankAccount	createBankAccountIBAN(BankAccount bankAccountIBAN)
BankAccount	createBankAccountIBAN(java.lang.String idempotencyKey, BankAccount bankAccountIBAN)
PayIn	createBankWireDirect(ClientBankWireDirect bankWireDirect) Request processing of a payment by bank wire.
PayIn	createBankWireDirect(java.lang.String idempotencyKey, ClientBankWireDirect bankWireDirect) Request processing of a payment by bank wire.
PayOut	createPayOut(PayOut payOut)
PayOut	createPayOut(java.lang.String idempotencyKey, PayOut payOut)
Client	get() Get client information.
java.util.List<KycDocument>	getKycDocuments(Pagination pagination, FilterKycDocuments filter, Sorting sort)
java.util.List<Transaction>	getTransactions(Pagination pagination, FilterTransactions filter, Sorting sort) View all transactions linked to your client wallets.
Wallet	getWallet(FundsType fundsType, CurrencyIso currency) View one of your client wallets (fees or credit) with a particular currency.
java.util.List<Wallet>	getWallets(FundsType fundsType, Pagination pagination) View your client wallets.
java.util.List<Transaction>	getWalletTransactions(FundsType fundsType, CurrencyIso currency, Pagination pagination, FilterTransactions filter, Sorting sort) View the transactions linked to your client wallets (fees and credit)
Client	save(Client client) Save client
void	uploadLogo(byte[] binaryData) Upload a logo for client.
void	uploadLogo(java.lang.String filePath) Upload a logo for client.

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

ClientApiImpl

public ClientApiImpl(MangoPayApi root)

Instantiates new ClientApiImpl object.

Parameters:

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

Method Detail

getKycDocuments

public java.util.List<KycDocument> getKycDocuments(Pagination pagination,
                                                   FilterKycDocuments filter,
                                                   Sorting sort)
                                            throws java.lang.Exception

Specified by:

getKycDocuments in interface ClientApi

Throws:

java.lang.Exception

get

public Client get()
           throws java.lang.Exception

Description copied from interface: ClientApi

Get client information.

Specified by:

get in interface ClientApi

Returns:

Client object returned from API

Throws:

java.lang.Exception

save

public Client save(Client client)
            throws java.lang.Exception

Description copied from interface: ClientApi

Save client

Specified by:

save in interface ClientApi

Parameters:

client - Updated client object to save

Returns:

The updated Client from API

Throws:

java.lang.Exception

uploadLogo

public void uploadLogo(byte[] binaryData)
                throws java.lang.Exception

Description copied from interface: ClientApi

Upload a logo for client. Only GIF, PNG, JPG, JPEG, BMP, PDF and DOC formats are accepted, and file must be less than about 7MB.

Specified by:

uploadLogo in interface ClientApi

Parameters:

binaryData - Bytes of the image file

Throws:

java.lang.Exception

uploadLogo

public void uploadLogo(java.lang.String filePath)
                throws java.lang.Exception

Description copied from interface: ClientApi

Upload a logo for client. Only GIF, PNG, JPG, JPEG, BMP, PDF and DOC formats are accepted, and file must be less than about 7MB.

Specified by:

uploadLogo in interface ClientApi

Parameters:

filePath - File path of the image to upload

Throws:

java.lang.Exception

getWallets

public java.util.List<Wallet> getWallets(FundsType fundsType,
                                         Pagination pagination)
                                  throws java.lang.Exception

Description copied from interface: ClientApi

View your client wallets. To see your fees or credit wallets for each currency set the fundsType parameter.

Specified by:

getWallets in interface ClientApi

Parameters:

fundsType - One of FundsTypes

pagination - Pagination object

Returns:

List of current user's wallets

Throws:

java.lang.Exception

getWallet

public Wallet getWallet(FundsType fundsType,
                        CurrencyIso currency)
                 throws java.lang.Exception

Description copied from interface: ClientApi

View one of your client wallets (fees or credit) with a particular currency.

Specified by:

getWallet in interface ClientApi

Parameters:

fundsType - One of FundsTypes

currency - The particular CurrencyIso

Returns:

Wallet (fees or credit) in the specified currency

Throws:

java.lang.Exception

getWalletTransactions

public java.util.List<Transaction> getWalletTransactions(FundsType fundsType,
                                                         CurrencyIso currency,
                                                         Pagination pagination,
                                                         FilterTransactions filter,
                                                         Sorting sort)
                                                  throws java.lang.Exception

Description copied from interface: ClientApi

View the transactions linked to your client wallets (fees and credit)

Specified by:

getWalletTransactions in interface ClientApi

Parameters:

fundsType - One of FundsTypes

currency - The CurrencyIso in which to convert results

pagination - Pagination object

filter - Filtering object

sort - Sorting object

Returns:

Matching transactions linked to your client wallets (fees and credit)

Throws:

java.lang.Exception

getTransactions

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

Description copied from interface: ClientApi

View all transactions linked to your client wallets.

Specified by:

getTransactions in interface ClientApi

Parameters:

pagination - Pagination object

filter - Filtering object

sort - Sorting object

Returns:

Paginated response comprising current user's transactions

Throws:

java.lang.Exception

createBankWireDirect

public PayIn createBankWireDirect(ClientBankWireDirect bankWireDirect)
                           throws java.lang.Exception

Description copied from interface: ClientApi

Request processing of a payment by bank wire. The workflow is the following:q

• Call the /payins/bankwire/direct object. You’ll receive MANGOPAY bank account details and a reference.
• Display this information to your user
• The user has to proceed a Bank wire to the display bank account with the reference
• Once MANGOPAY receive the payment the e-money is created and the targeted e-wallet is credited

Specified by:

createBankWireDirect in interface ClientApi

Parameters:

bankWireDirect - The Bank Wire Direct details

Returns:

PayIn generated for the Bank Wire payment.

Throws:

java.lang.Exception

createBankWireDirect

public PayIn createBankWireDirect(java.lang.String idempotencyKey,
                                  ClientBankWireDirect bankWireDirect)
                           throws java.lang.Exception

Description copied from interface: ClientApi

Request processing of a payment by bank wire. The workflow is the following:q

• Call the /payins/bankwire/direct object. You’ll receive MANGOPAY bank account details and a reference.
• Display this information to your user
• The user has to proceed a Bank wire to the display bank account with the reference
• Once MANGOPAY receive the payment the e-money is created and the targeted e-wallet is credited

Specified by:

createBankWireDirect in interface ClientApi

Parameters:

idempotencyKey - Idempotency key

bankWireDirect - The Bank Wire Direct details

Returns:

PayIn generated for the Bank Wire payment.

Throws:

java.lang.Exception

createBankAccountIBAN

public BankAccount createBankAccountIBAN(BankAccount bankAccountIBAN)
                                  throws java.lang.Exception

Specified by:

createBankAccountIBAN in interface ClientApi

Throws:

java.lang.Exception

createBankAccountIBAN

public BankAccount createBankAccountIBAN(java.lang.String idempotencyKey,
                                         BankAccount bankAccountIBAN)
                                  throws java.lang.Exception

Specified by:

createBankAccountIBAN in interface ClientApi

Throws:

java.lang.Exception

createPayOut

public PayOut createPayOut(PayOut payOut)
                    throws java.lang.Exception

Specified by:

createPayOut in interface ClientApi

Throws:

java.lang.Exception

createPayOut

public PayOut createPayOut(java.lang.String idempotencyKey,
                           PayOut payOut)
                    throws java.lang.Exception

Specified by:

createPayOut in interface ClientApi

Throws:

java.lang.Exception