Skip to main content
POST

Authorizations

x-app-id
string
header
required

Your application ID from the Breet dashboard

x-app-secret
string
header
required

Your application secret from the Breet dashboard

X-Breet-Env
string
header
required

Environment selector: development or production

Body

application/json
amount
number
required

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

Example:

50000

pin
string

Transaction PIN (required when withdrawalAddressId is provided).

withdrawalAddressId
string

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

Example:

"6932dc98c2ceccdea367388a"

Response

Conversion (and optional withdrawal) completed successfully