Payments

Swap Fiat Currency

Swap fiat balance between NGN and GHS in either direction. The from and to currencies must be different.

post/payments/swap-currency

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

amountnumber required

Amount in the from currency to swap.

from'ngn' | 'ghs' required

Currency to swap from. Must differ from to.

to'ngn' | 'ghs' required

Currency to swap into. Must differ from from.

pinstring required

Transaction PIN.

{
  "amount": 5000,
  "from": "ngn",
  "to": "ghs",
  "pin": "1234"
}

Swap completed successfully

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