Sign in
Quote

Create a quote

Create a quote for a given currency

post/quote

Request body

amountnumber required

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

sourceCurrency'BTCSAT' | 'NGNKOBO' string required

The source currency for the quote

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

The local currency to convert the source currency to

paymentMethod'LIGHTNING' | 'BANKTRANSFER' string required

The payment method for the quote

paymentCurrency'NGNKOBO' | 'BTCSAT' | 'KESCENT' | 'ZARCENT' | 'GHSPESEWA' 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.

customerReferencestring string

Your unique identifier for the quote

autopayoutboolean

Example request

{
  "amount": 1000,
  "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

Changed in 8 of the 32 revisions of this API.15447

  • 94cb0ddffad01See the full diff
    • ○

      added the new optional request property beneficiary/oneOf[subschema #2: KES Beneficiary]/identifiers/network

      new-optional-request-property

  • bd5179b97c341See the full diff
    • ○

      the autopayout request property default value changed from true to false

      request-property-default-value-changed

  • b1804285e9012110See the full diff
    • ▲

      removed the enum value KESCENT of the request property sourceCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value ZARCENT of the request property sourceCurrency

      request-property-enum-value-removed

    • ●

      added the new GHSPESEWA enum value to the data/targetCurrency response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property beneficiary/oneOf[subschema #2: KES Beneficiary]/identifiers/accountName

      new-optional-request-property

    • ○

      added the new optional request property beneficiary/oneOf[subschema #2: KES Beneficiary]/identifiers/tillNumber

      new-optional-request-property

    • ○

      added the new optional request property customerReference

      new-optional-request-property

    • ○

      added the new GHSPESEWA enum value to the request property paymentCurrency

      request-property-enum-value-added

    • ○

      added the new GHSPESEWA enum value to the request property targetCurrency

      request-property-enum-value-added

    • ○

      added the new paytotill enum value to the request property beneficiary/oneOf[subschema #2: KES Beneficiary]/identifierType

      request-property-enum-value-added

    • ○

      added subschema #3: GHS Beneficiary to the beneficiary request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property data/customerReference to the response with the 200 status

      response-optional-property-added

    • ○

      removed the KESCENT enum value from the data/sourceCurrency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ZARCENT enum value from the data/sourceCurrency response property for the response status 200

      response-property-enum-value-removed

  • 123a05fa89e95See the full diff
    • ○

      added the new BANKTRANSFER enum value to the request property paymentMethod

      request-property-enum-value-added

    • ○

      added the new BTCSAT enum value to the request property targetCurrency

      request-property-enum-value-added

    • ○

      added the new KESCENT enum value to the request property sourceCurrency

      request-property-enum-value-added

    • ○

      added the new NGNKOBO enum value to the request property sourceCurrency

      request-property-enum-value-added

    • ○

      added the new ZARCENT enum value to the request property sourceCurrency

      request-property-enum-value-added

  • 26b6661951c28See the full diff
    • ○

      added the new BTCSAT enum value to the request property paymentCurrency

      request-property-enum-value-added

    • ○

      added subschema #4: BTC Beneficiary to the beneficiary request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property data/bankName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/estimatedRoutingFee to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/ngnAccountName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/ngnBankAccountNumber to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/ngnBankCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/orderId to the response with the 200 status

      response-optional-property-added

  • 6bb4d2ebd1b913115See the full diff
    • ▲

      the request property amount became required

      request-property-became-required

    • ▲

      the request property paymentCurrency became required

      request-property-became-required

    • ▲

      removed the enum value BTC of the request property paymentCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value BTC of the request property sourceCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value BTC of the request property targetCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value KES of the request property paymentCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value KES of the request property sourceCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value KES of the request property targetCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value NGN of the request property paymentCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value NGN of the request property sourceCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value NGN of the request property targetCurrency

      request-property-enum-value-removed

    • ▲

      removed the enum value ONCHAIN of the request property paymentMethod

      request-property-enum-value-removed

    • ▲

      removed the enum value USDT of the request property paymentMethod

      request-property-enum-value-removed

    • ●

      removed the request property implicitFees

      request-property-removed

    • ○

      added the new optional request property autopayout

      new-optional-request-property

    • ○

      added the new optional request property beneficiary

      new-optional-request-property

    • ○

      the request property paymentMethod with a default value became required

      request-property-became-required-with-default

    • ○

      the request property sourceCurrency with a default value became required

      request-property-became-required-with-default

    • ○

      the request property targetCurrency with a default value became required

      request-property-became-required-with-default

    • ○

      the paymentMethod request property default value LIGHTNING was added

      request-property-default-value-added

    • ○

      the sourceCurrency request property default value BTCSAT was added

      request-property-default-value-added

    • ○

      the targetCurrency request property default value NGNKOBO was added

      request-property-default-value-added

    • ○

      added the new BTCSAT enum value to the request property sourceCurrency

      request-property-enum-value-added

    • ○

      added the new KESCENT enum value to the request property paymentCurrency

      request-property-enum-value-added

    • ○

      added the new KESCENT enum value to the request property targetCurrency

      request-property-enum-value-added

    • ○

      added the new NGNKOBO enum value to the request property paymentCurrency

      request-property-enum-value-added

    • ○

      added the new NGNKOBO enum value to the request property targetCurrency

      request-property-enum-value-added

    • ○

      added the new ZARCENT enum value to the request property paymentCurrency

      request-property-enum-value-added

    • ○

      added the new ZARCENT enum value to the request property targetCurrency

      request-property-enum-value-added

  • c220a343551226See the full diff
    • ●

      added the new ZARCENT enum value to the data/sourceCurrency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ZARCENT enum value to the data/targetCurrency response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property data/customerInternalFee to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/hash to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/invoice to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/totalAmountInSourceCurrency to the response with the 200 status

      response-optional-property-added

    • ○

      removed the ONCHAIN enum value from the data/paymentMethod response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USDT enum value from the data/paymentMethod response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9dd2ff89497c1See the full diff
    • ○

      endpoint added

      endpoint-added