Active Configuration
curl --request GET \
--url https://api.sandbox.pawapay.io/active-conf \
--header 'Authorization: Bearer <token>'
{
"merchantId": "MERCHANT_INC",
"merchantName": "Merchant Inc.",
"countries": [
{
"country": "GHA",
"correspondents": [
{
"correspondent": "AIRTELTIGO_GHA",
"currency": "GHS",
"ownerName": "Merchant Inc.",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
},
{
"operationType": "PAYOUT",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
},
{
"operationType": "REFUND",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
}
]
},
{
"correspondent": "MTN_MOMO_GHA",
"currency": "GHS",
"ownerName": "Merchant Inc.",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
},
{
"operationType": "PAYOUT",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
},
{
"operationType": "REFUND",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
}
]
}
]
},
{
"country": "ZMB",
"correspondents": [
{
"correspondent": "AIRTEL_OAPI_ZMB",
"currency": "ZMW",
"ownerName": "pawaPay Zambia",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "10000"
}
]
},
{
"correspondent": "MTN_MOMO_ZMB",
"currency": "ZMW",
"ownerName": "pawaPay Zambia",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "10000"
}
]
}
]
}
]
}
Allows you to query the MMOs (correspondents) that have been configured for your account. You can also retrieve supporting information about your configuration:
- Your company name on your pawaPay account.
- The currency for the MMO.
- Minimum and maximum amounts for deposits, payouts and refunds.
- The name of the company that is shown to the customer on the SMS receipt (
ownerName
).
Authorizations
See Authentication.
Response
Your unique alphanumeric ID in the pawaPay platform.
"MERCHANT_INC"
Your company name as configured in the pawaPay platform.
"Merchant Inc."
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.
"ZMB"
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.
The active configuration endpoint provides the list of correspondents configured for your account.
You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).
"MTN_MOMO_ZMB"
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.
You can find all the supported currencies that the specific correspondent
supports from here.
The active configuration endpoint provides the list of correspondents configured for your account together with the currencies.
"ZMW"
DEPOSIT
, PAYOUT
, PUSH_DEPOSIT
, REFUND
"DEPOSIT"
Minimum transaction amount allowed for this correspondent for this operation type.
"1.0000"
Maximum transaction amount allowed for this correspondent for this operation type.
"10000.0000"
The name of the company that is shown to the customer on the SMS receipt.
Was this page helpful?
curl --request GET \
--url https://api.sandbox.pawapay.io/active-conf \
--header 'Authorization: Bearer <token>'
{
"merchantId": "MERCHANT_INC",
"merchantName": "Merchant Inc.",
"countries": [
{
"country": "GHA",
"correspondents": [
{
"correspondent": "AIRTELTIGO_GHA",
"currency": "GHS",
"ownerName": "Merchant Inc.",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
},
{
"operationType": "PAYOUT",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
},
{
"operationType": "REFUND",
"minTransactionLimit": "1",
"maxTransactionLimit": "1000"
}
]
},
{
"correspondent": "MTN_MOMO_GHA",
"currency": "GHS",
"ownerName": "Merchant Inc.",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
},
{
"operationType": "PAYOUT",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
},
{
"operationType": "REFUND",
"minTransactionLimit": "1",
"maxTransactionLimit": "2000"
}
]
}
]
},
{
"country": "ZMB",
"correspondents": [
{
"correspondent": "AIRTEL_OAPI_ZMB",
"currency": "ZMW",
"ownerName": "pawaPay Zambia",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "10000"
}
]
},
{
"correspondent": "MTN_MOMO_ZMB",
"currency": "ZMW",
"ownerName": "pawaPay Zambia",
"operationTypes": [
{
"operationType": "DEPOSIT",
"minTransactionLimit": "1",
"maxTransactionLimit": "10000"
}
]
}
]
}
]
}