Get Effective Rate

GET /api-access/api/calculator/effective-rate

Calculate effective exchange rate after fees.

Authentication

Required Headers:

Authorization: HMAC-SHA256 PUBLIC_KEY:PRIVATE_KEY
X-Origin: third-party-api
X-Timestamp: 2025-10-12T14:30:00.000Z
Content-Type: application/json

Request

Query Parameters:

Parameter	Type	Required	Description
`from_currency`	string	Yes	Source currency code (e.g., `xof`, `cad`)
`to_currency`	string	Yes	Target currency code (e.g., `cad`, `xof`)
`priority`	string	Yes	Transaction priority (e.g., `standard`)

Example Query:

?from_currency=xof&to_currency=cad&priority=standard

Response

Success Response (200):

json

{
  "data": {
    "plan_id": "string",
    "revenue_line": "string",
    "base_currency": "string",
    "target_currency": "string",
    "priority": "standard",
    "fee": {
      "revenue_line": "subscription",
      "is_active": true,
      "monthly_fee_amount": 0,
      "channel": "mobile_money",
      "base_currency": "xof",
      "target_currency": "xof",
      "maraboo_flat_fee": 0,
      "maraboo_percentage_fee": 0,
      "partner_flat_fee": 0,
      "partner_percentage_fee": 0,
      "fx_partner_percentage_fee": 0,
      "tax_percentage": 0,
      "id": "string",
      "plan_id": "string",
      "created_at": "2025-10-12T10:31:30.312Z",
      "updated_at": "2025-10-12T10:31:30.312Z"
    },
    "market_rate": 0,
    "effective_rate": 0
  },
  "success": true,
  "message": "string",
  "detail": {}
}

Response Fields:

Field	Type	Description
`plan_id`	string	Plan identifier
`revenue_line`	string	Revenue line type
`base_currency`	string	Base currency code
`target_currency`	string	Target currency code
`priority`	string	Transaction priority level
`fee`	object	Detailed fee structure object
`fee.revenue_line`	string	Fee revenue line (e.g., `subscription`)
`fee.is_active`	boolean	Whether fee is active
`fee.channel`	string	Payment channel (e.g., `mobile_money`)
`fee.maraboo_flat_fee`	number	Maraboo's flat fee
`fee.maraboo_percentage_fee`	number	Maraboo's percentage fee
`fee.partner_flat_fee`	number	Partner's flat fee
`fee.partner_percentage_fee`	number	Partner's percentage fee
`fee.fx_partner_percentage_fee`	number	FX partner's percentage fee
`fee.tax_percentage`	number	Tax percentage
`market_rate`	number	Current market exchange rate
`effective_rate`	number	Effective rate after all fees applied

Example

bash

curl -X GET "https://sandbox.mara.boo/api-access/api/calculator/effective-rate?from_currency=xof&to_currency=cad&priority=standard" \
  -H "Authorization: HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY" \
  -H "X-Origin: third-party-api" \
  -H "X-Timestamp: 2025-10-12T14:30:00.000Z" \
  -H "Content-Type: application/json"

javascript

const params = new URLSearchParams({
  from_currency: 'xof',
  to_currency: 'cad',
  priority: 'standard'
});

const response = await fetch(`https://sandbox.mara.boo/api-access/api/calculator/effective-rate?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY',
    'X-Origin': 'third-party-api',
    'X-Timestamp': '2025-10-12T14:30:00.000Z',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

python

import requests

params = {
    'from_currency': 'xof',
    'to_currency': 'cad',
    'priority': 'standard'
}

response = requests.get(
    'https://sandbox.mara.boo/api-access/api/calculator/effective-rate',
    params=params,
    headers={
        'Authorization': 'HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY',
        'X-Origin': 'third-party-api',
        'X-Timestamp': '2025-10-12T14:30:00.000Z',
        'Content-Type': 'application/json'
    }
)

data = response.json()

package main

import (
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://sandbox.mara.boo/api-access/api/calculator/effective-rate?from_currency=xof&to_currency=cad&priority=standard", nil)

    req.Header.Set("Authorization", "HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY")
    req.Header.Set("X-Origin", "third-party-api")
    req.Header.Set("X-Timestamp", "2025-10-12T14:30:00.000Z")
    req.Header.Set("Content-Type", "application/json")

    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := ioutil.ReadAll(resp.Body)
}

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.mara.boo/api-access/api/calculator/effective-rate?from_currency=xof&to_currency=cad&priority=standard"))
    .header("Authorization", "HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY")
    .header("X-Origin", "third-party-api")
    .header("X-Timestamp", "2025-10-12T14:30:00.000Z")
    .header("Content-Type", "application/json")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

csharp

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.mara.boo/api-access/api/calculator/effective-rate?from_currency=xof&to_currency=cad&priority=standard");

request.Headers.Add("Authorization", "HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY");
request.Headers.Add("X-Origin", "third-party-api");
request.Headers.Add("X-Timestamp", "2025-10-12T14:30:00.000Z");
request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");

var response = await client.SendAsync(request);
var content = await response.Content.ReadAsStringAsync();

Error Responses

Status Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid authentication
403	Forbidden - Missing required headers
500	Internal Server Error

Get Effective Rate ​

Authentication ​

Request ​

Response ​

Example ​

Error Responses ​