shihaam/thijooree
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases 8 Wiki Activity
Files
ea227bf3b963c5de6379e9f7e8b09ff2f75dbf10
thijooree/docs/bmlapi/04-dashboard.md
Shihaam Abdul Rahman 6b3131069e
All checks were successful
Auto Tag on Version Change / check-version (push) Successful in 6s
Details
update docs
2026-05-24 00:27:59 +05:00

7.8 KiB
Raw Blame History

Dashboard

Fetch all accounts for the active profile: CASA (savings/current), cards (prepaid/credit/debit), and loans.

Endpoint

GET https://www.bankofmaldives.com.mv/internetbanking/api/mobile/dashboard

Prerequisites

Request

Headers

Header Value
Authorization Bearer <access_token>
User-Agent bml-mobile-banking/348 ({manufacturer}; Android {version}; {model})
x-app-version 2.1.44.348 
curl --request GET \
  --url 'https://www.bankofmaldives.com.mv/internetbanking/api/mobile/dashboard' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'User-Agent: bml-mobile-banking/348 ({manufacturer}; Android {version}; {model})' \
  --header 'x-app-version: 2.1.44.348'

Response

{
  "success": true,
  "payload": {
    "dashboard": [
      {
        "id": "abc123def456",
        "account": "7730000000001",
        "account_type": "CASA",
        "product": "Current Account",
        "alias": "My Account",
        "currency": "MVR",
        "account_status": "Active",
        "availableBalance": 1234.56,
        "ledgerBalance": 1250.00,
        "lockedAmount": 15.44
      },
      {
        "id": "xyz789",
        "account": "7730000000002",
        "account_type": "CASA",
        "product": "Savings Account",
        "alias": "USD Savings",
        "currency": "USD",
        "account_status": "Active",
        "availableBalance": 500.00,
        "ledgerBalance": 500.00,
        "lockedAmount": 0.0
      },
      {
        "id": "card001",
        "account": "4111111111111111",
        "account_type": "Card",
        "product": "Visa Debit",
        "alias": "My Debit Card",
        "currency": "MVR",
        "account_status": "Active",
        "prepaid_card": false,
        "product_code": "VISA",
        "account_visible": false,
        "cardBalance": {
          "AvailableLimit": 0.0,
          "CurrentBalance": 0.0
        }
      },
      {
        "id": "card002",
        "account": "4111111111112222",
        "account_type": "Card",
        "product": "Visa Prepaid",
        "alias": "Prepaid",
        "currency": "MVR",
        "account_status": "Active",
        "prepaid_card": true,
        "product_code": "VISA",
        "account_visible": true,
        "cardBalance": {
          "AvailableLimit": 200.00,
          "CurrentBalance": 50.00
        }
      },
      {
        "id": "loan001",
        "account": "9900000000001",
        "account_type": "Loan",
        "product": "Personal Finance",
        "alias": "My Loan",
        "currency": "MVR",
        "account_status": "Active",
        "availableBalance": -30000.0
      }
    ]
  }
}

Response Fields

Top-level

Field Type Description
success bool true on success
payload.dashboard array List of account objects; order may vary

Common Account Fields

Field Type Description
id string Internal BML account ID — use this for history and loan detail calls
account string Account or card number (as displayed)
account_type string Account category — see table below
product string Product name (e.g. "Current Account", "Visa Prepaid")
alias string User-assigned label; may be blank
currency string ISO 4217 currency code (e.g. "MVR", "USD")
account_status string "Active" or other status strings

Account Types

account_type Description
CASA Current Account or Savings Account
Card Debit, credit, or prepaid card
Loan Loan or financing account

CASA Fields

Field Type Description
availableBalance number Available balance (funds available to use)
ledgerBalance number Book balance (may include pending transactions)
lockedAmount number Blocked/reserved amount

Card Fields

Field Type Description
prepaid_card bool true for prepaid cards
product_code string Card scheme (e.g. "VISA")
account_visible bool true for credit cards, false for debit cards
cardBalance.AvailableLimit number Available credit/prepaid balance
cardBalance.CurrentBalance number Current outstanding balance

Card Profile Types

Condition Type
prepaid_card: true Prepaid card
prepaid_card: false AND account_visible: true Credit card
prepaid_card: false AND account_visible: false Debit card

Product Code → Card Name

The product_code field identifies the specific card product. Known mappings:

product_code Card name Asset
C8201, C8001, C8009 Mastercard Prepaid master_prepaid
C8205, C8005, C8008 Mastercard Prepaid Travel master_prepaid_travel
C8010, C8011 Mastercard Platinum master_platinum
C8020, C8022 Mastercard Gold master_gold
C8030, C8033 Mastercard Business Debit master_business_debit
C8040, C8044 Mastercard World master_world
C8101 Mastercard Masveriyaa master_masveriyaa
C8102 Mastercard Odiveriyaa master_odiveriyaa
C8901, C8991, C8980, C8981 Mastercard Passport master_passport
C8902, C8907, C8909, C8912, C8992, C8996, C8997, C8982, C8983 Mastercard Islamic master_islamic
C8905, C8995 Visa Credit visa_credit
C8925, C8926 Visa Student Blue visa_student_blue
C3001, C3011, C3050, C3051, C3031 Amex Credit Green amex_credit_green
C3003, C3013, C3053, C3023, C3033, C3052 Amex Debit Gold amex_debit_gold
C3005, C3015, C3055, C3054 Amex Platinum amex_platinum
C3007, C3017, C3097, C3095, C3077, C3177 Amex Debit Green amex_debit_green
C3009, C3019, C3029, C3099, C3088, C3188 Amex Credit Gold amex_credit_gold
C1001, C1011, C1082, C1081, C1101, C1111, C1181, C1182 Visa Debit Generic visa_debit_generic
C1003, C1013, C1083, C1084, C1103, C1113, C1183, C1184 Visa Gold visa_gold
C1005, C1006, C1089 Visa Debit Islamic visa_debit_islamic
C1007, C1027, C1097, C1107, C1197, C1077, C1177 Visa Debit visa_debit
C1009, C1019, C1085, C1086, C1109, C1119, C1185, C1186 Visa Platinum visa_platinum
C1017 Visa Infinite visa_infinite
C1020, C1021 Visa Debit Platinum visa_debit_platinum
C1030, C1090, C1130, C1033, C1133 Visa Corporate visa_corporate
C1040, C1041, C1047, C1048, C1050, C1051, C1087, C1088, C1140, C1141, C1147, C1148, C1150, C1151, C1187, C1188 Visa Student Black visa_student_black
C1059, C1062, C1070, C1072, C1159, C1162 Mastercard Prepaid Business master_prepaid_business
C1061, C1063, C1071, C1073, C1161, C1163 Mastercard master
(any other) — default card image

Loan Fields

Field Type Description
availableBalance number Outstanding balance — returned as a negative number; use abs() for display

For full loan details (interest rate, repayment schedule, overdue info), call GET /api/mobile/account/{id}.

Error Responses

Expired session

HTTP 401 or 419 — the access token has expired. Attempt token refresh.

Server error

HTTP 5xx — BML server-side error. Retry after a delay.

 

← OAuth Token     Next → User Info

Reference in New Issue View Git Blame Copy Permalink