Verify payment

Verify transactions after payments using Shoket verify API

How to verify payments

You do this by making a GET request to the Verify Transaction endpoint from your server using your transaction reference.

Authentication

Authenticate your API calls by including your secret key in the Authorization header of every request you make.

Shoket private key can be obtained here. Learn more about authentication here.

Make a request

Here's a code sample for verifying transactions:

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.shoket.co/v1/verify/OB3J177Lqnp6Rg6wHqr3q',
  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_POSTFIELDS =>'{
    "provider_name": "Vodacom",
    "provider_code": "MPESA"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer sk_test_mfpgBhidcAlPYEWbYR',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Node

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'api.shoket.co',
  'path': '/v1/verify/OB3J177Lqnp6Rg6wHqr3q',
  'headers': {
    'Authorization': 'Bearer sk_test_mfpgBhidcAlPYEWbYR',
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "provider_name": "Vodacom",
  "provider_code": "MPESA"
});

req.write(postData);

req.end();

Python

import requests
import json

url = "https://api.shoket.co/v1/verify/OB3J177Lqnp6Rg6wHqr3q"

payload = json.dumps({
  "provider_name": "Vodacom",
  "provider_code": "MPESA"
})
headers = {
  'Authorization': 'Bearer sk_test_mfpgBhidcAlPYEWbYR',
  'Content-Type': 'application/json'
}

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

print(response.text)

Javascript

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer sk_test_mfpgBhidcAlPYEWbYR");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "provider_name": "Vodacom",
  "provider_code": "MPESA"
});

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

fetch("https://api.shoket.co/v1/verify/OB3J177Lqnp6Rg6wHqr3q", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api.shoket.co/v1/verify/OB3J177Lqnp6Rg6wHqr3q")
  .method("GET", null)
  .addHeader("Authorization", "Bearer sk_test_mfpgBhidcAlPYEWbYR")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Swift

import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\r\n    \"provider_name\": \"Vodacom\",\r\n    \"provider_code\": \"MPESA\"\r\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.shoket.co/v1/verify/OB3J177Lqnp6Rg6wHqr3q")!,timeoutInterval: Double.infinity)
request.addValue("Bearer sk_test_mfpgBhidcAlPYEWbYR", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "GET"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
  guard let data = data else {
    print(String(describing: error))
    semaphore.signal()
    return
  }
  print(String(data: data, encoding: .utf8)!)
  semaphore.signal()
}

task.resume()
semaphore.wait()

After making a GET request Shoket will return a JSON data with transaction data.

NOTICE: The returned transaction data does not mean that the transaction was made successfully, you have to verify that the status of the transaction is Success (this identifies that the transaction was completed). Please read down the table of Status and their meaning.

Here is the sample of returned JSON data.

{
    "Status": "Ok" ,
    "customer" {
        "email": "[e-mail]",
        "customer_name": "John",
        "id": 64043
    },
    "data": {
        "amount": 64000,
        "channel": "Halotel",
        "currency": "TSH",
        "number_used": "0663803078",
        "status": "Success",
        "transaction_date": "2021-06-27 15:08:59.917691"
    },
    "message": "Transaction is completed",
    "reference": "adz49dS428b7kbDTdG4MN"
}

HTTP Status

Shoket returns a HTTP status for every request made. Refer here to understand meaning of every status returned.