Safe Haven IBS API

https://safehavenmfb.readme.io
Admin
The Safe Haven IBS API allows customers to automate business processes such as creating accounts,...
Tokens:29,137
Snippets:270
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### cURL request to get accounts

Source: https://safehavenmfb.readme.io/reference/get-accounts

Example cURL command to fetch accounts with default parameters. Requires ClientID header (not shown) and OAuth2 bearer token.

```shell
curl --request GET \
     --url 'https://api.sandbox.safehavenmfb.com/accounts?page=0&limit=100&isSubAccount=false' \
     --header 'accept: application/json'
```

--------------------------------

### SafeHavenCheckout - With Callback Function

Source: https://safehavenmfb.readme.io/reference/checkout-js

Example of initializing SafeHavenCheckout with a callback function to handle payment response.

```APIDOC
## SafeHavenCheckout - With Callback Function

### Description
Initializes the SafeHaven Checkout with a callback function to handle the payment response and an onClose event.

### Method
JavaScript function call

### Endpoint
SafeHavenCheckout(configuration)

### Parameters
#### Configuration Object
- **environment** (string) - Required - Payment environment: "sandbox" or "production".
- **clientId** (string) - Required - OAuth2 Client ID.
- **referenceCode** (string) - Required - Unique reference for the transaction.
- **customer** (object) - Required - Customer details.
  - **firstName** (string) - Required - Customer's first name.
  - **lastName** (string) - Required - Customer's last name.
  - **emailAddress** (string) - Required - Customer's email address.
  - **phoneNumber** (string) - Required - Customer's phone number.
- **currency** (string) - Required - Currency code, must be "NGN".
- **amount** (number) - Required - Payment amount.
- **feeBearer** (string) - Optional - Who bears the fee: "account" (merchant) or "customer".
- **settlementAccount** (object) - Required - Settlement account details.
  - **bankCode** (string) - Required - Bank code: "999240" for sandbox, "090286" for production.
  - **accountNumber** (string) - Required - 10-digit SafeHaven account number.
- **webhookUrl** (string) - Optional - Webhook URL for notifications.
- **customIconUrl** (string) - Optional - Custom icon URL.
- **metadata** (object) - Optional - Additional metadata.
- **onClose** (function) - Optional - Callback when checkout is closed.
- **callback** (function) - Optional - Callback to handle payment response.

### Request Example
```javascript
let checkOut = SafeHavenCheckout({
    environment: "production",
    clientId: "{{ OAuth2 ClientID }}",
    referenceCode: ''+Math.floor((Math.random() * 1000000000) + 1),
    customer: {
        firstName: "John",
        lastName: "Doe",
        emailAddress: "johndoe@example.com",
        phoneNumber: "+2348032273616"
    },
    currency: "NGN",
    amount: 100,
    settlementAccount: {
        bankCode: "090286",
        accountNumber: "{{ 10 Digits SafeHaven Account Number }}"
    },
    onClose: () => { console.log("Checkout Closed") },
    callback: (response) => { console.log(response) }
});
```

### Response
No explicit response documented.
```

--------------------------------

### Pagination JSON response example

Source: https://safehavenmfb.readme.io/reference/pagination

Example JSON response showing the pagination object with total, pages, page, and limit fields. The response includes a statusCode, message, data array, and pagination details.

```json
{
    "statusCode": 200,
    "message": "Accounts fetched successfully.",
    "data": [
    {.....},
    {.....},
    {.....}
    ],
    "pagination": {
        "total": 1,
        "pages": 1,
        "page": "0",
        "limit": "25"
    }
}
```

--------------------------------

### cURL Request for Get Account Statement

Source: https://safehavenmfb.readme.io/reference/get-account-statement

Example cURL command to call the Get Account Statement endpoint. It uses the sandbox base URL and includes the required query parameters page and limit, along with the accept header.

```shell
curl --request GET \
     --url 'https://api.sandbox.safehavenmfb.com/accounts/id/statement?page=0&limit=100' \
     --header 'accept: application/json'
```

--------------------------------

### SafeHavenCheckout - With Redirect URL

Source: https://safehavenmfb.readme.io/reference/checkout-js

