---
title: "Provider Availability"
method: GET
path: "/v2/availability"
tags: ["toolkit"]
---

# Provider Availability

`GET /v2/availability`

## Request

- Base URL: `https://api.sandbox.pawapay.io`
- URL: `https://api.sandbox.pawapay.io/v2/availability`
- Auth: HTTP bearer

## Query parameters

- `country` string: The country in which the payment was initiated. 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).
- `operationType` 'DEPOSIT' | 'PAYOUT' | 'REFUND' | 'REMITTANCE'

## Response `200`

If a request has been processed by PawaPay successfully.

- GatewayAvailabilityStatusResult[]
  - `country` string, required: The country in which the payment was initiated. 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).
  - `providers` GatewayAvailabilityProviderResult[], required
    - `provider` string, required: The provider represents the mobile money operator or processor that can process payments. Find here a list of all the supported [providers](/v2/docs/providers). The [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint provides the list of provider configured for your account. You can use the [predict provider](/v2/api-reference/toolkit/predict-provider) enpoint to predict the provider to use based on the phone number (MSISDN).
    - `operationTypes` GatewayAvailabilityOperationTypeResult[], required
      - `operationType` 'DEPOSIT' | 'PAYOUT' | 'REMITTANCE' | 'REFUND', required: The type of operation for which the availability status applies. * `PAYOUT` - Relates to payout transactions. * `DEPOSIT` - Relates to deposit transactions. * `REMITTANCE` - Relates to remittance transactions. * `REFUND` - Related to refund transaction.
      - `status` 'OPERATIONAL' | 'DELAYED' | 'CLOSED', required: Possible operation statuses for providers and their operation types: * `OPERATIONAL` - The provider is operational and open for processing requests. * `DELAYED` - The provider is having problems processing payouts. Our payment operations team is currently monitoring the provider. Payouts are being enqueued and will be processed once the problems have been resolved. * `CLOSED` - The provider is having problems and all requests are being rejected by PawaPay.

## Other responses

- `500`: An unknown failure has occurred.

---

[API](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2.md) - [All operations](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/revisions/4556d2ec2141?raw)