Skip to main content
GET
/
v2
/
active-conf
Active Configuration
curl --request GET \
  --url https://api.sandbox.pawapay.io/v2/active-conf \
  --header 'Authorization: Bearer <token>'
{
  "companyName": "Merchant Inc.",
  "signatureConfiguration": {
    "signedRequestsOnly": true,
    "signedCallbacks": true
  },
  "countries": [
    {
      "country": "BEN",
      "displayName": {
        "en": "Benin",
        "fr": "Le Benin"
      },
      "prefix": "229",
      "flag": "https://cdn.com/ben_flag.png",
      "providers": [
        {
          "provider": "MTN_MOMO_BEN",
          "displayName": "MTN",
          "logo": "https://cdn.com/mtn_logo.png",
          "nameDisplayedToCustomer": "Merchant Inc.",
          "currencies": [
            {
              "currency": "XOF",
              "displayName": "KSh",
              "operationTypes": [
                {
                  "DEPOSIT": {
                    "authType": "PROVIDER_AUTH",
                    "pinPrompt": "AUTOMATIC",
                    "pinPromptRevivable": true,
                    "pinPromptInstructions": {
                      "channels": [
                        {
                          "type": "USSD",
                          "displayName": {
                            "en": "Not getting the PIN prompt?",
                            "fr": "Not getting Le Pin prompt"
                          },
                          "quickLink": "tel*182*1*3%23",
                          "variables": {
                            "shortCode": "*182#"
                          },
                          "instructions": {
                            "en": [
                              {
                                "text": "Dial *182# on your phone",
                                "template": "Dial {{shortCode}} on your phone"
                              }
                            ],
                            "fr": [
                              {
                                "text": "Composez *182# sur votre téléphone",
                                "template": "Composez {{shortCode}} sur votre téléphone"
                              }
                            ]
                          }
                        }
                      ]
                    },
                    "minTransactionLimit": "1",
                    "maxTransactionLimit": "1000",
                    "decimalsInAmount": "NONE",
                    "status": "OPERATIONAL",
                    "callbackUrl": "https://merchant.com/depositCallback"
                  }
                },
                {
                  "operationType": "PAYOUT",
                  "minTransactionLimit": "1",
                  "maxTransactionLimit": "1000",
                  "decimalsInAmount": "NONE",
                  "status": "DELAYED",
                  "callbackUrl": "https://merchant.com/payoutCallback"
                },
                {
                  "operationType": "REFUND",
                  "minTransactionLimit": "1",
                  "maxTransactionLimit": "1000",
                  "decimalsInAmount": "NONE",
                  "status": "CLOSED",
                  "callbackUrl": "https://merchant.com/refundCallback"
                },
                {
                  "operationType": "REMITTANCE",
                  "minTransactionLimit": "1",
                  "maxTransactionLimit": "1000",
                  "decimalsInAmount": "NONE",
                  "status": "OPERATIONAL",
                  "callbackUrl": "https://merchant.com/remittanceCallback"
                },
                {
                  "operationType": "USSD_DEPOSIT",
                  "callbackUrl": "https://merchant.com/ussdCallback"
                },
                {
                  "operationType": "NAME_LOOKUP"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
Allows you to query your configuration including the countries and providers that have been configured for your account. You can also retrieve supporting information about your configuration:
  • Your company name on your pawaPay account.
  • The currencies supported by the providers.
  • The deposit authorisation types of each provider.
  • Minimum and maximum amounts for deposits, payouts and refunds.
  • The name of the company that is shown to the customer on the PIN prompt and/or SMS receipt.
  • Instructions to show to the customer for different mechanism of payment authorisation
  • And more…

Authorizations

​
Authorization
string
header
required

See Authentication.

Query Parameters

​
country
string

The country you wish to limit the results to.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from wikipedia.

Required string length: 3
Example:

"ZMB"

​
operationType
enum<string>

The operation you wish to limit the results to.

Available options:
DEPOSIT,
PAYOUT,
REMITTANCE,
PUSH_DEPOSIT,
REFUND,
NAME_LOOKUP

Response

If a request has been processed by pawaPay successfully.

​
companyName
string
required

Your company name as configured on your pawaPay account.

Example:

"Merchant Inc."

​
signatureConfiguration
object
required
​
countries
object[]
required