Example of initializing SafeHavenCheckout with a redirect URL for payment processing.

```APIDOC
## SafeHavenCheckout - With Redirect URL

### Description
Initializes the SafeHaven Checkout with a redirect URL to handle post-payment redirection.

### Method
JavaScript function call

### Endpoint
SafeHavenCheckout(configuration)

### Parameters
#### Configuration Object
- **environment** (string) - Required - Payment environment: "sandbox" or "production".
- **clientId** (string) - Required - OAuth2 Client ID.
- **referenceCode** (string) - Required - Unique reference for the transaction.
- **customer** (object) - Required - Customer details.
  - **firstName** (string) - Required - Customer's first name.
  - **lastName** (string) - Required - Customer's last name.
  - **emailAddress** (string) - Required - Customer's email address.
  - **phoneNumber** (string) - Required - Customer's phone number.
- **currency** (string) - Required - Currency code, must be "NGN".
- **amount** (number) - Required - Payment amount.
- **feeBearer** (string) - Optional - Who bears the fee: "account" (merchant) or "customer".
- **settlementAccount** (object) - Required - Settlement account details.
  - **bankCode** (string) - Required - Bank code: "999240" for sandbox, "090286" for production.
  - **accountNumber** (string) - Required - 10-digit SafeHaven account number.
- **redirectUrl** (string) - Required - URL to redirect after payment.
- **webhookUrl** (string) - Optional - Webhook URL for notifications.
- **customIconUrl** (string) - Optional - Custom icon URL.
- **metadata** (object) - Optional - Additional metadata.

### Request Example
```javascript
let checkOut = SafeHavenCheckout({
    environment: "production",
    clientId: "{{ OAuth2 ClientID }}",
    referenceCode: ''+Math.floor((Math.random() * 1000000000) + 1),
    customer: {
        firstName: "John",
        lastName: "Doe",
        emailAddress: "johndoe@example.com",
        phoneNumber: "+2348032273616"
    },
    currency: "NGN",
    amount: 100,
    settlementAccount: {
        bankCode: "090286",
        accountNumber: "{{ 10 Digits SafeHaven Account Number }}"
    },
    redirectUrl: "https://example.com/redirect"
});
```

### Response
No explicit response documented.
```

--------------------------------

### GET /vas/service-category/{id}/products

Source: https://safehavenmfb.readme.io/reference/get-category-products

Returns all available products and offers under a specific category. Requires the category ID and a ClientID header.

```APIDOC
## GET /vas/service-category/{id}/products

### Description
Returns all the available products and offers under a specific category.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/service-category/{id}/products

### Parameters
#### Path Parameters
- **id** (string) - Required - The `_id` of the category.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/service-category/id/products \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the list of products and offers under the specified category.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### cURL Request for Get Category Products

Source: https://safehavenmfb.readme.io/reference/get-category-products

Use this cURL command to call the Get Category Products endpoint. Replace the placeholder 'id' in the URL with the actual category ID. The request requires a ClientID header with your 'ibs_client_id'.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/service-category/id/products \
     --header 'accept: application/json'
```

--------------------------------

### cURL Request to GET /transfers/banks

Source: https://safehavenmfb.readme.io/reference/bank-list

Sends a GET request to https://api.sandbox.safehavenmfb.com/transfers/banks to retrieve the list of all banks in Nigeria. Requires the ClientID header containing the 'ibs_client_id' returned when generating an API token.

```Shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/transfers/banks \
```

--------------------------------

### GET /vas/services

Source: https://safehavenmfb.readme.io/reference/get-services

Call this endpoint to fetch all the value added services provided by Safe Haven. Requires a ClientID header.

```APIDOC
## GET /vas/services

### Description
Call this endpoint to fetch all the value added services provided by Safe Haven.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/services

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/services \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **Result** (object) - The response body containing the list of services.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### cURL Request to Create Virtual Account

Source: https://safehavenmfb.readme.io/reference/create-virtual-account

Use this cURL command to create a virtual account. The request includes validFor, settlementAccount, and amountControl parameters. The callbackUrl is required and must start with https://.

```shell
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/virtual-accounts \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "validFor": 900,
  "settlementAccount": {
    "bankCode": "090286"
  },
  "amountControl": "Fixed"
}
'
```

--------------------------------

### GET /transfers/banks

Source: https://safehavenmfb.readme.io/reference/transfers

Retrieves the list of banks supported for transfers.

```APIDOC
## GET /transfers/banks

