Validation

curl -X POST "{{base_url}}/v1/validation/KES" \
  -H "x-api-key: YOUR_CONSUMER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shortcode": "254712345678",
    "type": "MOBILE",
    "mobile_network": "Safaricom"
  }'

POST

validation

{currency_code}

curl -X POST "{{base_url}}/v1/validation/KES" \
  -H "x-api-key: YOUR_CONSUMER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shortcode": "254712345678",
    "type": "MOBILE",
    "mobile_network": "Safaricom"
  }'

Resolves account names / validity for the destination currency. Defaults to Kenya (KES) rules when the path currency is omitted.

string

KES, UGX, NGN, GHS, etc.

Body by currency

KES (default)

string

required

Phone or till / paybill number.

string

required

MOBILE, PAYBILL, or BUY_GOODS.

string

Required for MOBILE: Safaricom or Airtel.

UGX

string

required

10-digit phone number.

string

required

MTN or Airtel.

NGN

string

required

Bank account number.

string

required

Bank code from the banks list.

GHS

string

required

10-digit mobile number.

string

required

MTN, AirtelTigo, or Telecel.

curl -X POST "{{base_url}}/v1/validation/KES" \
  -H "x-api-key: YOUR_CONSUMER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shortcode": "254712345678",
    "type": "MOBILE",
    "mobile_network": "Safaricom"
  }'

⌘I

Overview

Account

Rates

Payments (v1)

Banks

Checkout

Collection & disbursement

Body by currency

KES (default)

UGX

NGN

GHS

​Body by currency

​KES (default)

​UGX

​NGN

​GHS

Body by currency

KES (default)

UGX

NGN

GHS