# Active Configuration

Endpoint: GET /active-conf
Version: v1
Security: bearerAuth

## Response 200 fields (application/json):

  - `merchantId` (string, required)
    Your unique alphanumeric ID in the Blu Penguin platform.
    Example: "MERCHANT_INC"

  - `merchantName` (string, required)
    Your company name as configured in the Blu Penguin platform.
    Example: "Merchant Inc."

  - `countries` (array, required)

  - `countries.country` (string, required)
    The country in which the MMO operates. 

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).
    Example: "ZMB"

  - `countries.correspondents` (array, required)

  - `countries.correspondents.correspondent` (string, required)
    The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with. 

You can find all the supported correspondents [listed here](https://docs.transaction-monitor.io/using_the_api#correspondents). 

The [active configuration](#/paths/~1active-conf/get) endpoint provides the list of correspondents configured for your account.

You can use the [predict correspondent](#/paths/~1v1~1predict-correspondent/post) enpoint to predict the correct correspondent to use based on the phone number (MSISDN).
    Example: "MTN_MOMO_ZMB"

  - `countries.correspondents.currency` (string, required)
    The currency in which the amount is specified.

Format must be the ISO 4217 three character currency code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).

You can find all the supported currencies that the specific correspondent supports [from here](https://docs.transaction-monitor.io/using_the_api#correspondents).

The [active configuration](#/paths/~1active-conf/get) endpoint provides the list of correspondents configured for your account together with the currencies.
    Example: "ZMW"

  - `countries.correspondents.ownerName` (string)
    The name of the company that is shown to the customer on the SMS receipt.

  - `countries.correspondents.operationTypes` (array, required)

  - `countries.correspondents.operationTypes.operationType` (string, required)
    Enum: "DEPOSIT", "PAYOUT", "PUSH_DEPOSIT", "REFUND"

  - `countries.correspondents.operationTypes.minTransactionLimit` (string, required)
    Minimum transaction amount allowed for this correspondent for this operation type.
    Example: "1.0000"

  - `countries.correspondents.operationTypes.maxTransactionLimit` (string, required)
    Maximum transaction amount allowed for this correspondent for this operation type.
    Example: "10000.0000"

## Response 401 fields (application/json):

  - `errorId` (string, required)
    A unique error ID in the Blu Penguin platform.
    Example: "63743264-7292-11ea-bc55-0242ac130003"

  - `errorCode` (integer, required)
    Blu Penguin internal error code.
    Example: 1

  - `errorMessage` (string, required)
    Error message.
    Example: "Internal error"

## Response 500 fields (application/json):

  - `errorId` (string, required)
    A unique error ID in the Blu Penguin platform.
    Example: "63743264-7292-11ea-bc55-0242ac130003"

  - `errorCode` (integer, required)
    Blu Penguin internal error code.
    Example: 1

  - `errorMessage` (string, required)
    Error message.
    Example: "Internal error"