com.mangopay.core.APIs

Interface InstantConversionApi

All Known Implementing Classes:

InstantConversionApiImpl

public interface InstantConversionApi

Method Summary

Modifier and Type	Method and Description
InstantConversion	createInstantConversion(InstantConversion conversion, java.lang.String idempotencyKey) This endpoint allows the platform to move funds between two wallets of different currencies instantaneously.
ConversionRate	getConversionRate(java.lang.String debitedCurrency, java.lang.String creditedCurrency) This endpoint allows the platform to get a real time indicative market rate of a specific currency pair.
InstantConversion	getInstantConversion(java.lang.String id) This endpoint allows the platform to get the details of a conversion which has been carried out.

Method Detail

getConversionRate

ConversionRate getConversionRate(java.lang.String debitedCurrency,
                                 java.lang.String creditedCurrency)
                          throws java.lang.Exception

This endpoint allows the platform to get a real time indicative market rate of a specific currency pair. The rate returned is given in real time.

Parameters:

debitedCurrency - The sell currency – the currency of the wallet to be debited

creditedCurrency - The buy currency – the currency of the wallet to be credited.

Returns:

ConversionRate object returned from API

Throws:

java.lang.Exception

createInstantConversion

InstantConversion createInstantConversion(InstantConversion conversion,
                                          java.lang.String idempotencyKey)
                                   throws java.lang.Exception

This endpoint allows the platform to move funds between two wallets of different currencies instantaneously.

Returns:

InstantConversion object returned from API

Throws:

java.lang.Exception

getInstantConversion

InstantConversion getInstantConversion(java.lang.String id)
                                throws java.lang.Exception

This endpoint allows the platform to get the details of a conversion which has been carried out.

Parameters:

id - The unique identifier of the conversion.

Returns:

InstantConversion object returned from API

Throws:

java.lang.Exception