Public
Documentation Settings
No Environment
Double Column
cURL - cURL
iPay
Introduction
POST
transact
POST
transact/mobilemoney
POST
transaction/search

iPay

POSTtransact

https://apis.ipayafrica.com/payments/v2/transact
HEADERS
Content-Type

application/json

Bodyraw 
{
	"live": 0,
	"oid": "some-fictitious-id1",
	"inv": "some-fictitious-in1",
	"amount": 10,
	"vid":"demo",
	"curr": "KES",
	"hash":"337595f88a1111fb7dff911fda4e7c35318e53e8f20249458238454dfa6bfd0e"
}
Example Request
register transaction
curl
curl --location 'https://apis.ipayafrica.com/payments/v2/transact' \
--header 'Content-Type: application/json' \
--data '{
	"live": 0,
	"oid": "some-fictitious-id1",
	"inv": "some-fictitious-in1",
	"amount": 10,
	"vid":"demo",
	"curr": "KES",
	"hash":"337595f88a1111fb7dff911fda4e7c35318e53e8f20249458238454dfa6bfd0e"
}'
200 OK
Example Response
json
{
  "header_status": 200,
  "status": 1,
  "data": {
    "sid": "SOMDEM31454154514496218016475DEMO",
    "oid": "somefictitiousid1",
    "amount": "10",
    "account": "",
    "payment_channels": [
      {
        "name": "MPESA",
        "paybill": "510800"
      },
      {
        "name": "AIRTEL",
        "paybill": "510800"
      },
      {
        "name": "EQUITEL",
        "paybill": "510800"
      }
    ],
    "hash": "4544d3f135d5ddc9084049fffed1860f41831883ca79f51a7b49eb9e56b0d8a8"
  }
}
Date

Tue, 18 Dec 2018 14:56:12 GMT

Content-Type

application/json;charset=utf-8

Transfer-Encoding

chunked

Connection

keep-alive

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate, post-check=0, pre-check=0

Pragma

no-cache

Expect-CT

max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"

Server

cloudflare

CF-RAY

48b27987da1f2c96-MBA

Content-Encoding

gzip

POSTtransact/mobilemoney

https://apis.ipayafrica.com/payments/v2/transact/mobilemoney
HEADERS
Content-Type

application/json

Bodyraw 
{
	"vid":"demo",
	"sid":"SOMDEM31454154453760281529499DEMO",
	"hash":"da809790871c46419dadd52d3cc014068bec0204749c134b8e15c7aab8d42893"
}
Example Request
transact/mobilemoney
curl
curl --location 'https://apis.ipayafrica.com/payments/v2/transact/mobilemoney' \
--header 'Content-Type: application/json' \
--data '{
	"vid":"demo",
	"sid":"SOMDEM31454154453760281529499DEMO",
	"hash":"da809790871c46419dadd52d3cc014068bec0204749c134b8e15c7aab8d42893"
}'
200 OK
Example Response
json
{
  "txncd": "",
  "qwh": "1681045292",
  "afd": "127846538",
  "poi": "144247607",
  "uyt": "1296028717",
  "ifd": "1702540391",
  "agt": "",
  "id": "somefictitiousid1",
  "status": "bdi6p2yy76etrs",
  "ivm": "somefictitiousid1",
  "mc": "",
  "p1": "",
  "p2": "",
  "p3": "",
  "p4": "",
  "msisdn_id": "",
  "msisdn_idnum": "",
  "channel": "Mobile Money"
}
Date

Tue, 18 Dec 2018 14:57:42 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate, post-check=0, pre-check=0

Pragma

no-cache

Expect-CT

max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"

Server

cloudflare

CF-RAY

48b27bb30edc2c96-MBA

Content-Encoding

gzip

POSTtransaction/search

https://apis.ipayafrica.com/payments/v2/transaction/search
HEADERS
Content-Type

application/json

Bodyraw 
{
	"vid":"demo",
	"oid":"some-fictitious-id1",
	"hash":"e05f7c66691a14b1932d636c05a5968880a819210b3c5bf0214b8ac026cdc100"
}
Example Request
transaction/search 400
curl
curl --location 'https://apis.ipayafrica.com/payments/v2/transaction/search' \
--header 'Content-Type: application/json' \
--data '{
	"vid":"demo",
	"oid":"some-fictitious-id1",
	"hash":"{{hash}}"
}'
400 Bad Request
Example Response
json
{
  "header_status": 400,
  "error": [
    {
      "name": "hash",
      "text": "Hash ID mismatch, please use the correct hash e05f7c66691a14b1932d636c05a5968880a819210b3c5bf0214b8ac026cdc100"
    }
  ]
}
Date

Tue, 18 Dec 2018 14:58:20 GMT

Content-Type

application/json;charset=utf-8

Content-Length

167

Connection

keep-alive

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate, post-check=0, pre-check=0

Pragma

no-cache

Expect-CT

max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"

Server

cloudflare

CF-RAY

48b27ca809772c96-MBA