Conversion

Convert Fiat to USD

Convert local fiat (NGN or GHS) balance to USD. Optionally provide a withdrawal address ID to automatically withdraw the converted USD to that address.

post/payments/fiat-to-usd

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/fiat-to-usd/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

amountnumber required

Amount in local fiat (NGN or GHS) to convert to USD.

pinstring

Transaction PIN (required when withdrawalAddressId is provided).

withdrawalAddressIdstring

ID of a saved withdrawal address. If provided, the converted USD is withdrawn to this address; PIN is required.

Example request

{
  "amount": 50000,
  "withdrawalAddressId": "6932dc98c2ceccdea367388a"
}

Response

Conversion (and optional withdrawal) completed successfully

Changes

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