### Description
Retrieves the list of banks supported for transfers.

### Method
GET

### Endpoint
/transfers/banks

```

--------------------------------

### GET /accounts

Source: https://safehavenmfb.readme.io/reference/accounts

Fetches a list of accounts. This endpoint is part of the Accounts API and is used to retrieve accounts.

```APIDOC
## GET /accounts

### Description
Fetches accounts.

### Method
GET

### Endpoint
/accounts

```

--------------------------------

### cURL Request to Get Services

Source: https://safehavenmfb.readme.io/reference/get-services

Use this cURL command to fetch all value added services. Requires a ClientID header with your 'ibs_client_id' from the API token response.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/services \
     --header 'accept: application/json'
```

--------------------------------

### GET /virtual-accounts/{id}

Source: https://safehavenmfb.readme.io/reference/get-virtual-account

Fetches a virtual account by its ID. The ID is provided as a path parameter, and the request must include a ClientID header for authentication.

```APIDOC
## GET /virtual-accounts/{id}

### Description
Retrieves a virtual account by its unique identifier.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/virtual-accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The `_id` of the account to fetch.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/virtual-accounts/id \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the virtual account details.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Response (400)
Returns an error response.

#### Response Example
```json
{
  "example": "error response body"
}
```
```

--------------------------------

### cURL Request to Purchase Cable TV Subscription

Source: https://safehavenmfb.readme.io/reference/purchase-a-cable-tv-subscription

Example cURL command to call the cable TV purchase endpoint. It includes the required headers and a JSON body with amount and channel. The channel defaults to WEB.

```shell
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/vas/pay/cable-tv \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "amount": 0,
  "channel": "WEB"
}
'

```

--------------------------------

### GET /vas/service/{id}

Source: https://safehavenmfb.readme.io/reference/get-service

Fetches the details of a service by its unique identifier. The service ID is provided as a path parameter, and the ClientID header must be included for authentication.

```APIDOC
## GET /vas/service/{id}

### Description
Returns the object of the specified service using the id.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/service/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The `_id` of the service you wish to get information on.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/service/id \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the service object. The response schema is not detailed in the source.

#### Response Example
Not provided in the source.

```

--------------------------------

### Initiate Verification with cURL

Source: https://safehavenmfb.readme.io/reference/verify-identity

Use this cURL command to initiate identity verification via the /identity/v2 endpoint. The request body includes the verification type (BVN or NIN), the number to verify, the debit account number, and an async flag. The example uses default values for number and debitAccountNumber.

```shell
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/identity/v2 \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "type": "BVN",
  "number": "1234567890",
  "debitAccountNumber": "1234567890",
  "async": false
}
'
```

--------------------------------

### GET /accounts

Source: https://safehavenmfb.readme.io/reference/get-accounts

This endpoint retrieves a list of accounts from the Safe Haven MFB sandbox API. It supports pagination and filtering by account type (main, sub, or virtual).

```APIDOC
## [GET] /accounts

### Description
This returns the list of accounts based on the specified parameters.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/accounts

### Parameters
#### Query Parameters
- **page** (int32) - Optional - Defaults to 0. This represents the position the results should begin from. 0 represents the first position.
- **limit** (int32) - Optional - Defaults to 100. This is the maximum number of accounts to be fetched for this request.
- **isSubAccount** (boolean) - Required - Defaults to false. Set it to `true` to fetch sub accounts and virtual accounts and `false` to fetch main accounts.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url 'https://api.sandbox.safehavenmfb.com/accounts?page=0&limit=100&isSubAccount=false' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the list of accounts based on the specified parameters.

#### Error Response (400)
Bad request.

```

--------------------------------

### cURL Request to Exchange Client Credentials

Source: https://safehavenmfb.readme.io/reference/exchange-client-credentials

Use this cURL command to exchange client credentials for an access token. The request includes the grant_type and client_assertion_type parameters. The client_assertion and client_id are not shown in this example but are required.

