Get user profile

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

{
  "status": "success",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+2348123456789",
    "businessName": "John Doe Enterprises",
    "emailVerified": true,
    "kycInfo": {
      "address": "3 Opebi Road, Ikeja, Lagos",
      "phone": "+2348123456789",
      "nationality": "Nigeria",
      "businessName": "John Doe Enterprises",
      "status": "PENDING"
    },
    "account": {
      "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "type": "INDIVIDUAL",
      "status": "ACTIVE",
      "walletDetails": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "currency": "NGN",
        "balance": "10000000",
        "bankAccount": {
          "bankName": "KUDA MICROFINANCE BANK",
          "bankCode": "090267",
          "bankAccountNumber": "0123456789",
          "bankAccountName": "Satoshi Nakamoto",
          "currency": "NGN",
          "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b-123456789"
        },
        "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"
            }
          }
        ]
      },
      "ownerId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "apiKey": "d1614a76411198a743199f307e5b",
      "totalSatsExchanged": 1000,
      "webhook": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "url": "https://webhook.site/12345678-1234-1234-1234-123456789012",
        "secret": "secret",
        "isActive": true
      },
      "settings": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "autopayout": true,
        "language": "EN",
        "notification": {
          "email": true,
          "sms": true
        }
      }
    }
  }
}

GET

user

Get user profile

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

{
  "status": "success",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+2348123456789",
    "businessName": "John Doe Enterprises",
    "emailVerified": true,
    "kycInfo": {
      "address": "3 Opebi Road, Ikeja, Lagos",
      "phone": "+2348123456789",
      "nationality": "Nigeria",
      "businessName": "John Doe Enterprises",
      "status": "PENDING"
    },
    "account": {
      "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "type": "INDIVIDUAL",
      "status": "ACTIVE",
      "walletDetails": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "currency": "NGN",
        "balance": "10000000",
        "bankAccount": {
          "bankName": "KUDA MICROFINANCE BANK",
          "bankCode": "090267",
          "bankAccountNumber": "0123456789",
          "bankAccountName": "Satoshi Nakamoto",
          "currency": "NGN",
          "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b-123456789"
        },
        "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"
            }
          }
        ]
      },
      "ownerId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "apiKey": "d1614a76411198a743199f307e5b",
      "totalSatsExchanged": 1000,
      "webhook": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "url": "https://webhook.site/12345678-1234-1234-1234-123456789012",
        "secret": "secret",
        "isActive": true
      },
      "settings": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "autopayout": true,
        "language": "EN",
        "notification": {
          "email": true,
          "sms": true
        }
      }
    }
  }
}

Authorizations

X-API-KEY

string

header

required

Response

User response

status

string<string>

Example:

"success"

data

object

Show child attributes

data.id

string<uuid>

Example:

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

data.name

string<string>

Example:

"John Doe"

data.email

string<email>

Example:

"[email protected]"

data.phone

string<string>

Example:

"+2348123456789"

data.businessName

string<string>

Example:

"John Doe Enterprises"

data.emailVerified

boolean<boolean>

Example:

true

data.kycInfo

object

Show child attributes

data.kycInfo.address

string<string>

Example:

"3 Opebi Road, Ikeja, Lagos"

data.kycInfo.phone

string<string>

Example:

"+2348123456789"

data.kycInfo.nationality

string<string>

Example:

"Nigeria"

data.kycInfo.businessName

string<string>

Example:

"John Doe Enterprises"

data.kycInfo.status

enum<string>

Available options:

PENDING,

APPROVED,

REJECTED

data.account

object

Show child attributes

data.account.id

string<uuid>

Example:

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

data.account.type

enum<string>

Available options:

INDIVIDUAL,

BUSINESS,

ADMIN

data.account.status

enum<string>

Available options:

ACTIVE,

INACTIVE

data.account.walletDetails

object

Show child attributes

data.account.walletDetails.id

string<uuid>

Example:

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

data.account.walletDetails.currency

enum<string>

Available options:

NGN,

KES,

BTC,

USD

data.account.walletDetails.balance

number<number>

Example:

"10000000"

