Guides
v1.0
Guides
  1. Centiwise APMS Documentation Guide

Request Examples

Complete, copy-paste-ready request bodies for every supported country. Replace placeholder values with real data before sending.

Kenya

Payin (M-PESA)

POST https://gate.centiwise.com/paynet/api/v2/sale-form/75135

Parameters: 18
   address1: 201 Trent Pines 24737 North Cecilyside West Virginia KR
   amount: 10.00
   city: North Cecilyside
   client_orderid: f1727c7b-5fb9-4a29-b388-15549f852072
   control: df06269ed872217082f41004a7c1ea55e7f60b2c
   country: KE
   currency: KES
   email: [email protected]
   first_name: Doreen
   ipaddress: 36.0.38.223
   last_name: Wekesa
   merchant_data: deposit
   order_desc: order
   phone: 254759**8347
   purpose: MPESA
   redirect_url: https://test.com/profile/refill
   server_callback_url: https://test.com/payment/v1/287e42ec-fa99-4063-b995-7c113755ed21/callback_with_identity_common
   zip_code: 24737

Payout (M-PESA)

{
  "account_name":        "John Doe",
  "account_number":      "254712345678",
  "amount":              500,
  "client_orderid":      "PAYOUT-KE-001",
  "currency":            "KES",
  "phone":               "+254712345678",
  "purpose":             "M-PESA",
  "server_callback_url": "https://yoursite.com/callback"
}

Tanzania

Payin (Vodacom)

{
  "address1":            "14 Uhuru Street",
  "amount":              5000,
  "cell_phone":          "+255712345678",
  "city":                "Dar es Salaam",
  "client_orderid":      "ORD-TZ-001",
  "control":             "<SHA256 hash>",
  "country":             "TZ",
  "currency":            "TZS",
  "email":               "[email protected]",
  "first_name":          "Ahmed",
  "last_name":           "Hassan",
  "ipaddress":           "196.10.1.1",
  "order_desc":          "Order payment",
  "phone":               "+255712345678",
  "purpose":             "VODACOM",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "1110T1"
}

Payout TZS

POST https://gate.centiwise.com/paynet/api/v4/payout/EdnpointID

Parameters:
   amount: 100
   client_orderid: 1234
   currency: TZS
   ipaddress: 36.0.38.223
   order_desc: 12345
   purpose: TIGO
   receiver_country_code: TZ
   receiver_email: [email protected]
   receiver_first_name: test
   receiver_last_name: test
   receiver_phone:  0712345678

Uganda

Payin (MTN)

{
  "address1":            "7 Kampala Road",
  "amount":              10000,
  "cell_phone":          "+256712345678",
  "city":                "Kampala",
  "client_orderid":      "ORD-UG-001",
  "control":             "<SHA256 hash>",
  "country":             "UG",
  "currency":            "UGX",
  "email":               "[email protected]",
  "first_name":          "Grace",
  "last_name":           "Nakato",
  "ipaddress":           "41.210.1.1",
  "order_desc":          "Goods payment",
  "phone":               "+256712345678",
  "purpose":             "MTN",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "256"
}

Payout (MTN)

{
  "account_name":        "Grace Nakato",
  "account_number":      "256712345678",
  "amount":              10000,
  "client_orderid":      "PAYOUT-UG-001",
  "currency":            "UGX",
  "phone":               "+256712345678",
  "purpose":             "MTN",
  "server_callback_url": "https://yoursite.com/callback"
}

Ghana

Payin (MTN)

{
  "address1":            "22 Independence Avenue",
  "amount":              200,
  "cell_phone":          "+233201234567",
  "city":                "Accra",
  "client_orderid":      "ORD-GH-001",
  "control":             "<SHA256 hash>",
  "country":             "GH",
  "currency":            "GHS",
  "email":               "[email protected]",
  "first_name":          "Kofi",
  "last_name":           "Mensah",
  "ipaddress":           "41.66.1.1",
  "order_desc":          "Service payment",
  "phone":               "+233201234567",
  "purpose":             "MTN",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "GA-123"
}

Payout (MTN)

{
  "account_name":        "Kofi Mensah",
  "account_number":      "233201234567",
  "amount":              200,
  "client_orderid":      "PAYOUT-GH-001",
  "currency":            "GHS",
  "phone":               "+233201234567",
  "purpose":             "MTN",
  "server_callback_url": "https://yoursite.com/callback"
}

Nigeria

Payin (Bank / OPay / PalmPay)

{
  "address1":            "45 Victoria Island",
  "amount":              5000,
  "cell_phone":          "+2348012345678",
  "city":                "Lagos",
  "client_orderid":      "ORD-NG-001",
  "control":             "<SHA256 hash>",
  "country":             "NG",
  "currency":            "NGN",
  "email":               "[email protected]",
  "first_name":          "Chidi",
  "last_name":           "Okonkwo",
  "ipaddress":           "105.112.1.1",
  "order_desc":          "Product purchase",
  "phone":               "+2348012345678",
  "purpose":             "BANK/OPAY/PALMPAY",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "101001"
}

Payout (Bank / OPay / PalmPay)

