ONonlink
Partner API

Read a conversion

get/v1/conversions/{id}

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Path parameters

idstring required

Response

The conversion.

idstring required

The conversion id. Poll GET /v1/conversions/:id with it.

status'processing' | 'settled' | 'failed' required

processing, settled or failed.

fromstring required
tostring required
sourcestring required

The USD amount debited, 2 decimal places.

targetstring nullable

The KES credited (or to be credited), once the exchange rate is fixed; null before that, and on a conversion that failed before it.

ratestring nullable

KES per 1 USD you were paid at, once fixed; target = source x rate, rounded down to the cent.

partnerReferencestring required
failureReasonstring nullable

Why a failed conversion failed: insufficient_balance, debit_refused, fx_unavailable, provider_otp_not_received or rate_moved_beyond_tolerance. Null unless status is failed. Every reason after the USD was debited means the USD was returned to you.

createdAtstring required
settledAtstring nullable
failedAtstring nullable

Example response

{
  "id": "c0a8012e-7b1a-4c39-9d3e-2f5c8a1b6d40",
  "status": "processing",
  "from": "USD",
  "to": "KES",
  "source": "100.00",
  "target": "12835.00",
  "rate": "128.35",
  "partnerReference": "payout-run-2026-10-24",
  "createdAt": "2026-10-24T10:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.