Get order by id

Get order details

curl --request GET \
  --url https://staging.api.mavapay.co/api/v1/order \
  --header 'X-API-KEY: <api-key>'

{
  "status": "success",
  "data": {
    "orderId": "99854-2345",
    "quoteId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "status": "PAID",
    "currency": "NGN",
    "paymentCollectionMethod": "LIGHTNING",
    "isValid": true,
    "displayAmount": "1000.00 NGN",
    "paymentBtcDetail": "lntbs14912790n1pjnruqtpp5xmrq39nwyhgde4a94wsnuacj4stacls05g4x5du2req9pvjpqz6sdz9296k7ar98gsxgdm9vvmx2v3s95ckyceh956xvd3595uxyetr95cnydrxxv6nvwrxv5mngcqzpuxqzfvsp578t78k4628snkkhc43eqrpn6sem28w4cwgzn7ceyyr320kwm4uss9qyyssqcwxw8wy2qenwgm7gagx9lwvcs9w9tw47ntuc823yclasjqczvvj545hr4d9nmg996l0cswudgeawclwytafmh66a2fafk4heksyae5sq3vzd28",
    "createdAt": "2021-07-01T12:00:00Z",
    "quotes": [
      {
        "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"
      }
    ],
    "transactions": [
      {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "ref": "99eeff854ffd345fffs67890",
        "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
        "amount": 1000,
        "fees": 0,
        "currency": "NGN",
        "type": "WITHDRAWAL",
        "status": "SUCCESS",
        "autopayout": true,
        "createdAt": "2021-07-01T12:00:00Z",
        "updatedAt": "2021-07-01T12:00:00Z",
        "metadata": {
          "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
          "orderId": "99854-2345",
          "bankCode": "090267",
          "bankAccountName": "Satoshi Nakamoto",
          "bankAccountNumber": "0123456789",
          "customerInternalFee": 0,
          "createdAt": "2021-07-01T12:00:00Z",
          "updatedAt": "2021-07-01T12:00:00Z"
        }
      }
    ]
  }
}

GET

order

Get order details

curl --request GET \
  --url https://staging.api.mavapay.co/api/v1/order \
  --header 'X-API-KEY: <api-key>'

