Fawaterak API

https://fawaterak-api.readme.io/
Admin
Fawaterak API v1 is a unified and flexible payment processing platform that enables developers to...
Tokens:34,976
Snippets:198
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Swift API URL Setup

Source: https://fawaterak-api.readme.io/reference/initiate-and-process-payments-step-2

This Swift snippet shows the basic setup for the API URL used in payment initiation. Further implementation would involve constructing the request body and making the network call.

```swift
import Foundation

let apiUrl = "https://staging.fawaterk.com/api/v2/invoiceInitPay"

```

--------------------------------

### Get Payment Methods (.NET)

Source: https://fawaterak-api.readme.io/reference/initiatepayment

This .NET RestClient example demonstrates how to fetch payment methods from the API.

```csharp
var client = new RestClient("https://staging.fawaterk.com/api/v2/getPaymentmethods");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Execute Payment (Java)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to initiate and process payments using the ExecutePayment endpoint in Java using OkHttp.

```java
OkHttpClient client = new OkHttpClient();

MediaType JSON = MediaType.get("application/json; charset=utf-8");

String json = "{\"payment_method_id\": \"pm_12345\", \"payment_method_type\": \"credit_card\", \"amount\": 100, \"currency\": \"EGP\", \"customer_id\": \"cust_67890\", \"callback_url\": \"https://your-callback-url.com\"}";

RequestBody body = RequestBody.create(json, JSON);

Request request = new Request.Builder()
    .url("https://api.fawaterak.com/v1/transactions/execute-payment")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("Accept", "application/json")
    .addHeader("Authorization", "Bearer YOUR_API_KEY")
    .build();

