Quotes

Quote generation

Create quote

post

/api/v1/

/quotes

Create a new quote for a money transfer transaction. The quote calculates the destination amount based on the current exchange rate and fees. Quotes have an expiration time (configured via quoteExpiryDate).

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

sender_idstring · min: 1Required

Unique identifier of the sender initiating the transfer

payout_method_idstring · min: 1Required

Unique identifier of the payout method (e.g., bank transfer, mobile money)

currency_pair_idstring · min: 1Required

Unique identifier of the currency pair for the transfer

source_amountnumberRequired

Amount to send in source currency

destination_amountnumberRequired

Expected amount to receive in destination currency. Must be within tolerance of calculated amount based on exchange rate and fees

Responses

201

Quote created successfully

application/json

400

Bad request - Invalid input data or amount mismatch

application/json

401

Unauthorized - Invalid or missing API key

404

Not found - Sender, currency pair, or payout method does not exist

application/json

500

Internal server error

post

/quotes

HTTPcURLJavaScriptPython

POST /api/v1/quotes HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "sender_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "payout_method_id": "f6e5d4c3-b2a1-4f3e-9d8c-7b6a5f4e3d2c",
  "currency_pair_id": "c9d8e7f6-a5b4-4c3d-8e7f-6a5b4c3d2e1f",
  "source_amount": 1000,
  "destination_amount": 185500
}

ZAR to UGX QuoteUGX to ZAR Quote

{
  "id": "text",
  "created_at": "2025-12-12T09:29:26.439Z",
  "updated_at": null,
  "expires_at": null,
  "sender_id": "text",
  "corridor_id": "text",
  "payout_method_id": "text",
  "source_currency_code": "text",
  "destination_currency_code": "text",
  "source_amount": 1,
  "destination_amount": 1,
  "exchange_rate": 1,
  "fee": 1
}

Get quote details

get

/api/v1/

/quotes/{quoteId}

Retrieve detailed information for a specific quote by ID. Includes exchange rate, fees, source/destination amounts and currencies, and expiration time. Quotes must be used before their expiration time.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

quoteIdstringRequired

Responses

200

Successfully retrieved quote details including exchange rate and expiry

application/json

404

Not found - Quote does not exist

application/json

get

/quotes/{quoteId}

HTTPcURLJavaScriptPython

GET /api/v1/quotes/{quoteId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "quote_id": "q1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "sender_id": "s1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
  "currency_pair_id": "cp1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
  "source_amount": 1000,
  "destination_amount": 185500,
  "source_currency": "ZAR",
  "destination_currency": "UGX",
  "exchange_rate": 185.5,
  "percentage_fee": 0.02,
  "fixed_fee": 5,
  "expires_at": "2025-11-17T11:00:00.000Z",
  "created_at": "2025-11-17T10:30:00.000Z"
}