```shell
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/oauth2/token \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "grant_type": "client_credentials",
  "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
}
'
```

--------------------------------

### GET /checkout/{referenceCode}/verify

Source: https://safehavenmfb.readme.io/reference/verify-checkout-transaction

Verifies a checkout transaction using the provided reference code. The reference code is obtained from Checkout.js and is required as a path parameter.

```APIDOC
## GET /checkout/{referenceCode}/verify

### Description
Verifies a checkout transaction using the provided reference code. The reference code is obtained from Checkout.js and is required as a path parameter.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/checkout/{referenceCode}/verify

### Parameters
#### Path Parameters
- **referenceCode** (string) - Required - Checkout `referenceCode` from Checkout.js

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/checkout/referenceCode/verify \
     --header 'accept: text/plain'
```

### Response
#### Success Response (200)
Returns the verification result.

#### Response Example
```
200 - Result
```

```

--------------------------------

### cURL GET request to fetch beneficiaries

Source: https://safehavenmfb.readme.io/reference/get-beneficiaries

Use this cURL command to retrieve all saved beneficiaries from the sandbox API. The request requires the ClientID header containing the 'ibs_client_id' returned when generating an API token.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/transfers/beneficiaries
```

--------------------------------

### cURL Request to Get Service

Source: https://safehavenmfb.readme.io/reference/get-service

Use this cURL command to retrieve a service object by its ID. The request requires the service ID in the URL and the ClientID header. The response is returned in JSON format.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/service/id \
     --header 'accept: application/json'
```

--------------------------------

### Webhook for Transfer to Virtual Account JSON Payload

Source: https://safehavenmfb.readme.io/reference/webhooks

Example webhook object for a virtual account transfer event. The type is 'virtualAccount.transfer' and the payload includes transaction details such as amount, fees, and status.

```json
{
    "type": "virtualAccount.transfer",
    "data": {
        "_id": "65b76ed3c0a4440024e45e75",
        "client": "61e5a83ac6f0ec001ee90fac",
        "virtualAccount": "65b76ebbc0a4440024e45e52",
        "sessionId": "999240240129092434550231308787",
        "nameEnquiryReference": "999240240129092425585215261320",
        "paymentReference": "999240240129092434550231308787",
        "isReversed": false,
        "reversalReference": "",
        "provider": "BANK",
        "providerChannel": "TRANSFER",
        "providerChannelCode": "IBS",
        "destinationInstitutionCode": "999240",
        "creditAccountName": "BITAKOTECHNOLOG / OmaTech",
        "creditAccountNumber": "8060376145",
        "creditBankVerificationNumber": null,
        "creditKYCLevel": "3",
        "debitAccountName": "ZEALVEND",
        "debitAccountNumber": "0119536306",
        "debitBankVerificationNumber": null,
        "debitKYCLevel": "3",
        "transactionLocation": "9.0932,7.4429",
        "narration": "",
        "amount": 100,
        "fees": 5,
        "vat": 0,
        "stampDuty": 0,
        "responseCode": "00",
        "responseMessage": "Approved or completed successfully",
        "status": "Completed",
        "isDeleted": false,
        "createdAt": "2024-01-29T09:24:35.910Z",
        "declinedAt": "2024-01-29T09:24:35.910Z",
        "updatedAt": "2024-01-29T09:24:37.994Z",
        "__v": 0
    }
}
```

--------------------------------

### cURL request to get virtual account

Source: https://safehavenmfb.readme.io/reference/get-virtual-account

Use this cURL command to fetch a virtual account by its ID. Replace 'id' in the URL with the actual account ID. The ClientID header is required and should be your 'ibs_client_id' from the API token generation response.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/virtual-accounts/id \
     --header 'accept: application/json'
```

--------------------------------

### cURL Request for Get Account

Source: https://safehavenmfb.readme.io/reference/get-account

Use this cURL command to fetch a specific account by its id. Replace 'id' in the URL with the actual account id. The request requires a ClientID header (your 'ibs_client_id') and an OAuth2 bearer token.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/accounts/id \
     --header 'accept: application/json'