{
  "account_name":        "Chidi Okonkwo",
  "account_number":      "2348012345678",
  "amount":              5000,
  "client_orderid":      "PAYOUT-NG-001",
  "currency":            "NGN",
  "phone":               "+2348012345678",
  "purpose":             "BANK/OPAY/PALMPAY",
  "server_callback_url": "https://yoursite.com/callback"
}

Zambia

Payin (MTN)

{
  "address1":            "12 Cairo Road",
  "amount":              1000,
  "cell_phone":          "+260971234567",
  "city":                "Lusaka",
  "client_orderid":      "ORD-ZM-001",
  "control":             "<SHA256 hash>",
  "country":             "ZM",
  "currency":            "ZMW",
  "email":               "[email protected]",
  "first_name":          "Mwila",
  "last_name":           "Banda",
  "ipaddress":           "196.32.1.1",
  "order_desc":          "Bill payment",
  "phone":               "+260971234567",
  "purpose":             "MTN",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "10101"
}

Payout (MTN)

{
  "account_name":        "Mwila Banda",
  "account_number":      "260971234567",
  "amount":              1000,
  "client_orderid":      "PAYOUT-ZM-001",
  "currency":            "ZMW",
  "phone":               "+260971234567",
  "purpose":             "MTN",
  "server_callback_url": "https://yoursite.com/callback"
}

Rwanda

⚠️

Rwanda requires account_name in both Payin and Payout requests.

Payin (MTN)

{
  "account_name":        "Amina Uwase",
  "address1":            "5 KG 7 Avenue",
  "amount":              2000,
  "cell_phone":          "+250788123456",
  "city":                "Kigali",
  "client_orderid":      "ORD-RW-001",
  "control":             "<SHA256 hash>",
  "country":             "RW",
  "currency":            "RWF",
  "email":               "[email protected]",
  "first_name":          "Amina",
  "last_name":           "Uwase",
  "ipaddress":           "41.186.1.1",
  "order_desc":          "Transfer",
  "phone":               "+250788123456",
  "purpose":             "MTN",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "00000"
}

Payout (MTN)

{
  "account_name":        "Amina Uwase",
  "account_number":      "250788123456",
  "amount":              2000,
  "client_orderid":      "PAYOUT-RW-001",
  "currency":            "RWF",
  "phone":               "+250788123456",
  "purpose":             "MTN",
  "server_callback_url": "https://yoursite.com/callback"
}

Egypt

Payin (Fawry / CASH )

{
  "address1":            "10 Tahrir Square",
  "amount":              500,
  "cell_phone":          "+201012345678",
  "city":                "Cairo",
  "client_orderid":      "ORD-EG-001",
  "control":             "<SHA256 hash>",
  "country":             "EG",
  "currency":            "EGP",
  "email":               "[email protected]",
  "first_name":          "Omar",
  "last_name":           "Khalil",
  "ipaddress":           "197.48.1.1",
  "order_desc":          "Online purchase",
  "phone":               "+201012345678",
  "purpose":             "FAWRY",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "11511"
}

Payout (Fawry)-CASH only

{
  "account_name":        "Omar Khalil",
  "account_number":      "201012345678",
  "amount":              500,
  "client_orderid":      "PAYOUT-EG-001",
  "currency":            "EGP",
  "phone":               "+201012345678",
  "purpose":             "CASH",
  "server_callback_url": "https://yoursite.com/callback"
}

South Africa

📝

South Africa does not use a purpose field in either Payin or Payout.

Payin

{
  "address1":            "1 Long Street",
  "amount":              300,
  "cell_phone":          "+27821234567",
  "city":                "Cape Town",
  "client_orderid":      "ORD-ZA-001",
  "control":             "<SHA256 hash>",
  "country":             "ZA",
  "currency":            "ZAR",
  "email":               "[email protected]",
  "first_name":          "Lerato",
  "last_name":           "Dlamini",
  "ipaddress":           "41.13.1.1",
  "order_desc":          "Payment",
  "phone":               "+27821234567",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "8001"
}

Payout

{
  "account_name":        "Lerato Dlamini",
  "account_number":      "27821234567",
  "amount":              300,
  "client_orderid":      "PAYOUT-ZA-001",
  "currency":            "ZAR",
  "phone":               "+27821234567",
  "server_callback_url": "https://yoursite.com/callback"
}

XOF Zone (Burkina Faso, Côte d'Ivoire, Senegal, Guinea, Benin)

Payin (Orange Money) — example using Côte d'Ivoire

{
  "address1":            "Plateau District",
  "amount":              10000,
  "cell_phone":          "+22507012345",
  "city":                "Abidjan",
  "client_orderid":      "ORD-CI-001",
  "control":             "<SHA256 hash>",
  "country":             "CI",
  "currency":            "XOF",
  "email":               "[email protected]",
  "first_name":          "Fatou",
  "last_name":           "Diallo",
  "ipaddress":           "197.145.1.1",
  "order_desc":          "Payment",
  "phone":               "+22507012345",
  "purpose":             "ORANGE",
  "redirect_url":        "https://yoursite.com/return",
  "server_callback_url": "https://yoursite.com/callback",
  "site_url":            "https://yoursite.com",
  "zip_code":            "00225"
}

Replace "country": "CI" with BF, SN, GN, or BN for other XOF countries. Keep "currency": "XOF" and "purpose": "ORANGE" for all.


Updated 3 months ago

Did this page help you?