Quote

Create a quote for a given currency

post/quote

Request

Request body

amountnumber required

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

sourceCurrency'BTCSAT' | 'NGNKOBO' | 'USDTCENT' | 'KESCENT' string required

The source currency for the quote

targetCurrency'NGNKOBO' | 'KESCENT' | 'ZARCENT' | 'GHSPESEWA' | 'BTCSAT' | 'USDTCENT' string required

The currency to convert the source currency to

paymentMethod'LIGHTNING' | 'BANKTRANSFER' | 'ONCHAIN' | 'MOBILEMONEY' string 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.

paymentCurrency'NGNKOBO' | 'BTCSAT' | 'KESCENT' | 'ZARCENT' | 'GHSPESEWA' | 'USDTCENT' string required

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

sourceWallet'BTC' | 'USDT' | 'NGN'

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

settlementCurrency'USDT'

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

skipVirtualAccountboolean

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

customerReferencestring string

Your unique identifier for the quote

autopayoutboolean

Example request

{
  "amount": 1000,
  "paymentSource": {
    "phoneNumber": "+254796980788"
  },
  "customerReference": "order-1234567890",
  "beneficiary": {
    "bankAccountNumber": "0149203789",
    "bankAccountName": "olaolu olajide",
    "bankCode": "000013",
    "bankName": "GTBANK PLC"
  }
}

Response

Quote response

statusstring string

Example response

{
  "status": "ok",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "exchangeRate": 103830225.71866913,
    "usdToTargetCurrencyRate": 1500.65,
    "transactionFeesInSourceCurrency": 13.23,
    "transactionFeesInTargetCurrency": "3750.00",
    "amountInSourceCurrency": 1499,
    "amountInTargetCurrency": "50000.00",
    "expiry": "2021-07-01T12:00:00Z",
    "isValid": true,
    "invoice": "lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3",
    "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
    "customerReference": "order-1234567890",
    "totalAmountInSourceCurrency": 1499,
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z",
    "bankName": "WEMA BANK",
    "ngnBankAccountNumber": "7824655568",
    "ngnAccountName": "Mava Digital Solutions Limited",
    "ngnBankCode": "000027",
    "orderId": "43477-4306"
  }
}

Changes

    • warning

      added the new KESCENT enum value to the / response property for the response status

    • warning

      added the new MOBILEMONEY enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new KESCENT enum value to the request property

    • info

      added the new MOBILEMONEY enum value to the request property

    • warning

      added the new BANKTRANSFER enum value to the / response property for the response status

    • warning

      added the new BTCSAT enum value to the / response property for the response status

    • warning

      added the new ONCHAIN enum value to the / response property for the response status

    • warning

      added the new USDTCENT enum value to the / response property for the response status

    • warning

      added the new USDTCENT enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new ONCHAIN enum value to the request property

    • info

      added the new USDTCENT enum value to the request property

    • info

      added the new USDTCENT enum value to the request property

    • info

      added the new USDTCENT enum value to the request property

    • info

      added subschema #6: USDT Beneficiary to the request property oneOf list

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status