Payouts
Remittances
Payment page
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"
}
]
}
]
}
]
}
]
}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"
}
]
}
]
}
]
}
]
}- 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
See Authentication.
Query Parameters
The operation you wish to limit the results to.
DEPOSIT, PAYOUT, REMITTANCE, PUSH_DEPOSIT, REFUND, NAME_LOOKUP Response
If a request has been processed by pawaPay successfully.
Your company name as configured on your pawaPay account.
"Merchant Inc."
Show child attributes
Show child attributes
The calling code for this country.
"229"
The URL to a flag for this country.
"https://cdn.com/ben_flag.svg"
Show child attributes
Show child attributes
The provider represents the mobile money operator or processor that can process payments.
Find here a list of all the supported providers.
The active configuration endpoint provides the list of provider configured for your account.
You can use the predict provider enpoint to predict the provider to use based on the phone number (MSISDN).
"MTN_MOMO_ZMB"
The commonly used name for the provider.
The name of the company that is shown to the customer on the PIN prompt and/or SMS receipt.
The currencies that this provider supports for payments.
Show child attributes
Show child attributes
The commonly used abbreviation for this currency.
The operation types that have been configured for this provider on your pawaPay account.
Show child attributes
Show child attributes
Configuration for initiating deposits.
Show child attributes
Show child attributes
Indicates the authorisation type that this provider uses for authorising deposits.
PROVIDER_AUTH, PREAUTH, REDIRECT_AUTH If the provider uses 'PROVIDER_AUTH' type, indicates whether the PIN-prompt will open automatically or the customer needs to take action for it.
AUTOMATIC, MANUAL If the provider uses 'PROVIDER_AUTH' type, indicates whether it is possible for the customer to revive the PIN prompt in cases where it times out before they can authorise the payment.
Shows the instruction to show to the customer for when the authorisation is either:
- MANUAL
- pinPromptRevivable is true.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shows through which channel these instructions can be completed by the customer.
USSD, APP Short instruction for when these instructions should be follow by the customer. See example.
{
"en": "Not getting the PIN prompt?",
"fr": "Je ne reçois pas l’invite de code PIN."
}A quicklink to take the customer further in the instructions. For example, predialing a USSD shortcode.
"tel*182*1*3%23"
A map of variables for values used in the 'template' of 'instructions'. You can use the tempalte if you are looking to add emphasis to key vairbales like the number to dial or the options to choose.
Show child attributes
Show child attributes
[{ "shortCode": "*182#" }]List of instructions to show to the customer.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
This is the prerendered instruction that can be shown to the customer.
This is the template for the instruction. The variables can be emphasised and replace in the tempalte to get the final instruction.
Show child attributes
Show child attributes
This is the prerendered instruction that can be shown to the customer.
This is the template for the instruction. The variables can be emphasised and replace in the tempalte to get the final instruction.
In case of PREAUTH type, includes the instruction how the customer can preauhtorise the payment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shows through which channel these instructions can be completed by the customer.
USSD, APP Short instruction for when these instructions should be follow by the customer. See example.
{
"en": "Not getting the PIN prompt?",
"fr": "Je ne reçois pas l’invite de code PIN."
}A quicklink to take the customer further in the instructions. For example, predialing a USSD shortcode.
"tel*182*1*3%23"
A map of variables for values used in the 'template' of 'instructions'. You can use the tempalte if you are looking to add emphasis to key vairbales like the number to dial or the options to choose.
Show child attributes
Show child attributes
[{ "shortCode": "*182#" }]List of instructions to show to the customer.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
This is the prerendered instruction that can be shown to the customer.
This is the template for the instruction. The variables can be emphasised and replace in the tempalte to get the final instruction.
Show child attributes
Show child attributes
This is the prerendered instruction that can be shown to the customer.
This is the template for the instruction. The variables can be emphasised and replace in the tempalte to get the final instruction.
Minimum amount allowed for this provider for this operation type.
"1"
Maximum amount allowed for this provider for this operation type.
"100000"
THe amount of decimals that this provider allows in amount.
TWO_PLACES, NONE 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.
OPERATIONAL, DELAYED, CLOSED The callback URL that you have configured for this operation type.
Configuration for initiating payouts.
Show child attributes
Show child attributes
Minimum amount allowed for this provider for this operation type.
"1"
Maximum amount allowed for this provider for this operation type.
"100000"
THe amount of decimals that this provider allows in amount.
TWO_PLACES, NONE 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.
OPERATIONAL, DELAYED, CLOSED The callback URL that you have configured for this operation type.
Configuration for initiating remittances.
Show child attributes
Show child attributes
Minimum amount allowed for this provider for this operation type.
"1"
Maximum amount allowed for this provider for this operation type.
"100000"
THe amount of decimals that this provider allows in amount.
TWO_PLACES, NONE 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.
OPERATIONAL, DELAYED, CLOSED The callback URL that you have configured for this operation type.
Show child attributes
Show child attributes
Minimum amount allowed for this provider for this operation type.
"1"
Maximum amount allowed for this provider for this operation type.
"100000"
THe amount of decimals that this provider allows in amount.
TWO_PLACES, NONE 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.
OPERATIONAL, DELAYED, CLOSED The callback URL that you have configured for this operation type.
Was this page helpful?