API Reference

Query FX Rate

<This endpoint allows end users query foreign exchange rate>

POST /query/v2/getForeignExchangeRate

Request params

00000

"params": {
   "currencyPair": //String, Mandatory, Currency pairs
    //Support the following values:
    // "USD/KES"
    // "EUR/KES"
    // "GBP/KES"
    // "KES/TZS"
    // "KES/UGX"
    // "KES/RWF"
    // "GBP/USD"
    // "EUR/GBP"
    // "EUR/USD"
    // "USD/CNY"
    // The above stands for BaseCurrency/QuoteCurrency
}

Initiate an FX Request

This allows customers to do Foreign Exchanges, enabling foreign currency to KES, KES to foreign currency and foreign currency to foreign currency.

POST /trans/v2/applyForFcExchange

Field	Type	Description	Is Required
sourceCurrency	string	The currency that customers want to transfer from	Mandatory
targetCurrency	string	The currency that customers want to transfer to	Mandatory
sourceAccount	string	The account that customers want to transfer from	Mandatory
targetAccount	string	The account that customers want to transfer to	Mandatory
sourceAmount	decimal	The amount of money in sourceCurrency that customers want to transfer to another currency. Either sourceAmount or targetAmount is Mandatory.	Conditional
targetAmount	decimal	The amount of money in targetCurrency that customers want to receive after foreign exchange. Either sourceAmount or targetAmount is Mandatory.	Conditional

Response

00000

"data": {
  "applicationId": "", //String, unique application id of the foreign exchange application.
}

Response Data

00000

"data": {
    "UnitAmount": 1, //Int, unit amount of the foreign currency
    "CurrencyPair": "", //String, currency pair
    "TT": { //Telegraphic Transfer rate of currency exchange
        "SELL": "136.2300", //TT Bank sell (BaseCurrency) price, 4 decimal places.
        "BUY": "135.1110" //TT Bank buy (BaseCurrency) price, 4 decimal places.
    }
}

Query FX Request Status

Use this endpoint to query the status of the FX request.

POST /query/v2/getFxRequestStatus

Request params

Field	Type	Description	Required?
applicationId	string	Unique ID for the FX request	Mandatory

Response Data

00000

"data": {
    "applicationId": , //String, unique id of the FCY exchange request.
    "sourceAcctId":"", //String, the number of the debited account
    "targetAcctId":"", //String, the number of the credited account
    "sourceCurrency":"", //String, the currency of the debited account
    "targetCurrency": "", //String, the currency of the credited account
    "sourceAmt":"", //Decimal, the exchange amount of the debited account
    "targetAmt": "",//Decimal, the exchange amount of the credit account
    "outTxId": "", //String, debit transaction id
    "inTxId": "", //String, credit transaction id
    "status": 1, //Int, 1:init, 2:wait for review, 4:reject，5:approved,6:completed, 7:failed",
    "fxRate": "",, //String, actual exchange rate, 4 decimal places
    "errorCode": "", //String, code or the faliure reason, please refer to FCY Error Code 
    "errorMsg": "" //String, reject reason
}

0026 - Foreign Exchange Notification

00000

{
    "requestId":"", //String, unique id of the notification which is generated by baas
    "sender":"", //String, sender id of baas system
    "locale":"en_KE", //String, language config
    "timestamp": //long, notification send time. UTC Unix timestamp in millisecond.
    "notificationType":"0013*", //String, notification type id
    "params": {
        "applicationId":"", //String, FX application id
        "sourceAcctId":"", //String, the number of the debited account
        "targetAcctId":"", //String, the number of the credited account
        "sourceCurrency":"", //String, the currency of the debited account
        "targetCurrency": "", //String, the currency of the credited account
        "sourceAmt":"", //Decimal, the exchange amount of the debited account
        "targetAmt": "",//Decimal, the exchange amount of the credit account
        "status":, //Int, 4-reject, 6-succeed, 7-failed
        "fxRate":"", //String, exchange rate
        "inTxId":"", //String, credit transaction id
        "outTxId":"", //String, debit transaction id
        "errorCode":"", //String, error code.
        "errorMsg":"" //String, error message. please refer to FCY error code
    },
    "salt":"", //String, salt
    "signature":"" //String, signature
}