# Correspondent Availability

Endpoint: GET /availability
Version: v1
Security: 

## Response 200 fields (application/json):

  - `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"

  - `correspondents` (array, required)

  - `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"

  - `correspondents.operationTypes` (array, required)

  - `correspondents.operationTypes.operationType` (string, required)
    The type of financial operation for which the operation status applies.  
* PAYOUT -  Relates to payout (disbursement) and refund transactions. 
* DEPOSIT - Relates to deposit (collection) transactions.
    Enum: "PAYOUT", "DEPOSIT"

  - `correspondents.operationTypes.status` (string, required)
    Possible operation statuses for correspondents and their operation types: 
* OPERATIONAL -  The MMO (correspondent) is operational and open for processing requests.
* DELAYED - The MMO (correspondent) is having problems processing payouts. Our payment operations team is currently monitoring the MMO. Payouts are being enqueued and will be processed once the problems have been resolved.  
* CLOSED - The MMO (correspondent) is having problems and all requests are being rejected by Blu Penguin.
    Enum: "OPERATIONAL", "DELAYED", "CLOSED"

## 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"