{
  "status": "success",
  "data": {
    "orderId": "99854-2345",
    "quoteId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "status": "PAID",
    "currency": "NGN",
    "paymentCollectionMethod": "LIGHTNING",
    "isValid": true,
    "displayAmount": "1000.00 NGN",
    "paymentBtcDetail": "lntbs14912790n1pjnruqtpp5xmrq39nwyhgde4a94wsnuacj4stacls05g4x5du2req9pvjpqz6sdz9296k7ar98gsxgdm9vvmx2v3s95ckyceh956xvd3595uxyetr95cnydrxxv6nvwrxv5mngcqzpuxqzfvsp578t78k4628snkkhc43eqrpn6sem28w4cwgzn7ceyyr320kwm4uss9qyyssqcwxw8wy2qenwgm7gagx9lwvcs9w9tw47ntuc823yclasjqczvvj545hr4d9nmg996l0cswudgeawclwytafmh66a2fafk4heksyae5sq3vzd28",
    "createdAt": "2021-07-01T12:00:00Z",
    "quotes": [
      {
        "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"
      }
    ],
    "transactions": [
      {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "ref": "99eeff854ffd345fffs67890",
        "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
        "amount": 1000,
        "fees": 0,
        "currency": "NGN",
        "type": "WITHDRAWAL",
        "status": "SUCCESS",
        "autopayout": true,
        "createdAt": "2021-07-01T12:00:00Z",
        "updatedAt": "2021-07-01T12:00:00Z",
        "metadata": {
          "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
          "orderId": "99854-2345",
          "bankCode": "090267",
          "bankAccountName": "Satoshi Nakamoto",
          "bankAccountNumber": "0123456789",
          "customerInternalFee": 0,
          "createdAt": "2021-07-01T12:00:00Z",
          "updatedAt": "2021-07-01T12:00:00Z"
        }
      }
    ]
  }
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

string<string>

required

The order ID to get the details for

Response

Order response

status

string<string>

Example:

"success"

data

object

Show child attributes

data.orderId

string<string>

Example:

"99854-2345"

data.quoteId

string<string>

Example:

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

data.status

enum<string>

Available options:

PAID,

PENDING,

EXPIRED,

FAILED

data.currency

enum<string>

Available options:

NGN,

KES

data.paymentCollectionMethod

enum<string>

Available options:

LIGHTNING,

ONCHAIN,

USDT

data.isValid

boolean<boolean>

Example:

true

data.displayAmount

string<string>

Example:

"1000.00 NGN"

data.paymentBtcDetail

string<string>

Example:

"lntbs14912790n1pjnruqtpp5xmrq39nwyhgde4a94wsnuacj4stacls05g4x5du2req9pvjpqz6sdz9296k7ar98gsxgdm9vvmx2v3s95ckyceh956xvd3595uxyetr95cnydrxxv6nvwrxv5mngcqzpuxqzfvsp578t78k4628snkkhc43eqrpn6sem28w4cwgzn7ceyyr320kwm4uss9qyyssqcwxw8wy2qenwgm7gagx9lwvcs9w9tw47ntuc823yclasjqczvvj545hr4d9nmg996l0cswudgeawclwytafmh66a2fafk4heksyae5sq3vzd28"

data.createdAt

string<date-time>

Example:

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

data.quotes

object[]

Show child attributes

data.quotes.id

string<uuid>

Example:

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

data.quotes.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.quotes.usdToTargetCurrencyRate

number<number>

The USD to target currency rate for the quote

Example:

1500.65

data.quotes.sourceCurrency

enum<string>

The source currency for the quote

Available options:

BTCSAT,

NGNKOBO,

KESCENT,

ZARCENT

data.quotes.targetCurrency

enum<string>

The target currency for the quote

Available options:

NGNKOBO,

KESCENT,

ZARCENT

data.quotes.transactionFeesInSourceCurrency

number<number>

The transaction fees in the source currency in its lowest denomination

Example:

13.23

data.quotes.transactionFeesInTargetCurrency

string<string>

The transaction fees in the target currency in its lowest denomination

Example:

"3750.00"

data.quotes.amountInSourceCurrency

number<number>

The amount in the source currency in its lowest denomination

Example:

1499

data.quotes.amountInTargetCurrency

string<string>

The amount in the target currency in its lowest denomination

Example:

"50000.00"

data.quotes.paymentMethod

enum<string>

Available options:

LIGHTNING

data.quotes.expiry

string<date-time>

Example:

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

data.quotes.isValid

boolean<boolean>

Example:

true

data.quotes.invoice

string<string>

The lightning invoice to pay for the quote

Example:

"lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3"

data.quotes.hash

string<string>

The payment hash for the lightning invoice attached to the quote

Example:

"189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727"

data.quotes.totalAmountInSourceCurrency

number<number>

The total amount in the source currency in its lowest denomination

Example:

1499

data.quotes.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.quotes.createdAt

string<date-time>

The date and time the quote was created

Example:

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

data.quotes.updatedAt

string<date-time>

The date and time the quote was last updated

Example:

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

data.transactions

object[]

Show child attributes

data.transactions.id

string<uuid>

The unique identifier for the transaction

Example:

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

data.transactions.walletId

string<uuid>

The unique identifier for the wallet

Example:

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

data.transactions.ref

string<string>

The reference for the transaction

Example:

"99eeff854ffd345fffs67890"

data.transactions.hash

string<string>

The payment hash for the lightning invoice attached to the quote related to the transaction

Example:

"189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727"

data.transactions.amount

number<number>

The amount of the transaction in its lowest denomination

Example:

1000

data.transactions.fees

number<number>

The fees for the transaction in its lowest denomination

Example:

0

data.transactions.currency

enum<string>

The currency of the transaction

Available options:

NGN,

KES,

BTC,

ZAR

data.transactions.type

enum<string>

The type of the transaction

Available options:

WITHDRAWAL,

DEPOSIT

data.transactions.status

enum<string>

The status of the transaction

Available options:

SUCCESS,

PENDING,

FAILED

data.transactions.autopayout

boolean<boolean>

Whether the transaction is an instant payout

Example:

true

data.transactions.createdAt

string<date-time>

The date and time the transaction was created

Example:

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

data.transactions.updatedAt

string<date-time>

The date and time the transaction was last updated

Example:

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

data.transactions.metadata

object

Show child attributes

data.transactions.metadata.id

string<uuid>

Example:

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

data.transactions.metadata.orderId

string<string>

Example:

"99854-2345"

data.transactions.metadata.bankCode

string<string>

Example:

"090267"

data.transactions.metadata.bankAccountName

string<string>

Example:

"Satoshi Nakamoto"

data.transactions.metadata.bankAccountNumber

string<string>

Example:

"0123456789"

data.transactions.metadata.customerInternalFee

number<number>

Example:

0

data.transactions.metadata.createdAt

string<date-time>

Example:

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

data.transactions.metadata.updatedAt

string<date-time>

Example:

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

Name Enquiry Get all orders

⌘I

API Documentation

API Endpoints

Get order by id

Authorizations

Query Parameters

Response