Conversion

Convert USD to Fiat

Convert USD balance to local fiat (NGN or GHS). Optionally specify a saved bank to credit.

post/payments/convert

Request

Base URL
https://api.breet.io/v1
Auth
API key in header x-app-id and API key in header x-app-secret and API key in header X-Breet-Env
TypeScript
https://skmtc.dev/breet/apis/breet-public-api/docs/payments/convert/post.ts
A function with typed inputs. Its response is checked against the schema.

amountnumber required

Amount in USD to convert to fiat.

currency'ngn' | 'ghs' required

Target fiat currency to convert into.

bankstring

ID of a saved bank account to credit. When provided, PIN is required. Omit for conversion to wallet only.

pinstring

Transaction PIN (required when bank is provided).

{
  "amount": 100,
  "currency": "ngn",
  "bank": "69737920df8b52679a8b198e"
}

Conversion completed successfully

No recorded changes to this operation across all 3 revisions of this API.