--- title: "Active Configuration" method: GET path: "/v2/active-conf" tags: ["toolkit"] --- # Active Configuration `GET /v2/active-conf` ## Query parameters - `country` string - `operationType` 'DEPOSIT' | 'PAYOUT' | 'REMITTANCE' | 'PUSH_DEPOSIT' | 'REFUND' | 'NAME_LOOKUP' ## Response `200` If a request has been processed by PawaPay successfully. - CustomerActiveConfigResponse - `companyName` string, required — Your company name as configured on your PawaPay account. - `signatureConfiguration` object, required - `signedRequestsOnly` boolean — Indicates whether you have forced all financial requests to be signed on your PawaPay account. - `signedCallbacks` boolean — Indicates whether you have enabled callbacks to be signed by PawaPay. - `countries` CustomerActiveCountryConfigResponse[], required - `country` string, required — The country that has been configured for your PawaPay account. 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). - `displayName` object, required — The name of the country - `en` string - `fr` string - `prefix` string, required — The calling code for this country. - `flag` string, required — The URL to a flag for this country. - `providers` CustomerActiveGatewayConfigResponse[], 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). - `displayName` string, required — The commonly used name for the provider. - `nameDisplayedToCustomer` string, required — The name of the company that is shown to the customer on the PIN prompt and/or SMS receipt. - `currencies` CustomerActiveCurrencyConfigResponse[], required — The currencies that this provider supports for payments. - `currency` string, required — The currency code for the supported currency. Format must be the ISO 4217 three character currency code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). - `displayName` string, required — The commonly used abbreviation for this currency. - `operationTypes` object, required — The operation types that have been configured for this provider on your PawaPay account. - `DEPOSIT` CustomerActiveDepositOperationTypeConfigResponse - `authType` 'PROVIDER_AUTH' | 'PREAUTH' | 'REDIRECT_AUTH' — Indicates the authorisation type that this provider uses for authorising deposits. - `pinPrompt` 'AUTOMATIC' | 'MANUAL' — If the provider uses 'PROVIDER_AUTH' type, indicates whether the PIN-prompt will open automatically or the customer needs to take action for it. - `pinPromptRevivable` boolean — 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. - `pinPromptInstructions` Instructions - … - `authTokenInstructions` Instructions - … - `minAmount` string — Minimum amount allowed for this provider for this operation type. - `maxAmount` string — Maximum amount allowed for this provider for this operation type. - `decimalsInAmount` 'TWO_PLACES' | 'NONE' — THe amount of decimals that this provider allows in `amount`. - `status` 'OPERATIONAL' | 'DELAYED' | 'CLOSED' — 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. - `callbackUrl` string — The callback URL that you have configured for this operation type. - `PAYOUT` CustomerActiveGenericOperationTypeConfigResponse - `minAmount` string — Minimum amount allowed for this provider for this operation type. - `maxAmount` string — Maximum amount allowed for this provider for this operation type. - `decimalsInAmount` 'TWO_PLACES' | 'NONE' — THe amount of decimals that this provider allows in `amount`. - `status` 'OPERATIONAL' | 'DELAYED' | 'CLOSED' — 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. - `callbackUrl` string — The callback URL that you have configured for this operation type. - `REMITTANCE` CustomerActiveGenericOperationTypeConfigResponse - `minAmount` string — Minimum amount allowed for this provider for this operation type. - `maxAmount` string — Maximum amount allowed for this provider for this operation type. - `decimalsInAmount` 'TWO_PLACES' | 'NONE' — THe amount of decimals that this provider allows in `amount`. - `status` 'OPERATIONAL' | 'DELAYED' | 'CLOSED' — 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. - `callbackUrl` string — The callback URL that you have configured for this operation type. - `REFUND` CustomerActiveGenericOperationTypeConfigResponse - `minAmount` string — Minimum amount allowed for this provider for this operation type. - `maxAmount` string — Maximum amount allowed for this provider for this operation type. - `decimalsInAmount` 'TWO_PLACES' | 'NONE' — THe amount of decimals that this provider allows in `amount`. - `status` 'OPERATIONAL' | 'DELAYED' | 'CLOSED' — 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. - `callbackUrl` string — The callback URL that you have configured for this operation type. - `USSD_DEPOSIT` object — Configuration for handling USSD deposits. - `callbackUrl` string — The callback URL that you have configured for this operation type. ## Other responses - `401` — Authentication failed. Make sure you have added the API token into the header. If using signatures, make sure they are valid. - `403` — Authorization failure. Please check your authentication token. - `500` — An unknown failure has occurred. --- [API](https://skmtc.net/pawapay/apis/pawapay-merchant-api-v2.md) · [All operations](https://skmtc.net/pawapay/apis/pawapay-merchant-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pawapay/pawapay-merchant-api-v2/revisions/ce13c31e9746/schema)