```

--------------------------------

### Generate private key with OpenSSL

Source: https://safehavenmfb.readme.io/reference/creating-an-app

Run this command in a terminal or command prompt to generate a private key file named privatekey.pem. You will be prompted for required information.

```bash
openssl genrsa -out privatekey.pem 1024

```

--------------------------------

### cURL Request for Get Virtual Transaction

Source: https://safehavenmfb.readme.io/reference/get-virtual-transaction

Sends a GET request to the virtual-accounts transaction endpoint with the virtualAccountId path parameter and an accept header for JSON.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/virtual-accounts/virtualAccountId/transaction \
     --header 'accept: application/json'
```

--------------------------------

### Generate public key certificate with OpenSSL

Source: https://safehavenmfb.readme.io/reference/creating-an-app

Run this command after generating the private key to create a public key certificate (publickey.cer) valid for 1825 days. Paste the public key into the dashboard's public key field.

```bash
openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825

```

--------------------------------

### POST /vas/verify

Source: https://safehavenmfb.readme.io/reference/verify-powercable-tv-data

Verifies the provided power or cable TV data and returns more information on it if it is valid.

```APIDOC
## POST /vas/verify

### Description
This verifies the provided power or cable tv data and returns more information on it if it is valid.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/verify

### Parameters
#### Body Params
- **serviceCategoryId** (string) - Required - The `_id` of the service category.
- **entityNumber** (string) - Required - This is the Card number for cable tv and the Meter number for utility.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/vas/verify \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

### Response
#### Success Response (200)
Returns verification details for the provided data.

#### Response Example
(Not provided in source)

#### Error Response (400)
Returns an error if the request is invalid.

#### Response Example
(Not provided in source)
```

--------------------------------

### POST /accounts

Source: https://safehavenmfb.readme.io/reference/create-account

Creates a new account under your profile. Requires account type and suffix, with optional metadata.

```APIDOC
## POST /accounts

### Description
Creates a new account under your profile.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/accounts

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

#### Request Body
- **accountType** (string) - Required - The type of account to create. Defaults to Savings. Allowed values: `Savings`, `Current`.
- **suffix** (string) - Required - The suffix to be added to the account name.
- **metadata** (json) - Optional - A key-value pair you can attach to the account detail.

### Response
#### Success Response (200)
Successful account creation.

#### Error Response (400)
Bad request - invalid parameters or missing required fields.

```

--------------------------------

### cURL Request for Get Service Categories

Source: https://safehavenmfb.readme.io/reference/get-service-categories

Use this cURL command to call the Get Service Categories endpoint. Replace the placeholder 'id' in the URL with the service's _id. The request requires a ClientID header containing your 'ibs_client_id' from the API token generation response.

```shell
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/service/id/service-categories \
     --header 'accept: application/json'
```

--------------------------------

### GET /vas/transaction/{id}

Source: https://safehavenmfb.readme.io/reference/get-vas-transaction

Retrieves a specific VAS transaction by its id or external reference.

```APIDOC
## GET /vas/transaction/{id}

### Description
Returns a specific transaction using the id.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/transaction/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The `_id` or `externalReference` of the transaction.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/transaction/id \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the transaction details.

#### Error Response (400)
Returns an error message.

```

--------------------------------

### GET /transfers/banks

Source: https://safehavenmfb.readme.io/reference/bank-list

Retrieves the list of all banks in Nigeria. This endpoint requires a ClientID header for authentication.

```APIDOC
## GET /transfers/banks

### Description
Returns the list of all banks in Nigeria.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/transfers/banks

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/transfers/banks \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the list of banks.

#### Error Response (400)
Returns an error message.

```

--------------------------------

### GET /vas/transactions

Source: https://safehavenmfb.readme.io/reference/get-vas-transactions

Returns all previous VAS transactions of the logged-in client. Requires a ClientID header.

```APIDOC
## GET /vas/transactions

### Description
Returns all previous VAS transactions of the logged-in client.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/transactions

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an API token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/vas/transactions \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns a list of VAS transactions. The response schema is not detailed in the source.

#### Error Response (400)
Returns an error response. The response schema is not detailed in the source.
```

--------------------------------

### POST /virtual-accounts

Source: https://safehavenmfb.readme.io/reference/create-virtual-account