data.account.walletDetails.bankAccount

object

Show child attributes

data.account.walletDetails.bankAccount.bankName

string<string>

Example:

"KUDA MICROFINANCE BANK"

data.account.walletDetails.bankAccount.bankCode

string<string>

Example:

"090267"

data.account.walletDetails.bankAccount.bankAccountNumber

string<string>

Example:

"0123456789"

data.account.walletDetails.bankAccount.bankAccountName

string<string>

Example:

"Satoshi Nakamoto"

data.account.walletDetails.bankAccount.currency

enum<string>

Available options:

NGN

data.account.walletDetails.bankAccount.walletId

string<string>

Example:

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

data.account.walletDetails.transactions

object[]

Show child attributes

data.account.walletDetails.transactions.id

string<uuid>

The unique identifier for the transaction

Example:

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

data.account.walletDetails.transactions.walletId

string<uuid>

The unique identifier for the wallet

Example:

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

data.account.walletDetails.transactions.ref

string<string>

The reference for the transaction

Example:

"99eeff854ffd345fffs67890"

data.account.walletDetails.transactions.hash

string<string>

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

Example:

"189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727"

data.account.walletDetails.transactions.amount

number<number>

The amount of the transaction in its lowest denomination

Example:

1000

data.account.walletDetails.transactions.fees

number<number>

The fees for the transaction in its lowest denomination

Example:

0

data.account.walletDetails.transactions.currency

enum<string>

The currency of the transaction

Available options:

NGN,

KES,

BTC,

ZAR

data.account.walletDetails.transactions.type

enum<string>

The type of the transaction

Available options:

WITHDRAWAL,

DEPOSIT

data.account.walletDetails.transactions.status

enum<string>

The status of the transaction

Available options:

SUCCESS,

PENDING,

FAILED

data.account.walletDetails.transactions.autopayout

boolean<boolean>

Whether the transaction is an instant payout

Example:

true

data.account.walletDetails.transactions.createdAt

string<date-time>

The date and time the transaction was created

Example:

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

data.account.walletDetails.transactions.updatedAt

string<date-time>

The date and time the transaction was last updated

Example:

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

data.account.walletDetails.transactions.metadata

object

Show child attributes

data.account.walletDetails.transactions.metadata.id

string<uuid>

Example:

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

data.account.walletDetails.transactions.metadata.orderId

string<string>

Example:

"99854-2345"

data.account.walletDetails.transactions.metadata.bankCode

string<string>

Example:

"090267"

data.account.walletDetails.transactions.metadata.bankAccountName

string<string>

Example:

"Satoshi Nakamoto"

data.account.walletDetails.transactions.metadata.bankAccountNumber

string<string>

Example:

"0123456789"

data.account.walletDetails.transactions.metadata.customerInternalFee

number<number>

Example:

0

data.account.walletDetails.transactions.metadata.createdAt

string<date-time>

Example:

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

data.account.walletDetails.transactions.metadata.updatedAt

string<date-time>

Example:

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

data.account.ownerId

string<string>

Example:

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

data.account.apiKey

string<string>

Example:

"d1614a76411198a743199f307e5b"

data.account.totalSatsExchanged

number<number>

Example:

1000

data.account.webhook

object

Show child attributes

data.account.webhook.id

string<uuid>

Example:

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

data.account.webhook.url

string<string>

Example:

"https://webhook.site/12345678-1234-1234-1234-123456789012"

data.account.webhook.secret

string<string>

Example:

"secret"

data.account.webhook.isActive

boolean<boolean>

Example:

true

data.account.settings

object

Show child attributes

data.account.settings.id

string<uuid>

Example:

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

data.account.settings.autopayout

boolean<boolean>

Example:

true

data.account.settings.language

enum<string>

Available options:

EN,

FR,

ES

data.account.settings.notification

object

Show child attributes

data.account.settings.notification.email

boolean<boolean>

Example:

true

data.account.settings.notification.sms

boolean<boolean>

Example:

true

Get all transactions Register Webhook

⌘I

API Documentation

API Endpoints

Get user profile

Authorizations

Response