Skip to content

Calculate Swap

GET /api-access/api/calculator/swap-calculator

Calculate currency swap fees and amounts.

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:

ParameterTypeRequiredDescription
from_currencystringYesSource currency code (e.g., xof, cad)
to_currencystringYesTarget currency code (e.g., cad, xof)
amountnumberYesAmount to swap
prioritystringYesTransaction priority (e.g., standard)
modestringYesTransaction mode (e.g., send)

Example Query:

?from_currency=xof&to_currency=cad&amount=10000&priority=standard&mode=send

Response

Success Response (200):

json
{
  "data": {
    "our_fee": 0,
    "total_fees": 0,
    "we_convert": 0,
    "partner_fee": 0,
    "exchange_rate": 0,
    "converted": 0,
    "user_pays": 0,
    "errors": [
      {
        "error_code": "OTP_ERROR",
        "suggested_receive_amount": 0,
        "suggested_receive_amount_currency": "xof",
        "suggested_values": {
          "our_fee": 0,
          "total_fees": 0,
          "we_convert": 0,
          "partner_fee": 0,
          "exchange_rate": 0,
          "converted": 0,
          "user_pays": 0
        }
      }
    ],
    "quote_id": "string",
    "enabled": true,
    "mode": "string",
    "priority": "string",
    "market_rate": 0
  },
  "success": true,
  "message": "string",
  "detail": {}
}

Response Fields:

FieldTypeDescription
our_feenumberMaraboo's fee
total_feesnumberTotal fees for the transaction
we_convertnumberAmount converted by Maraboo
partner_feenumberPartner's fee
exchange_ratenumberExchange rate applied
convertednumberConverted amount
user_paysnumberTotal amount user needs to pay
errorsarrayArray of error objects with suggestions
quote_idstringUnique quote identifier
enabledbooleanWhether the transaction is enabled
modestringTransaction mode
prioritystringTransaction priority
market_ratenumberCurrent market exchange rate

Example

bash
curl -X GET "https://sandbox.mara.boo/api-access/api/calculator/swap-calculator?from_currency=xof&to_currency=cad&amount=10000&priority=standard&mode=send" \
  -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',
  amount: '10000',
  priority: 'standard',
  mode: 'send'
});

const response = await fetch(`https://sandbox.mara.boo/api-access/api/calculator/swap-calculator?${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',
    'amount': '10000',
    'priority': 'standard',
    'mode': 'send'
}

response = requests.get(
    'https://sandbox.mara.boo/api-access/api/calculator/swap-calculator',
    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()
go
package main

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

func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://sandbox.mara.boo/api-access/api/calculator/swap-calculator?from_currency=xof&to_currency=cad&amount=10000&priority=standard&mode=send", 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/swap-calculator?from_currency=xof&to_currency=cad&amount=10000&priority=standard&mode=send"))
    .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/swap-calculator?from_currency=xof&to_currency=cad&amount=10000&priority=standard&mode=send");

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 CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid authentication
403Forbidden - Missing required headers
500Internal Server Error