Creates a virtual account with specified parameters. Requires a callback URL and settlement account details. Returns the created virtual account information.

```APIDOC
## POST /virtual-accounts

### Description
Creates a virtual account for receiving payments. The account can be configured with a validity period, settlement account, and amount control.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/virtual-accounts

### Parameters
#### Body Parameters
- **validFor** (int32) - Optional - Account validity time in seconds. Defaults to 900 (15 minutes).
- **callbackUrl** (string) - Required - An endpoint to receive payment webhook notifications. Must start with `https://`.
- **settlementAccount** (object) - Optional - Settlement account details.
  - **bankCode** (string) - Optional - Bank code for the settlement account.
- **amountControl** (string) - Required - This is required if the account is only valid for a specified time. Allowed values: `Fixed`, `UnderPayment`, `OverPayment`.
- **amount** (int32) - Required - This is required if the account is valid for a specified time.
- **externalReference** (string) - Optional - Unique per account. This will be returned on the transfer object.

### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```json
{
  "validFor": 900,
  "settlementAccount": {
    "bankCode": "090286"
  },
  "amountControl": "Fixed"
}
```

### Response
#### Success Response (200)
Returns the created virtual account details.

#### Response Example
(Not provided in source)

### Error Responses
- **400** - Bad request. See response body for details.

```

--------------------------------

### POST /vas/pay/cable-tv

Source: https://safehavenmfb.readme.io/reference/purchase-a-cable-tv-subscription

Call this endpoint to purchase a cable TV subscription. Provide the required body parameters and the ClientID header.

```APIDOC
## POST /vas/pay/cable-tv

### Description
Call this endpoint to purchase a cable TV subscription.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/vas/pay/cable-tv

### Parameters
#### Body Parameters
- **serviceCategoryId** (string) - Required - The `_id` of the service category.
- **bundleCode** (string) - Required - The bundleCode of the data bundle.
- **amount** (float) - Required - Defaults to 0. The cost of the data.
- **channel** (string) - Required - Defaults to WEB. The channel the purchase is made on. Allowed: `WEB`, `POS`, `ATM`.
- **debitAccountNumber** (string) - Required - The account number for the account to be debited.
- **cardNumber** (string) - Required - The card number of the cable TV account.
- **externalReference** (string) - Optional - An external reference to be attached to the transaction object.

#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an API token.

### Request Example
```json
{
  "serviceCategoryId": "string",
  "bundleCode": "string",
  "amount": 0,
  "channel": "WEB",
  "debitAccountNumber": "string",
  "cardNumber": "string",
  "externalReference": "string"
}
```

### Response
#### Success Response (200)
Successful response.

#### Error Response (400)
Bad request.

```

--------------------------------

### GET /transfers

Source: https://safehavenmfb.readme.io/reference/get-transfers

Fetches transfer history for a specific account. Supports pagination and filtering by date, type, and status.

```APIDOC
## GET /transfers

### Description
Returns the transfer history for a specific account according to the set parameters.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/transfers

### Parameters
#### Query Parameters
- **accountId** (string) - Required - The `_id` of the account to fetch the transfers for.
- **page** (int32) - Optional - Defaults to 0.
- **limit** (int32) - Optional - Defaults to 100.
- **fromDate** (date) - Optional - The start date of the period to fetch transfers for.
- **toDate** (date) - Optional - The end date of the period to fetch transfers for.
- **type** (string) - Optional - The type of transfers to filter by. Allowed values: `Inwards`, `Outwards`.
- **status** (string) - Optional - The status of the transfers to filter by. Allowed values: `Created`, `Initiated`, `Processing`, `Completed`, `Canceled`, `Failed`.

### Request Example
```
curl --request GET \
     --url 'https://api.sandbox.safehavenmfb.com/transfers?page=0&limit=100' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the transfer history for the specified account.

#### Response Example
(Not provided in source)

#### Error Response (400)
Returns an error if the request is invalid.

#### Response Example
(Not provided in source)
```

--------------------------------

### cURL request to verify power/cable TV data

Source: https://safehavenmfb.readme.io/reference/verify-powercable-tv-data

Use this cURL command to verify power or cable TV data. It sends a POST request to https://api.sandbox.safehavenmfb.com/vas/verify with the required headers. The request body should include serviceCategoryId and entityNumber.

```shell
curl --request POST \
     --url https://api.sandbox.safehavenmfb.com/vas/verify \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### GET /transfers/beneficiaries

