Skip to main content
POST

Authorizations

X-API-KEY
string
header
required

Body

application/json
amount
number<number>
required

The amount in the target currency in its lowest denomination. e.g '500000' for 5000.00 NGN

Example:

1000

sourceCurrency
enum<string>
default:BTCSAT
required

The source currency for the quote

Available options:
BTCSAT,
NGNKOBO
targetCurrency
enum<string>
default:NGNKOBO
required

The local currency to convert the source currency to

Available options:
NGNKOBO,
KESCENT,
ZARCENT,
GHSPESEWA,
BTCSAT
paymentMethod
enum<string>
default:LIGHTNING
required

The payment method for the quote

Available options:
LIGHTNING,
BANKTRANSFER
paymentCurrency
enum<string>
required

Currency the amount is denominated in. Must be either sourceCurrency or targetCurrency. Determines what the 'amount' field represents. Example: if buying BTC with NGN and paymentCurrency is 'NGNKOBO', amount is in Naira; if 'BTCSAT', amount is in Bitcoin.

Available options:
NGNKOBO,
BTCSAT,
KESCENT,
ZARCENT,
GHSPESEWA
customerReference
string<string>

Your unique identifier for the quote

Example:

"order-1234567890"

autopayout
boolean<boolean>
default:false
Example:

false

beneficiary
NGN Beneficiary · object

Response

Quote response

status
string<string>
Example:

"ok"

data
object