PayU Kenya
API Version
Minimum required API version: 1.1.0
Payment Methods
Server-to-Server Integrations
The tables below lists payment methods that are supported through a server-to-server integration and through the PayU payment page. When integrating a payment method, the Authorization, Capture and Charge request types are supported unless stated otherwise in the Only for Requests column.
Payment Method | Payment Method Type | Only for Requests |
---|---|---|
Airtel Money | eWallet | Charge |
EFT (MOBILE BANKING) | Bank Transfer | Charge |
EQUITEL | eWallet | Charge |
MASTERCARD | Cards | |
MPESA | eWallet | Charge |
VISA | Cards |
Payment Page
The following table lists all supported payment methods available on the PayU payment page. For each supported payment method, the API Value column list the value you need to pass in the payment_method.additional_details.supported_payment_methods
array of the Create Charge request.
Payment Method | API Value | Only for Requests |
---|---|---|
Airtel | AIRTEL_MONEY | Charge |
EFT (MOBILE BANKING) | MOBILE_BANKING | Charge |
Equitel | EQUITEL | Charge |
MASTERCARD | CREDITCARD | |
MPESA | MPESA | Charge |
VISA | CREDITCARD |
Currencies
KES, USD
Features
The following table provides an overview of all supported and non-supported features.
Feature | Supported |
---|---|
3DS 2.0 External | No |
3DS 2.0 PaymentsOS-handled | No |
3DS 2.0 Provider-handled | Yes |
3DS 2.0 Self-handled | No |
Installments | No |
Level 2 and 3 Data | No |
Multi-seller Payments | No |
Network Tokens | No |
Payment Facilitator | No |
PayU Risk | No |
Pre-authorization | No |
Retrieve Supported Payment Methods | No |
Retrieve Supported Plans | No |
Statement Soft Descriptor | No |
Stored Credentials Flag | No |
Transaction Processing without CVV | Yes |
Requests
The following table lists all supported requests for card-based transactions. Use the bodybuilder to create a sample request body for each request type.
Request | Partial/Multiple | Mode | Notes |
---|---|---|---|
Authorize | Partial and multiple are not supported | Asynchronous | The request can be synchronous or asynchronous, depending on whether you implemented a 3DS flow. |
Capture | Partial is supported | Synchronous | |
Charge | Not Applicable | Asynchronous | The request can be synchronous or asynchronous, depending on whether you implemented a 3DS flow. |
Refund | Both partial and multiple are supported | Synchronous | |
Void | Not Applicable | Synchronous |
Setup Procedures
Creating a provider configuration
When creating a new provider configuration in the PaymentsOS Control Center, select PayU Kenya as the provider.The following table lists the setup procedures that are specific to this provider.
Configuration | Required/Optional |
---|---|
In the PaymentsOS Control Center, configure the following credentials:
| Required |
In your PayU Kenya account, verify whether 3DS is configured to be optional or required and handle the 3DS flow accordingly. For more information, see Enabling 3DS below. Contact PayU Kenya support for assistance. | Required |
In your PayU Kenya account, disable the cvv check if you do not require customers to enter their cvv code when initiating a payment. Contact PayU Kenya support for assistance. | Optional |
In your PayU Kenya account, enable the payment methods you want to display in the payment page. For more information, see Implementing a Payment Page Flow below. Contact PayU Kenya support for assistance. | Optional |
If you want to use our End-to-End Encryption Service, configure the public key generated with PayU Kenya in the PublicJWK field in your PaymentsOS account. | Optional |
Integration Procedures
The following sections list the integration procedures that are specific to this provider.
Enabling 3DS
Note
3DS must be implemented as part of a redirection flow. For an overview of how to implement a redirection flow, see Implementing a Redirection Flow.If you require 3DS, contact PayU Kenya support to configure the following IPN URLs in your PayU Kenya environment:
- For working with the PaymentsOS test environment: https://api.paymentsos.com/callbacks/magellan/test/redirection
- For working with the PaymentsOS live environment: https://api.paymentsos.com/callbacks/magellan/live/redirection
After configuring the IPN URLs, configure Webhooks in your PaymentsOS environment to receive updates when a change in a transaction status occurs.
Note that in your PayU Kenya account, you can configure 3DS to be either required (force 3DS) or optional. If you configured your account to enforce 3DS, then the user will always be required to complete a 3DS authentication step. If you configured 3DS to be optional and you want the user to complete a 3DS authentication step, then include a provider_specific_data
object with an is3ds
value of true
in your Create Authorization or Create Charge API requests.
"provider_specific_data": {
"magellan": {
"additional_details": {
"is3ds": "true"
}
}
}
Regardless of whether 3DS is set to required or optional, PayU Kenya will only direct a user to complete a 3DS authentication flow if a user’s card is enrolled for 3DSecure.
Bear in mind that a 3DS redirection flow requires that you pass a merchant_site_url
in the Create Authorization or Create Charge request. If you do not pass a merchant_site_url
, the user will not be able to complete the 3DS authentication flow. The response data of the Create Authorization or Create Charge request will indicate this in the additional_details.error
field:
{
"additional_details": {
"error": "The transaction requires 3DS authentication, but cannot be completed as the merchant_site_url was not provided"
}
...
}
Note
If the user could not complete the 3DS authentication flow, the transaction will remain in statusPending
. After 40 minutes, the transaction will transition to a status of Failed
.
Implementing a Payment Page Flow
If desired, you can implement a payment flow in which users are redirected to a payment page where they can then select their payment method of choice. This flow is identical to a redirection flow, in which the response of the Create Charge request returns a Redirection
object that includes the URL of the payment page to which you can redirect the user. Just make sure that your Create Charge request includes a payment_method.additional_details.supported_payment_methods
field with a comma separated list of the payment methods you want to show in the payment page:
{
"payment_method": {
"source_type": "payment_page",
"type": "untokenized",
"additional_details": {
"supported_payment_methods": "CREDITCARD,[SEE TABLE SUPPORTED PAYMENT METHODS]"
}
}
}
A few caveats:
-
In your PayU account, you must enable the payment methods you want to show in the payment page.
-
Authorize and Capture requests are not supported in a payment page flow.
-
When using the BodyBuilder to generate sample requests, make sure to choose the Payment Page payment type.
Testing
You can use the test cards from the PayU Kenya Test Credentials site.