Source: https://safehavenmfb.readme.io/reference/get-beneficiaries

Retrieves the list of all saved beneficiaries. This endpoint requires a ClientID header and returns a list of beneficiaries.

```APIDOC
## GET /transfers/beneficiaries

### Description
This returns the list of all saved beneficiaries.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/transfers/beneficiaries

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/transfers/beneficiaries \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the list of saved beneficiaries.

#### Response Example
(Not provided in the source)

#### Error Response (400)
Returns an error message.

#### Response Example
(Not provided in the source)
```

--------------------------------

### POST /accounts/v2/subaccount

Source: https://safehavenmfb.readme.io/reference/create-sub-account-new

Creates a sub-account (individual) with the provided details. Requires identity verification first. Returns the created sub-account information.

```APIDOC
## POST /accounts/v2/subaccount

### Description
Creates a sub-account (individual) with the provided details. Requires identity verification first. Returns the created sub-account information.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/accounts/v2/subaccount

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

#### Body Parameters
- **phoneNumber** (string) - Required - Defaults to +2348032187654. This is the phone number of the account holder. It should begin with the country code.
- **emailAddress** (string) - Required - Defaults to john.doe@mail.ng. This is the email address.
- **externalReference** (string) - Required - This is an external reference to be attached to the account object.
- **identityType** (string) - Required - Enum: NIN, vNIN, BVN, BVNUSSD, vID. Identification method the account holder, should be either NIN, vNIN, BVN, BVNUSSD, or vID (if you are using Safe Haven Verification Service).
- **identityNumber** (string) - Optional - It is required when using `BVN`, `NIN`, and `BVNUSSD`. Not required if you are using `vID`.
- **identityId** (string) - Optional - The `_id` from the Safe Haven Verification Endpoint. It is required when `vID`, `BVN`, or `NIN`.
- **otp** (string) - Optional - The OTP sent to the customer's phone number when you initiate verification using Safe Haven verification endpoint. This works for `BVN` and `NIN` or the OTP sent to customer's phone number when using `BVNUSSD`.
- **callbackUrl** (string) - Optional - If not provided, the webhook URL on your Dashboard will be used.
- **autoSweep** (boolean) - Optional - Defaults to false. This should be set when creating a virtual account. It determines if auto sweep should be enabled or disabled.
- **autoSweepDetails** (object) - Optional - This contains the auto sweep details to be filled if creating a virtual account.

### Request Example
```json
{
  "phoneNumber": "+2348032187654",
  "emailAddress": "john.doe@mail.ng",
  "externalReference": "string",
  "identityType": "BVN",
  "identityNumber": "string",
  "identityId": "string",
  "otp": "string",
  "callbackUrl": "string",
  "autoSweep": false,
  "autoSweepDetails": {}
}
```

### Response
#### Success Response (200)
Returns the created sub-account details.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "subAccountId": "string",
    "accountNumber": "string",
    "accountName": "string",
    "bankName": "string",
    "bankCode": "string"
  }
}
```

#### Error Response (400)
Returns an error message if the request is invalid.

#### Response Example
```json
{
  "status": "error",
  "message": "string"
}
```
```

--------------------------------

### GET /accounts/:id

Source: https://safehavenmfb.readme.io/reference/accounts

Fetches a specific account by its ID. This endpoint is part of the Accounts API and is used to retrieve account details.

```APIDOC
## GET /accounts/:id

### Description
Fetches a specific account by its ID.

### Method
GET

### Endpoint
/accounts/:id

```

--------------------------------

### GET /virtual-accounts/{virtualAccountId}/transaction

Source: https://safehavenmfb.readme.io/reference/get-virtual-transaction

Retrieves a virtual account transaction by its virtual account ID. The virtualAccountId path parameter is required.

```APIDOC
## GET /virtual-accounts/{virtualAccountId}/transaction

### Description
Retrieves a virtual account transaction by its virtual account ID.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/virtual-accounts/{virtualAccountId}/transaction