client.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(Call call, Response response) {
        if (response.isSuccessful()) {
            try {
                System.out.println(response.body().string());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
});
```

--------------------------------

### Get Payment Methods (Python)

Source: https://fawaterak-api.readme.io/reference/initiatepayment

This Python script uses the requests library to get available payment methods. It shows examples for both staging and development environments.

```python
import requests
import json

url = "https://staging.fawaterk.com/api/v2/getPaymentmethods"

payload={}
headers = {
  'content-type': 'application/json',
  'Authorization': 'Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
import requests
import json

url = "https://dev.fawaterk.com/api/v2/getPaymentmethods"

payload={}
headers = {
  'content-type': 'application/json',
  'Authorization': 'Bearer 0b3fefb44fd628870b751793224d6334fea5d38300641e36aa'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Execute Payment (Kotlin)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to initiate and process payments using the ExecutePayment endpoint in Kotlin using OkHttp.

```kotlin
val client = OkHttpClient()

val JSON = "application/json; charset=utf-8".toMediaTypeOrNull()

val json = "{\"payment_method_id\": \"pm_12345\", \"payment_method_type\": \"credit_card\", \"amount\": 100, \"currency\": \"EGP\", \"customer_id\": \"cust_67890\", \"callback_url\": \"https://your-callback-url.com\"}"

val body = json.toRequestBody(JSON)

val request = Request.Builder()
    .url("https://api.fawaterak.com/v1/transactions/execute-payment")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("Accept", "application/json")
    .addHeader("Authorization", "Bearer YOUR_API_KEY")
    .build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        e.printStackTrace()
    }

    override fun onResponse(call: Call, response: Response) {
        if (response.isSuccessful) {
            try {
                println(response.body?.string())
            } catch (e: IOException) {
                e.printStackTrace()
            }
        }
    }
})
```

--------------------------------

### Execute Payment (Swift)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to initiate and process payments using the ExecutePayment endpoint in Swift using URLSession.

```swift
let url = URL(string: "https://api.fawaterak.com/v1/transactions/execute-payment")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("Bearer YOUR_API_KEY", forHTTPHeaderField: "Authorization")

let body: [String: Any] = [
    "payment_method_id": "pm_12345",
    "payment_method_type": "credit_card",
    "amount": 100,
    "currency": "EGP",
    "customer_id": "cust_67890",
    "callback_url": "https://your-callback-url.com"
]
request.httpBody = try? JSONSerialization.data(withJSONObject: body, options: [])

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print(error?.localizedDescription ?? "Unknown Error")
        return
    }
    if let httpStatus = response as? HTTPURLResponse, httpStatus.statusCode == 200 {
        let responseString = String(data: data, encoding: .utf8)
        print(responseString ?? "No data")
    }
}
task.resume()
```

--------------------------------

### Get Payment Methods (JavaScript)

Source: https://fawaterak-api.readme.io/reference/initiatepayment

Use this JavaScript fetch API example to retrieve payment method information.

```javascript
var myHeaders = new Headers();
myHeaders.append("content-type", "application/json");
myHeaders.append("Authorization", "Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://staging.fawaterk.com/api/v2/getPaymentmethods", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

--------------------------------

### Initiate Payment with JavaScript

Source: https://fawaterak-api.readme.io/reference/inetail-payment-1

A JavaScript example using the Fetch API to send a POST request to initiate a payment. It includes setting the Authorization header and JSON content type.

```javascript
const payload = {
  payment_method_id: 4,
  cartTotal: "100",
  currency: "EGP",
  customer: {
    first_name: "test",
    last_name: "test",
    email: "test@test.test",
    phone: "01000000000",
    address: "test address",
  },
  redirectionUrls: {
    successUrl: "https://dev.fawaterk.com/success",
    failUrl: "https://dev.fawaterk.com/fail",
    pendingUrl: "https://dev.fawaterk.com/pending",
  },
  cartItems: [
    {
      name: "test",
      price: "100",
      quantity: "1",
    },
  ],
};

fetch("https://staging.fawaterk.com/api/v2/invoiceInitPay", {
  method: "POST",
  headers: {
    Authorization:
      "Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
})
  .then(function (response) {
    if (!response.ok) {
      return response.text().then(function (text) {
        throw new Error("HTTP " + response.status + ": " + text);
      });
    }
    return response.json();
  })
  .then(function (data) {
    console.log(JSON.stringify(data));
  })
  .catch(function (error) {
    console.log(error);
  });

```

--------------------------------

### Create Token Response Example

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

This is an example of a successful response when creating a card token. It includes the status, the generated token, and the masked card number.

```json
{
    "status": "success",
    "token": "9731673377207107",
    "cardNumber": "512345xxxxxx0008"
}

```

--------------------------------

### Retrieve Available Payment Methods (Java)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to make an API request to retrieve available payment methods in Java using OkHttp.

```java
OkHttpClient client = new OkHttpClient();

MediaType JSON = MediaType.get("application/json; charset=utf-8");

String json = "{\"amount\": 100, \"currency\": \"EGP\"}";

RequestBody body = RequestBody.create(json, JSON);

Request request = new Request.Builder()
    .url("https://api.fawaterak.com/v1/payment-methods")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("Accept", "application/json")
    .addHeader("Authorization", "Bearer YOUR_API_KEY")
    .build();

client.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(Call call, Response response) {
        if (response.isSuccessful()) {
            try {
                System.out.println(response.body().string());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
});
```

--------------------------------

### Retrieve Available Payment Methods (Kotlin)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to make an API request to retrieve available payment methods in Kotlin using OkHttp.

```kotlin
val client = OkHttpClient()

val JSON = "application/json; charset=utf-8".toMediaTypeOrNull()

val json = "{\"amount\": 100, \"currency\": \"EGP\"}"

val body = json.toRequestBody(JSON)

val request = Request.Builder()
    .url("https://api.fawaterak.com/v1/payment-methods")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("Accept", "application/json")
    .addHeader("Authorization", "Bearer YOUR_API_KEY")
    .build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        e.printStackTrace()
    }

    override fun onResponse(call: Call, response: Response) {
        if (response.isSuccessful) {
            try {
                println(response.body?.string())
            } catch (e: IOException) {
                e.printStackTrace()
            }
        }
    }
})
```

--------------------------------

### Execute Payment (React Native)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to initiate and process payments using the ExecutePayment endpoint in React Native.

```javascript
fetch('https://api.fawaterak.com/v1/transactions/execute-payment', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Accept': 'application/json',
        'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
        'payment_method_id': 'pm_12345',
        'payment_method_type': 'credit_card',
        'amount': 100,
        'currency': 'EGP',
        'customer_id': 'cust_67890',
        'callback_url': 'https://your-callback-url.com'
    })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Create Card Token Screen Request using Axios

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

This JavaScript example demonstrates how to initiate the card tokenization process using the Axios library. It sends customer and order details to the API to generate a secure payment link.

```javascript
var axios = require('axios');
var data = JSON.stringify({
    "order": {
        "currency": "EGP"
    },
    "customerData": {
        "customer_unique_id": "222111333",
        "customer_first_name": "Fname",
        "customer_last_name": "Lname",
        "customer_email": "usr@fawaterk.com",
        "customer_phone": "01111111111"
    },
    "redirectionUrls": {
        "success_url": "https://domain.com/success",
        "fail_url": "https://domain.com/fail"
    }
});

var config = {
  method: 'post',
  url: 'https://staging.fawaterk.com/api/v2/createCardTokenScreen',
  headers: { 
    'Authorization': 'Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd', 
    'Content-Type': 'application/json'
  }, 
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

```

--------------------------------

### Retrieve Available Payment Methods (Swift)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to make an API request to retrieve available payment methods in Swift using URLSession.

```swift
let url = URL(string: "https://api.fawaterak.com/v1/payment-methods")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("Bearer YOUR_API_KEY", forHTTPHeaderField: "Authorization")

let body: [String: Any] = ["amount": 100, "currency": "EGP"]
request.httpBody = try? JSONSerialization.data(withJSONObject: body, options: [])

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print(error?.localizedDescription ?? "Unknown Error")
        return
    }
    if let httpStatus = response as? HTTPURLResponse, httpStatus.statusCode == 200 {
        let responseString = String(data: data, encoding: .utf8)
        print(responseString ?? "No data")
    }
}
task.resume()
```

--------------------------------

### Create Tokenization Payment Request (PHP)

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

Use this PHP cURL example to initiate a tokenization payment request. Ensure you have the correct API endpoint and authorization headers.

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/createTokenizationPayRequest',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ "tokenAction":"tokenization",
    "order": {
        "amount": "10",
        "currency": "USD"
    },
    "payload": {
        "merchant_reference": "123",
        "trasaction_data": "transaction data"
    },
    "customerData": {
        "customer_token": "8lvfHBZC3n7lmTRO"
    },
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
```
```

--------------------------------

### Create Tokenization Payment Request (JavaScript/Axios)

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

This JavaScript example uses Axios to send a POST request for tokenization. It includes the necessary headers and data payload for the API call.

```javascript
var axios = require('axios');
var data = JSON.stringify({
    "order": {
        "amount": "1000",
        "currency": "EGP"
    },
    "customerData": {
        "customer_token": "9731673377207107"
    }
});

var config = {
  method: 'post',
  url: 'https://staging.fawaterk.com/api/v2/createTokenizationPayRequest',
  headers: { 
    'Authorization': 'Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd', 
    'Content-Type': 'application/json'
  }, 
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
```

--------------------------------

### Fetch Payment Methods (Flutter)

Source: https://fawaterak-api.readme.io/reference/retrieve-available-payment-methods-step-1-copy

This Flutter example uses the http package to fetch payment methods. Ensure your access token is valid and included in the headers.

```dart
import 'dart:convert';
import 'package:http/http.dart' as http;

void fetchPaymentMethods() async {
  final apiUrl = 'https://staging.fawaterk.com/api/v2/getPaymentmethods';
  final accessToken = 'd83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd';

  final headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer $accessToken',
  };

  try {
    final response = await http.get(Uri.parse(apiUrl), headers: headers);
    final responseData = json.decode(response.body);
    print(json.encode(responseData));
  } catch (error) {
    print(error);
  }
}

void main() {
  fetchPaymentMethods();
}

```

--------------------------------

### Create Card Tokenization Request (JavaScript)

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

This JavaScript example using Axios demonstrates how to make a POST request to create a card token. Ensure your request includes the necessary headers and JSON payload.

```javascript
var axios = require('axios');
var data = JSON.stringify({
    "order": {
        "currency": "EGP"
    },
    "customerData": {
        "customer_unique_id": "222111333",
        "customer_first_name": "Fname",
        "customer_last_name": "Lname",
        "customer_email": "usr@fawaterk.com",
        "customer_phone": "01111111111"
    },
    "cardData": {
        "card_number": "5123450000000008",
        "expire_year": "2027",
        "expire_month": "12",
        "sec_code": "100"
    }
});

var config = {
  method: 'post',
  url: 'https://staging.fawaterk.com/api/v2/createCardTokenization',
  headers: { 
    'Authorization': 'Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

```

--------------------------------

### Retrieve Available Payment Methods (React Native)

Source: https://fawaterak-api.readme.io/reference/mobile-sdks

Example of how to make an API request to retrieve available payment methods in React Native.

```javascript
fetch('https://api.fawaterak.com/v1/payment-methods', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Accept': 'application/json',
        'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
        'amount': 100,
        'currency': 'EGP'
    })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Create Card Tokenization Request (PHP)

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

Use this PHP cURL example to send a POST request to create a card token. Ensure you have the correct API endpoint and authorization header.

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/createCardTokenization',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "order": {
        "currency": "EGP"
    },
    "customerData": {
        "customer_unique_id": "222111333",
        "customer_first_name": "Fname",
        "customer_last_name": "Lname",
        "customer_email": "usr@fawaterk.com",
        "customer_phone": "01111111111"
    },
    "cardData": {
        "card_number": "5123450000000008",
        "expire_year": "2027",
        "expire_month": "12",
        "sec_code": "100"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
  ),
));
$response = curl_exec($curl);
curl_close($curl);

```

--------------------------------

### Create Recurring Tokenization Payment Request (PHP)

Source: https://fawaterak-api.readme.io/reference/pay-with-tokenization

Use this PHP cURL example to initiate a recurring tokenization payment request. It includes additional payload details for recurring transactions.

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/createTokenizationPayRequest',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ "order": {
        "amount": "1000",
        "currency": "EGP"
    },
    "customerData": {
        "customer_token": "UFZiaC98572rKZGZ"
    },
    "payload": {
        "merchant_reference": "123",
        "trasaction_data": "transaction data"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
```
```

--------------------------------

### Initiate Payment Request in Java

Source: https://fawaterak-api.readme.io/reference/initiate-and-process-payments-step-2

This Java code uses OkHttp to send a POST request for payment initiation. It demonstrates setting up the client, request, and handling the response.

```java
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        String apiUrl = "https://staging.fawaterk.com/api/v2/invoiceInitPay";
        String apiToken = "d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd";
        int paymentId = 4;

        String requestData = "{\"payment_method_id\":" + paymentId + ",\"cartTotal\":\"100\",\"currency\":\"EGP\",\"customer\":{\"first_name\":\"test\",\"last_name\":\"test\",\"email\":\"test@test.test\",\"phone\":\"01000000000\",\"address\":\"test address\"},\"redirectionUrls\":{\"successUrl\":\"https://dev.fawaterk.com/success\",\"failUrl\":\"https://dev.fawaterk.com/fail\",\"pendingUrl\":\"https://dev.fawaterk.com/pending\"},\"cartItems\":[{\"name\":\"test\",\"price\":\"100\",\"quantity\":\"1\"}]}";

        OkHttpClient client = new OkHttpClient();

        RequestBody requestBody = RequestBody.create(requestData, MediaType.get("application/json"));

        Request request = new Request.Builder()
                .url(apiUrl)
                .addHeader("Authorization", "Bearer " + apiToken)
                .addHeader("Content-Type", "application/json")
                .post(requestBody)
                .build();

        try {
            Response response = client.newCall(request).execute();
            if (response.isSuccessful()) {
                String responseData = response.body().string();
                System.out.println(responseData);
            } else {
                System.out.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

```

--------------------------------

### Initiate Payment Request in Kotlin

Source: https://fawaterak-api.readme.io/reference/initiate-and-process-payments-step-2

This Kotlin code demonstrates how to make a POST request to initiate a payment using OkHttp. It includes setting headers and the JSON request body.

```kotlin
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody

fun main() {
    val apiUrl = "https://staging.fawaterk.com/api/v2/invoiceInitPay"
    val apiToken = "d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd"
    val paymentId = 4

    val requestData = "{\"payment_method_id\":$paymentId,\"cartTotal\":\"100\",\"currency\":\"EGP\",\"customer\":{\"first_name\":\"test\",\"last_name\":\"test\",\"email\":\"test@test.test\",\"phone\":\"01000000000\",\"address\":\"test address\"},\"redirectionUrls\":{\"successUrl\":\"https://dev.fawaterk.com/success\",\"failUrl\":\"https://dev.fawaterk.com/fail\",\"pendingUrl\":\"https://dev.fawaterk.com/pending\"},\"cartItems\":[{\"name\":\"test\",\"price\":\"100\",\"quantity\":\"1\"}]}"

    val client = OkHttpClient()

    val requestBody = requestData.toRequestBody("application/json".toMediaType())

    val request = Request.Builder()
        .url(apiUrl)
        .addHeader("Authorization", "Bearer $apiToken")
        .addHeader("Content-Type", "application/json")
        .post(requestBody)
        .build()

    client.newCall(request).execute().use { response ->
        if (response.isSuccessful) {
            val responseData = response.body?.string()
            println(responseData)
        } else {
            println("Request failed: ${response.code}")
        }
    }
}

```

--------------------------------

### Get Transaction Data using PHP cURL

Source: https://fawaterak-api.readme.io/reference/get-transaction-data

Use this PHP cURL snippet to make a GET request to retrieve transaction data for a given invoice ID. Ensure you replace '1001267' with the actual invoice ID and '0b3fefb44fd628870b751793224d6334fea5d38300641e36aa' with your valid API token.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/getInvoiceData/1001267',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer 0b3fefb44fd628870b751793224d6334fea5d38300641e36aa'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>
```

--------------------------------

### Initiate Payment Request (Java)

Source: https://fawaterak-api.readme.io/reference/usage-example

This snippet shows how to construct and send a payment initiation request to the Fawaterk API using Java. It includes setting up customer details, redirection URLs, and cart items.

```java
customer.put("address", "test address");
requestBody.put("customer", customer);

Map<String, String> redirectionUrls = new HashMap<>();
redirectionUrls.put("successUrl", "https://dev.fawaterk.com/success");
redirectionUrls.put("failUrl", "https://dev.fawaterk.com/fail");
redirectionUrls.put("pendingUrl", "https://dev.fawaterk.com/pending");
requestBody.put("redirectionUrls", redirectionUrls);

Map<String, Object> cartItem = new HashMap<>();
cartItem.put("name", "test");
cartItem.put("price", "100");
cartItem.put("quantity", "1");
requestBody.put("cartItems", new Object[] { cartItem });

RequestBody body = RequestBody.create(mediaType, new Gson().toJson(requestBody));

Request request = new Request.Builder()
    .url(API_URL)
    .addHeader("Authorization", "Bearer " + API_TOKEN)
    .addHeader("Content-Type", "application/json")
    .post(body)
    .build();

try {
    Response response = client.newCall(request).execute();
    if (response.isSuccessful()) {
        String responseData = response.body().string();
        JSONObject json = new JSONObject(responseData);
        JSONObject paymentData = json.getJSONObject("data").getJSONObject("payment_data");
        String redirectTo = paymentData.optString("redirectTo");
        if (!redirectTo.isEmpty()) {
            fawaterkurl = redirectTo;
            paymentCompleted = true;
        }
    }
} catch (IOException | JSONException e) {
    e.printStackTrace();
}
}
```

--------------------------------

### Get Transaction Data using C# RestSharp

Source: https://fawaterak-api.readme.io/reference/get-transaction-data

This C# snippet demonstrates how to fetch transaction data using the RestSharp library. It configures a GET request with necessary headers for content type and authorization. Replace the placeholder invoice ID and token with your actual values.

```csharp
var client = new RestClient("https://staging.fawaterk.com/api/v2/getInvoiceData/1001267");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer 0b3fefb44fd628870b751793224d6334fea5d38300641e36aa");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Get Transaction Data using Python Requests

