Skip to main content
POST

Authorizations

X-API-KEY
string
header
required

Body

application/json
amount
number<number>
required

The amount in paymentCurrency, in that currency's lowest denomination. For USDTCENT, 100 = 1 USDT. For NGNKOBO, 10000 = 100 NGN.

Example:

1000

sourceCurrency
enum<string>
default:BTCSAT
required

The source currency for the quote

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

The currency to convert the source currency to

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

The payment method for the quote. Use LIGHTNING for BTC-sourced swaps, ONCHAIN for USDT-sourced quotes, BANKTRANSFER for NGN collections, MOBILEMONEY for KES M-Pesa and Airtel collections.

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

Currency the amount is denominated in. Must be either sourceCurrency or targetCurrency. If USDTCENT, amount is in USDT cents (100 = 1 USDT).

Available options:
NGNKOBO,
BTCSAT,
KESCENT,
ZARCENT,
GHSPESEWA,
USDTCENT
paymentSource
object

Who is paying. Required when paymentMethod is MOBILEMONEY. phoneNumber must be the paying customer's number. Mavapay sends the STK prompt to this number.

sourceWallet
enum<string>

Internal wallet to debit. Required for crypto swaps and prefunded quotes. Map: BTCSAT → BTC, USDTCENT → USDT, NGNKOBO → NGN.

Available options:
BTC,
USDT,
NGN
settlementCurrency
enum<string>

Set to USDT to settle the quote from your internal USDT wallet balance.

Available options:
USDT
skipVirtualAccount
boolean
default:false

When true with sourceWallet: NGN, do not generate a virtual NGN account. Accept the quote to debit your internal NGN wallet instead.

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