Get quote

Create a quote

curl --request POST \
  --url https://staging.api.mavapay.co/api/v1/quote \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": 1000,
  "sourceCurrency": "BTCSAT",
  "targetCurrency": "NGNKOBO",
  "paymentMethod": "LIGHTNING",
  "paymentCurrency": "NGNKOBO",
  "autopayout": true,
  "beneficiary": {
    "bankAccountNumber": "0149203789",
    "bankAccountName": "olaolu olajide",
    "bankCode": "000013",
    "bankName": "GTBANK PLC"
  }
}
'

{
  "status": "success",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "exchangeRate": 5000000.23,
    "usdToTargetCurrencyRate": 1500.65,
    "sourceCurrency": "BTCSAT",
    "targetCurrency": "NGNKOBO",
    "transactionFeesInSourceCurrency": 13.23,
    "transactionFeesInTargetCurrency": "3750.00",
    "amountInSourceCurrency": 1499,
    "amountInTargetCurrency": "50000.00",
    "paymentMethod": "LIGHTNING",
    "expiry": "2021-07-01T12:00:00Z",
    "isValid": true,
    "invoice": "lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3",
    "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
    "totalAmountInSourceCurrency": 1499,
    "customerInternalFee": 0,
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z"
  }
}

POST

quote

Create a quote

curl --request POST \
  --url https://staging.api.mavapay.co/api/v1/quote \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": 1000,
  "sourceCurrency": "BTCSAT",
  "targetCurrency": "NGNKOBO",
  "paymentMethod": "LIGHTNING",
  "paymentCurrency": "NGNKOBO",
  "autopayout": true,
  "beneficiary": {
    "bankAccountNumber": "0149203789",
    "bankAccountName": "olaolu olajide",
    "bankCode": "000013",
    "bankName": "GTBANK PLC"
  }
}
'

{
  "status": "success",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "exchangeRate": 5000000.23,
    "usdToTargetCurrencyRate": 1500.65,
    "sourceCurrency": "BTCSAT",
    "targetCurrency": "NGNKOBO",
    "transactionFeesInSourceCurrency": 13.23,
    "transactionFeesInTargetCurrency": "3750.00",
    "amountInSourceCurrency": 1499,
    "amountInTargetCurrency": "50000.00",
    "paymentMethod": "LIGHTNING",
    "expiry": "2021-07-01T12:00:00Z",
    "isValid": true,
    "invoice": "lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3",
    "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
    "totalAmountInSourceCurrency": 1499,
    "customerInternalFee": 0,
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z"
  }
}

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

targetCurrency

enum<string>

default:NGNKOBO

required

The local currency to convert the source currency to

Available options:

NGNKOBO,

KESCENT,

ZARCENT

paymentMethod

enum<string>

default:LIGHTNING

required

The payment method for the quote

Available options:

LIGHTNING

paymentCurrency

enum<string>

required

Available options:

NGNKOBO,

KESCENT,

ZARCENT

autopayout

boolean<boolean>

default:true

Example:

true

beneficiary

NGN Beneficiary · object

NGN Beneficiary
KES Beneficiary
ZAR Beneficiary

Show child attributes

beneficiary.bankAccountNumber

string

required

The bank account number of the beneficiary

Example:

"0149203789"

beneficiary.bankAccountName

string

required

The name of the beneficiary

Example:

"olaolu olajide"

beneficiary.bankCode

string

required

The bank code of the beneficiary

Example:

"000013"

beneficiary.bankName

string

required

The name of the bank of the beneficiary

Example:

"GTBANK PLC"

Response

Quote response

status

string<string>

Example:

"success"

data

object

Show child attributes

data.id

string<uuid>

Example:

"d1614a76-9c7f-4111-98a7-43199f307e5b"

data.exchangeRate

number<number>

The exchange rate of source currency to target currency for the quote. e.g 1 BTC = 5000000.23 NGN

Example:

5000000.23

data.usdToTargetCurrencyRate

number<number>

The USD to target currency rate for the quote

Example:

1500.65

data.sourceCurrency

enum<string>

The source currency for the quote

Available options:

BTCSAT,

NGNKOBO,

KESCENT,

ZARCENT

data.targetCurrency

enum<string>

The target currency for the quote

Available options:

NGNKOBO,

KESCENT,

ZARCENT

data.transactionFeesInSourceCurrency

number<number>

The transaction fees in the source currency in its lowest denomination

Example:

13.23

data.transactionFeesInTargetCurrency

string<string>

The transaction fees in the target currency in its lowest denomination

Example:

"3750.00"

data.amountInSourceCurrency

number<number>

The amount in the source currency in its lowest denomination

Example:

1499

data.amountInTargetCurrency

string<string>

The amount in the target currency in its lowest denomination

Example:

"50000.00"

data.paymentMethod

enum<string>

Available options:

LIGHTNING

data.expiry

string<date-time>

Example:

"2021-07-01T12:00:00Z"

data.isValid

boolean<boolean>

Example:

true

data.invoice

string<string>

The lightning invoice to pay for the quote

Example:

"lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3"

data.hash

string<string>

The payment hash for the lightning invoice attached to the quote

Example:

"189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727"

data.totalAmountInSourceCurrency

number<number>

The total amount in the source currency in its lowest denomination

Example:

1499

data.customerInternalFee

number<number>

An internal fee you can set to charge the customer. This fee is in the source currency in its lowest denomination

Example:

0

data.createdAt

string<date-time>

The date and time the quote was created

Example:

"2021-07-01T12:00:00Z"

data.updatedAt

string<date-time>

The date and time the quote was last updated

Example:

"2021-07-01T12:00:00Z"

Get all orders Get wallets

⌘I

API Documentation

API Endpoints

Authorizations

Body

Response