Source: https://fawaterak-api.readme.io/reference/get-transaction-data

This Python snippet utilizes the 'requests' library to fetch transaction data. It defines the URL, headers including content type and authorization, and then sends a GET request. Ensure the invoice ID and bearer token are correctly set.

```python
import requests
import json

url = "https://staging.fawaterk.com/api/v2/getInvoiceData/1001267"

payload={}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer 0b3fefb44fd628870b751793224d6334fea5d38300641e36aa'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Initiate Payment with C#

Source: https://fawaterak-api.readme.io/reference/inetail-payment-1

This C# snippet demonstrates how to initiate a payment using the RestSharp library. It includes setting headers, request body, and executing the POST request to the Fawaterk API.

```csharp
var client = new RestClient("https://staging.fawaterk.com/api/v2/invoiceInitPay");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd");
request.AddHeader("Content-Type", "application/json");
var body = @"{{
" + 
@"    "payment_method_id": 4," + 
@"    "cartTotal": "100",
```

--------------------------------

### Initiate Payment in Android

Source: https://fawaterak-api.readme.io/reference/usage-example

This Android snippet demonstrates how to initiate a payment session using the Fawaterak API. It includes setting up the WebView and handling URL loading for payment redirection.

```java
import android.annotation.SuppressLint;
import android.os.Bundle;
import android.webkit.WebView;
import android.webkit.WebViewClient;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {

    private boolean paymentCompleted = false;
    private String fawaterkurl = null;

    private static final String API_URL = "https://staging.fawaterk.com/api/v2/invoiceInitPay";
    private static final String API_TOKEN = "d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd";
    private static final int PAYMENT_ID = 4;

    @SuppressLint("SetJavaScriptEnabled")
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        generateFawaterksession();

        WebView webView = findViewById(R.id.webView);
        webView.getSettings().setJavaScriptEnabled(true);

        webView.setWebViewClient(new WebViewClient() {
            @Override
            public boolean shouldOverrideUrlLoading(WebView view, String url) {
                // Check if the URL has changed to handle the response or perform further actions
                if (url.contains("https://dev.fawaterk.com/")) {
                    // Handle the response or perform any required actions here
                    if (url.contains("success")) {
                        System.out.println("success");
                    } else {
                        System.out.println("Cancelled");
                    }
                }
                return false;
            }
        });

        if (paymentCompleted) {
            webView.loadUrl(fawaterkurl);
        }
    }

 public void generateFawaterksession() {
    OkHttpClient client = new OkHttpClient();

    MediaType mediaType = MediaType.parse("application/json");
    Map<String, Object> requestBody = new HashMap<>();
    requestBody.put("payment_method_id", PAYMENT_ID);
    requestBody.put("cartTotal", "100");
    requestBody.put("currency", "EGP");

    Map<String, String> customer = new HashMap<>();
    customer.put("first_name", "test");
    customer.put("last_name", "test");
    customer.put("email", "test@test.test");
    customer.put("phone", "01000000000");

```

--------------------------------

### Initiate Fawaterk Checkout

Source: https://fawaterak-api.readme.io/reference/fawaterk-hosted-checkout

Call the `fawaterkCheckout` function with your prepared `pluginConfig` object to launch the checkout process. This function should be invoked after the plugin script is loaded and the configuration is set.

```javascript
fawaterkCheckout(pluginConfig);
```

--------------------------------

### Get Payment Methods (PHP)

Source: https://fawaterak-api.readme.io/reference/initiatepayment

Use this PHP cURL request to retrieve a list of available payment methods and their details.

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/getPaymentmethods',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
?>
```

--------------------------------

### Initiate Payment with Python

Source: https://fawaterak-api.readme.io/reference/inetail-payment-1

This Python snippet uses the requests library to send a POST request for payment initiation. It demonstrates how to structure the payload and headers for the API call.

```python
import requests
import json

url = "https://staging.fawaterk.com/api/v2/invoiceInitPay"

payload = json.dumps({
  "payment_method_id": 4,
  "cartTotal": "100",
  "currency": "EGP",
  "customer": {
    "first_name": "test",
    "last_name": "test",
    "email": "test@test.com",
    "phone": "01000000000",
    "address": "test address"
  },
  "redirectionUrls": {
    "successUrl": "https://dev.fawaterk.com/success",
    "failUrl": "https://dev.fawaterk.com/fail",
    "pendingUrl": "https://dev.fawaterk.com/pending"
  },
  "cartItems": [
    {
      "name": "test",
      "price": "100",
      "quantity": "1"
    }
  ]
})
headers = {
  'Authorization': 'Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

--------------------------------

### Initiate Payment and Handle Redirect (Swift)

Source: https://fawaterak-api.readme.io/reference/usage-example

This Swift code snippet demonstrates how to initiate a payment session with Fawaterak and handle the redirection URL. It includes setting up the WebView and processing the API response.

```swift
import UIKit
import WebKit

class ViewController: UIViewController, WKNavigationDelegate {

    private var paymentCompleted = false
    private var fawaterkurl: String?

    private let API_URL = "https://staging.fawaterk.com/api/v2/invoiceInitPay"
    private let API_TOKEN = "d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd"
    private let PAYMENT_ID = 4

    private var webView: WKWebView!

    override func viewDidLoad() {
        super.viewDidLoad()

        generateFawaterksession()

        webView = WKWebView(frame: view.frame)
        webView.navigationDelegate = self
        view.addSubview(webView)

        if paymentCompleted, let url = fawaterkurl, let webViewUrl = URL(string: url) {
            let request = URLRequest(url: webViewUrl)
            webView.load(request)
        }
    }

func generateFawaterksession() {
    let url = URL(string: API_URL)!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.addValue("Bearer \(API_TOKEN)", forHTTPHeaderField: "Authorization")
    request.addValue("application/json", forHTTPHeaderField: "Content-Type")
    
    let parameters: [String: Any] = [
        "payment_method_id": PAYMENT_ID,
        "cartTotal": "100",
        "currency": "EGP",
        "customer": [
            "first_name": "test",
            "last_name": "test",
            "email": "test@test.test",
            "phone": "01000000000",
            "address": "test address"
        ],
        "redirectionUrls": [
            "successUrl": "https://dev.fawaterk.com/success",
            "failUrl": "https://dev.fawaterk.com/fail",
            "pendingUrl": "https://dev.fawaterk.com/pending"
        ],
        "cartItems": [
            [
                "name": "test",
                "price": "100",
                "quantity": "1"
            ]
        ]
    ]
    
    do {
        request.httpBody = try JSONSerialization.data(withJSONObject: parameters, options: [])
        
        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
            if let error = error {
                print(error)
                return
            }
            
            if let data = data {
                do {
                    let responseData = try JSONSerialization.jsonObject(with: data, options: [])
                    if let json = responseData as? [String: Any],
                       let paymentData = json["data"] as? [String: Any],
                       let redirectTo = paymentData["redirectTo"] as? String {
                        self.fawaterkurl = redirectTo
                        self.paymentCompleted = true
                    }
                } catch {
                    print(error)
                }
            }
        }
        
        task.resume()
    } catch {
        print(error)
    }
}


    func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {
        // Check if the URL has changed to handle the response or perform further actions
        if let url = navigationAction.request.url, url.absoluteString.contains("https://dev.fawaterk.com/") {
            // Handle the response or perform any required actions here
            if url.absoluteString.contains("success") {
                print("success")
            } else {
                print("Cancelled")
            }
        }
        decisionHandler(.allow)
    }
}