### Parameters
#### Path Parameters
- **virtualAccountId** (string) - Required - _id of the virtual account

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/virtual-accounts/virtualAccountId/transaction \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the transaction details.

#### Response Example
(Not provided in source)

#### Error Response (400)
Returns an error message.

#### Response Example
(Not provided in source)
```

--------------------------------

### GET /accounts/:id/statement

Source: https://safehavenmfb.readme.io/reference/accounts

Fetches the statement for a specific account by its ID. This endpoint is part of the Accounts API and is used to retrieve account statements.

```APIDOC
## GET /accounts/:id/statement

### Description
Fetches the statement for a specific account by its ID.

### Method
GET

### Endpoint
/accounts/:id/statement

```

--------------------------------

### GET /ussd-payment/banks

Source: https://safehavenmfb.readme.io/reference/ussd-banks-list

Retrieves the list of banks supported for USSD payments. Requires a ClientID header containing the 'ibs_client_id' obtained from API token generation.

```APIDOC
## GET /ussd-payment/banks

### Description
Retrieves the list of banks supported for USSD payments. Requires a ClientID header containing the 'ibs_client_id' obtained from API token generation.

### Method
GET

### Endpoint
https://api.sandbox.safehavenmfb.com/ussd-payment/banks

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

### Request Example
```
curl --request GET \
     --url https://api.sandbox.safehavenmfb.com/ussd-payment/banks \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns a list of banks. The response schema is not detailed in the source.

#### Error Response (400)
Returns an error response. The response schema is not detailed in the source.

```

--------------------------------

### POST /accounts/v2/subaccount/

Source: https://safehavenmfb.readme.io/reference/create-sub-account-corporate

Creates a corporate sub-account. Requires prior identity verification of at least one director. Accepts corporate details and optional auto-sweep settings.

```APIDOC
## POST /accounts/v2/subaccount/

### Description
Creates a corporate sub-account. Requires prior identity verification of at least one director.

### Method
POST

### Endpoint
https://api.sandbox.safehavenmfb.com/accounts/v2/subaccount/

### Parameters
#### Headers
- **ClientID** (string) - Required - This is your 'ibs_client_id' returned in the response when you generate an api token.

#### Request Body
- **phoneNumber** (string) - Required - Defaults to +2348032187654. This is the phone number of the account holder. It should begin with the country code.
- **emailAddress** (string) - Required - Defaults to john.doe@mail.ng. This is the email address.
- **externalReference** (string) - Required - This is an external reference to be attached to the account object.
- **identityType** (string) - Required - Defaults to vID. Identification method the account holder, should be vID (Provided you have Validated the KYC of at least one director of the company).
- **identityId** (string) - Required - The `_id` from the Safe Haven Verification Endpoint.
- **companyRegistrationNumber** (string) - Required - Defaults to 1234567. The should be the company's RC or BN Number.
- **callbackUrl** (string) - Optional - If not provided, the webhook URL on your Dashboard will be used.
- **autoSweep** (boolean) - Optional - Defaults to false. This should be set when creating a virtual account. It determines if auto sweep should be enabled or disabled.
- **autoSweepDetails** (object) - Optional - This contains the auto sweep details to be filled if creating a virtual account.

#### autoSweepDetails object
- (fields not specified in source)

### Request Example
```json
{
  "phoneNumber": "+2348032187654",
  "emailAddress": "john.doe@mail.ng",
  "externalReference": "string",
  "identityType": "vID",
  "identityId": "string",
  "companyRegistrationNumber": "1234567",
  "callbackUrl": "string",
  "autoSweep": false,
  "autoSweepDetails": {}
}
```

### Response
#### Success Response (200)
- (response schema not specified in source)

#### Response Example
(not provided in source)

#### Error Response (400)
- (error schema not specified in source)

#### Error Example
(not provided in source)
```

--------------------------------

### POST /accounts

Source: https://safehavenmfb.readme.io/reference/accounts

Creates a new account. This endpoint is part of the Accounts API and is used to create accounts.

```APIDOC
## POST /accounts

### Description
Creates a new account.

### Method
POST

### Endpoint
/accounts

```
Tokens:
Raw