🐣Quick Start

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can get an API key by sending an email to [email protected]

Make your first request to create a new Qattah Order

You can call our API call to create a new Qattah Order with all possible programming languages, see the below example:

curl --location 'https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api_token>' \
--data '{
    "amount": 100,
    "reference": "common-reference",
    "callback_url": "https://testing-callback.qattahpay.sa",
    "theme":"dark",
    "lang":"ar",
    "currency": "SAR",
    "description": "description",
    "emailAddress": "emailAddress",
    "mobileNumber": "mobileNumber",
    "success_url": "https://www.example.com/success",
    "failure_url": "https://www.example.com/failed"
}'

<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <api_token>'
];
$body = '{
  "amount": 100,
  "reference": "common-reference",
  "callback_url": "https://testing-callback.qattahpay.sa",
  "theme": "dark",
  "lang": "ar",
  "currency": "SAR",
  "description": "description",
  "emailAddress": "emailAddress",
  "mobileNumber": "mobileNumber",
  "success_url": "https://www.example.com/success",
  "failure_url": "https://www.example.com/failed"
}';
$request = new Request('POST', 'https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer <api_token>'
  },
  body: JSON.stringify({
    "amount": 100,
    "reference": "common-reference",
    "callback_url": "https://testing-callback.qattahpay.sa",
    "theme": "dark",
    "lang": "ar",
    "currency": "SAR",
    "description": "description",
    "emailAddress": "emailAddress",
    "mobileNumber": "mobileNumber",
    "success_url": "https://www.example.com/success",
    "failure_url": "https://www.example.com/failed"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"amount\": 100,\n    \"reference\": \"common-reference\",\n    \"callback_url\": \"https://testing-callback.qattahpay.sa\",\n    \"theme\":\"dark\",\n    \"lang\":\"ar\",\n    \"currency\": \"SAR\",\n    \"description\": \"description\",\n    \"emailAddress\": \"emailAddress\",\n    \"mobileNumber\": \"mobileNumber\",\n    \"success_url\": \"https://www.example.com/success\",\n    \"failure_url\": \"https://www.example.com/failed\"\n}");
Request request = new Request.Builder()
  .url("https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Bearer <api_token>")
  .build();
Response response = client.newCall(request).execute();

import requests
import json

url = "https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders"

payload = json.dumps({
  "amount": 100,
  "reference": "common-reference",
  "callback_url": "https://testing-callback.qattahpay.sa",
  "theme": "dark",
  "lang": "ar",
  "currency": "SAR",
  "description": "description",
  "emailAddress": "emailAddress",
  "mobileNumber": "mobileNumber",
  "success_url": "https://www.example.com/success",
  "failure_url": "https://www.example.com/failed"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <api_token>'
}

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

print(response.text)

PreviousWelcome!NextUser flows

Last updated 1 year ago

hashtagGet your API keys

hashtagMake your first request to create a new Qattah Order

Get your API keys

Make your first request to create a new Qattah Order