Fawry

Start accepting payments using Fawry, the dominant payment method in Egypt.

Use the details below to set up your request.

You can find the full list, as well as complete request and response examples, in our API reference.

json
1{
2  "amount": 1000,
3  "currency": "EGP",
4  "source": {
5    "type": "fawry",
6    "description": "Fawry Demo Payment",
7    "customer_mobile": "01058375055",
8    "customer_email": "john.smith@example.com",
9    "products": [
10      {
11        "product_id": "0123456789",
12        "quantity": 1,
13        "price": 1000,
14        "description": "Fawry Demo Product"
15      }
16    ]
17  }
18}

If you receive a 202 Success response containing a status field set to Pending, your request was successful.

In addition, you will receive payment_pending and payment_capture_pending webhook notifications. And, when the customer completes the Fawry payment in a timely manner at a point of sale, you will get a payment_captured webhook notification to confirm that the payment has completed.

json
1{
2  "id": "pay_xksrrfuzksge5gyyqubpgbn7gy",
3  "status": "Pending",
4  "customer": {
5    "id": "cus_v65kd7q5tojehd23eftbaiktru"
6  },
7  "_links": {
8    "self": {
9      "href": "https://api.sandbox.checkout.com/payments/pay_xksrrfuzksge5gyyqubpgbn7gy"
10    }
11  }
12}

You can retrieve details about an existing Fawry payment with the following endpoint.

json
1{
2  "id": "pay_xksrrfuzksge5gyyqubpgbn7gy",
3  "requested_on": "2019-05-27T14:10:32Z",
4  "source": {
5    "type": "fawry",
6    "description": "Fawry Demo Payment",
7    "reference_number": "1019734277"
8  },
9  "amount": 1000,
10  "currency": "EGP",
11  "payment_type": "Regular",
12  "status": "Pending",
13  "risk": {
14    "flagged": false
15  },
16  "customer": {
17    "id": "cus_v65kd7q5tojehd23eftbaiktru"
18  },
19  "_links": {
20    "self": {
21      "href": "https://api.sandbox.checkout.com/payments/pay_xksrrfuzksge5gyyqubpgbn7gy"
22    }
23  }
24}

Fawry supports both partial (see note below for details) and full refunds. You can refund a payment through the Dashboard or by using the refund API.

When using Fawry, you may receive the following webhooks.

You can use the two following endpoints to test capturing and canceling a payment in our sandbox environment.

First, you will need to get the details of payment (as above) and make a note of the reference_number in the response.

Use the reference_number from the above response to test capturing a payment.

If successful, you will receive a payment_captured webhook notification.

Use the reference_number from the response to your get payment details request to test canceling a payment.

If successful, you will receive a payment_canceled webhook notification.

You can offer the myFawry app for making payments. The app applies the same rules for both cash and credit card orders as kiosk and myFawry do not differ.

Refunds are made following the same steps as for cash orders:

1. When Fawry receives a refund request it sends a notification informing you that the proper action has been taken.
2. The customer receives an SMS with the reference code containing the OTP. The SMS is sent to the mobile number used in placing the order.
3. If the customer has payed with a credit card, the refund amount is sent to their credit card.
4. If the customer has payed with cash and request refund using the myFawry app, they receive a reference number they should use at a kiosk to obtain the refund.