If you are using Android Components v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Components integration guide and use the following module and Component names:
- To import the module:
- To launch and show the Component: InstantPaymentComponent
If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the Fawry app or website where they can complete the payment.
When making an Fawry payment, you need to:
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have an existing Advanced flow Android Components integration. |
Setup steps | Before you begin, add Fawry in your Customer Area. |
Show Fawry in your payment form
Include Fawry in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.
-
Specify in your /paymentMethods request:
- countryCode: EG
- amount.currency: EGP
- amount.value: The value of the payment.
The response contains
paymentMethod.type
: fawry.
We provide logos for Fawry which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
When the shopper proceeds to pay, you need to:
-
From your server, make a /payments request, specifying:
paymentMethod.type
: Set this to fawry.- shopperName: The shopper's full name.
- shopperEmail: The shopper's email address.
- telephoneNumber: The shopper's telephone number.
returnUrl
: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in theRedirectComponent.getReturnUrl(context)
.
In the /payments response, note the
action
object. This contains the information needed to redirect the shopper.
- Pass the
action
object to your client app.
Handle the redirect
-
Use the Redirect Component to redirect the shopper to Fawry.
-
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
details
: TheactionComponentData.details
object from the Redirect Component.
You receive a response containing:
resultCode
: Use this to present the payment result to your shopper.pspReference
: Our unique identifier for the transaction.
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode
values you can receive for Fawry are:
resultCode | Description | Action to take |
---|---|---|
Authorised | The payment was successful. | Inform the shopper that the payment has been successful. |
Cancelled | The shopper cancelled the payment while on Fawry's website. | Ask the shopper whether they want to continue with the order, or ask them to select a different payment method. |
Error | There was an error when the payment was being processed. | Inform the shopper that there was an error processing their payment. The response contains a refusalReason , indicating the cause of the error. |
Pending or Received |
The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you have received their order, and are waiting for the payment to be completed. To know the final result of the payment, wait for the AUTHORISATION webhook. |
Refused | The payment was refused by the Fawry. | Ask the shopper to try the payment again using a different payment method. |
If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment. The webhooks you can receive for Fawry are:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
OFFER_CLOSED | true | The shopper did not complete the payment. | Cancel the order and inform the shopper that the payment timed out. |
Test and go live
Before you can accept live Fawry payments, you need to submit a request for Fawry in your live Customer Area.