```

--------------------------------

### Fetch Payment Methods (Java)

Source: https://fawaterak-api.readme.io/reference/retrieve-available-payment-methods-step-1-copy

This Java code demonstrates how to retrieve payment methods using OkHttp. Include your access token in the Authorization header.

```java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        String apiUrl = "https://staging.fawaterk.com/api/v2/getPaymentmethods";
        String accessToken = "d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd";

        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
                .url(apiUrl)
                .addHeader("Content-Type", "application/json")
                .addHeader("Authorization", "Bearer " + accessToken)
                .build();

        try {
            Response response = client.newCall(request).execute();
            if (response.isSuccessful()) {
                String responseData = response.body().string();
                System.out.println(responseData);
            } else {
                System.out.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

```

--------------------------------

### Get Payment Methods

Source: https://fawaterak-api.readme.io/reference/gateway-integration

Retrieves all available and enabled Payment Methods for your portal account, including any associated commission charges. This information can be cached and reused.

```APIDOC
## GET /v1/PaymentMethods

### Description
Retrieves a list of all available and enabled payment methods for the authenticated portal account, along with their respective commission charges.

### Method
GET

### Endpoint
/v1/PaymentMethods

### Parameters
#### Query Parameters
None explicitly documented.

### Response
#### Success Response (200)
- **paymentMethods** (array) - A list of available payment methods.
  - **id** (string) - The unique identifier for the payment method.
  - **name** (string) - The display name of the payment method.
  - **commission** (number) - The commission charge associated with this payment method.

#### Response Example
```json
{
  "paymentMethods": [
    {
      "id": "pm_12345",
      "name": "Credit Card",
      "commission": 2.5
    },
    {
      "id": "pm_67890",
      "name": "Bank Transfer",
      "commission": 1.0
    }
  ]
}
```
```

--------------------------------

### Initiate Payment with PHP

Source: https://fawaterak-api.readme.io/reference/inetail-payment-1

Use this PHP snippet to initiate a payment via the Fawaterk API. Ensure you have cURL enabled and replace the placeholder token with your actual API key.

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://staging.fawaterk.com/api/v2/invoiceInitPay',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ 
    "payment_method_id": 2,
    "cartTotal": "50",
    "currency": "EGP",
    "invoice_number" : "123",
    "customer": {
        "first_name": "mohammad",
        "last_name": "hamza",
        "email": "test@fawaterk.com",
        "phone": "01xxxxxxxxx",
        "address": "test address"
    },
    "redirectionUrls": {
         "successUrl" : "https://dev.fawaterk.com/success",
         "failUrl": "https://dev.fawaterk.com/fail",
         "pendingUrl": "https://dev.fawaterk.com/pending"   
    },
    "cartItems": [
        {
            "name": "this is test oop 112252",
            "price": "25",
            "quantity": "1"
        },
        {
            "name": "this is test oop 112252",
            "price": "25",
            "quantity": "1"
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer d83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd'
  ),
));
$response = curl_exec($curl);
curl_close($curl);

```

--------------------------------

### Fetch Payment Methods (React Native)

Source: https://fawaterak-api.readme.io/reference/retrieve-available-payment-methods-step-1-copy

Use this JavaScript snippet to make a GET request to the payment methods endpoint. Ensure you have a valid access token.

```javascript
const apiUrl = 'https://staging.fawaterk.com/api/v2/getPaymentmethods';
const accessToken = 'd83a5d07aaeb8442dcbe259e6dae80a3f2e21a3a581e1a5acd';

const headers = {
  'Content-Type': 'application/json',
  Authorization: `Bearer ${accessToken}`,
};

fetch(apiUrl, {
  method: 'GET',
  headers,
})
  .then(async (response) => {
    const text = await response.text();
    let data;
    try {
      data = text ? JSON.parse(text) : null;
    } catch {
      data = text;
    }
    if (!response.ok) {
      throw new Error(
        `HTTP ${response.status}: ${typeof data === 'string' ? data : JSON.stringify(data)}`
      );
    }
    console.log(JSON.stringify(data));
  })
  .catch((error) => {
    console.log(error);
  });

```
Tokens:
Raw