com.mangopay.core.APIs

Interface ClientApi

All Known Implementing Classes:

ClientApiImpl

public interface ClientApi

Created by thepa on 18-Jan-17.

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.

Method Detail

getKycDocuments

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

Throws:

java.lang.Exception

get

Client get()
    throws java.lang.Exception

Get client information.

Returns:

Client object returned from API

Throws:

java.lang.Exception

save

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

Save client

Parameters:

client - Updated client object to save

Returns:

The updated Client from API

Throws:

java.lang.Exception

uploadLogo

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

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.

Parameters:

binaryData - Bytes of the image file

Throws:

java.lang.Exception

uploadLogo

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

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.

Parameters:

filePath - File path of the image to upload

Throws:

java.lang.Exception

getWallets

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

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

Parameters:

fundsType - One of FundsTypes

pagination - Pagination object

Returns:

List of current user's wallets

Throws:

java.lang.Exception

getWallet

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

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

Parameters:

fundsType - One of FundsTypes

currency - The particular CurrencyIso

Returns:

Wallet (fees or credit) in the specified currency

Throws:

java.lang.Exception

getWalletTransactions

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

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

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

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

View all transactions linked to your client wallets.

Parameters:

pagination - Pagination object

filter - Filtering object

sort - Sorting object

Returns:

Paginated response comprising current user's transactions

Throws:

java.lang.Exception

createBankWireDirect

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

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

Parameters:

bankWireDirect - The Bank Wire Direct details

Returns:

PayIn generated for the Bank Wire payment.

Throws:

java.lang.Exception

createBankWireDirect

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

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

Parameters:

idempotencyKey - Idempotency key

bankWireDirect - The Bank Wire Direct details

Returns:

PayIn generated for the Bank Wire payment.

Throws:

java.lang.Exception

createBankAccountIBAN

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

Throws:

java.lang.Exception

createBankAccountIBAN

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

Throws:

java.lang.Exception

createPayOut

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

Throws:

java.lang.Exception

createPayOut

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

Throws:

java.lang.Exception