Shihaam Abdul Rahman
256f216da4
All checks were successful
Auto Tag on Version Change / check-version (push) Successful in 4s
158 lines
3.7 KiB
Markdown
158 lines
3.7 KiB
Markdown
# Contacts (Saved Beneficiaries)
|
|
|
|
Manage the user's saved beneficiary list: list all contacts, save a new one, and delete an existing one.
|
|
|
|
---
|
|
|
|
## List Contacts
|
|
|
|
```
|
|
GET https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts
|
|
```
|
|
|
|
### Request
|
|
|
|
```bash
|
|
curl --request GET \
|
|
--url 'https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts' \
|
|
--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
|
|
|
|
```json
|
|
{
|
|
"success": true,
|
|
"payload": [
|
|
{
|
|
"id": 1,
|
|
"account": "7730000000001",
|
|
"name": "Mohamed Ali",
|
|
"alias": "Ali",
|
|
"status": "S",
|
|
"currency": "MVR"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"account": "90101000000001000",
|
|
"name": "Ahmed Hassan",
|
|
"alias": "Hassan",
|
|
"status": "S",
|
|
"currency": "MVR"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
| Field | Type | Description |
|
|
|---|---|---|
|
|
| `id` | `number` | Internal contact ID — use for delete |
|
|
| `account` | `string` | Beneficiary account number |
|
|
| `name` | `string` | Account holder name |
|
|
| `alias` | `string` | User-assigned nickname; falls back to `name` if blank |
|
|
| `status` | `string` | Contact status (typically `"S"` for saved) |
|
|
| `currency` | `string` | Transfer currency for this contact |
|
|
|
|
Entries where `account` is blank are skipped.
|
|
|
|
---
|
|
|
|
## Save Contact
|
|
|
|
```
|
|
POST https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts
|
|
```
|
|
|
|
### Request
|
|
|
|
**Content-Type:** `application/json`
|
|
|
|
```json
|
|
{
|
|
"contact_type": "BML",
|
|
"account": "7730000000001",
|
|
"alias": "Ali",
|
|
"currency": "MVR",
|
|
"name": "Mohamed Ali"
|
|
}
|
|
```
|
|
|
|
| Field | Type | Required | Description |
|
|
|---|---|---|---|
|
|
| `contact_type` | `string` | Yes | Contact category (e.g. `"BML"`) |
|
|
| `account` | `string` | Yes | Beneficiary account number |
|
|
| `alias` | `string` | Yes | Display nickname |
|
|
| `currency` | `string` | No | Transfer currency |
|
|
| `name` | `string` | No | Full name of the beneficiary |
|
|
| `swift` | `string` | No | SWIFT/BIC code (for international contacts) |
|
|
|
|
```bash
|
|
curl --request POST \
|
|
--url 'https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts' \
|
|
--header 'Authorization: Bearer <access_token>' \
|
|
--header 'User-Agent: bml-mobile-banking/348 ({manufacturer}; Android {version}; {model})' \
|
|
--header 'x-app-version: 2.1.44.348' \
|
|
--header 'Accept: application/json' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{"contact_type":"BML","account":"7730000000001","alias":"Ali","currency":"MVR","name":"Mohamed Ali"}'
|
|
```
|
|
|
|
### Response
|
|
|
|
```json
|
|
{ "success": true }
|
|
```
|
|
|
|
`success: true` confirms the contact was saved. `success: false` on failure.
|
|
|
|
---
|
|
|
|
## Delete Contact
|
|
|
|
```
|
|
POST https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts/{contactId}
|
|
```
|
|
|
|
BML does not support `DELETE` directly — the delete is sent as a POST with a `_method: delete` body override.
|
|
|
|
| Path parameter | Description |
|
|
|---|---|
|
|
| `contactId` | The `id` from the contacts list |
|
|
|
|
### Request
|
|
|
|
**Content-Type:** `application/json`
|
|
|
|
```json
|
|
{ "_method": "delete" }
|
|
```
|
|
|
|
```bash
|
|
curl --request POST \
|
|
--url 'https://www.bankofmaldives.com.mv/internetbanking/api/mobile/contacts/1' \
|
|
--header 'Authorization: Bearer <access_token>' \
|
|
--header 'User-Agent: bml-mobile-banking/348 ({manufacturer}; Android {version}; {model})' \
|
|
--header 'x-app-version: 2.1.44.348' \
|
|
--header 'accept: application/json' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{"_method":"delete"}'
|
|
```
|
|
|
|
### Response
|
|
|
|
```json
|
|
{ "success": true }
|
|
```
|
|
|
|
`success: true` confirms the contact was deleted.
|
|
|
|
---
|
|
|
|
|
|
|
|
---
|
|
|
|
[← Transfer](08-transfer.md) **Next →** [Account Validation](10-validate.md)
|