---
title: "Read a conversion"
method: GET
path: "/v1/conversions/{id}"
tags: ["Partner API"]
---

# Read a conversion

`GET /v1/conversions/{id}`

## Request

- Base URL: `https://sandbox.onlink.africa`
- URL: `https://sandbox.onlink.africa/v1/conversions/{id}`
- Auth: API key in header `X-OnLink-Key`

## Path parameters

- `id` string, required

## Response `200`

The conversion.

- PartnerConversionResponseDto
  - `id` string, required: The conversion id. Poll GET /v1/conversions/:id with it.
  - `status` 'processing' | 'settled' | 'failed', required: processing, settled or failed.
  - `from` string, required
  - `to` string, required
  - `source` string, required: The USD amount debited, 2 decimal places.
  - `target` string, 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.
  - `rate` string, nullable: KES per 1 USD you were paid at, once fixed; `target = source x rate`, rounded down to the cent.
  - `partnerReference` string, required
  - `failureReason` string, 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.
  - `createdAt` string, required
  - `settledAt` string, nullable
  - `failedAt` string, nullable

## Other responses

- `404`: CONVERSION_NOT_FOUND.

---

[API](https://skmtc.dev/onlink/apis/onlink-partner-api.md) - [All operations](https://skmtc.dev/onlink/apis/onlink-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/onlink/apis/onlink-partner-api/revisions/1d1c6a3671f2?raw)