Create withdraw order

POST

/api/payOut/unifiedOrder

Limit information

Minimum withdrawal limit per transaction: 100KES
Maximum withdrawal limit per person per transaction: 70,000KES
Maximum daily withdrawal limit per person: 300,000KES

wayCode - currently only supports EWALLET_MPESA
Rules for mobile phone numbers for receiving payments in Kenya: must start with 254, no + sign required

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1704182130212

X-API-SIGNATURE

string

required

signature

Example:

304402200f978377ba9538594d77bb82e4eacabf41dbe500a6ccf8e4b31114e257ff60d102204fffdad3331cd90493f6ff16a045508d184d567f1aabf1debd2a8d8d4b2345d0

Body Params application/json

mchNo

string

Merchant number

required

mchOrderNo

string

Merchant order number (guaranteed to be unique)

required

wayCode

string

Payment code

required

Payment code

currency

string

Currency

required

Fixed to KES

amount

string

Amount

required

Must be an integer

notifyUrl

string

Result notification address

required

customerContact

string

Mobile number

required

Transfer money to this mobile number

customerName

string

Payee

required

Compatibility parameters

customerEmail

string

Payee email

required

Compatibility parameters

Example

{
  "amount": "100",
  "currency": "KES",
  "mchNo": "M1688443982",
  "mchOrderNo": "YN7220230300929",
  "notifyUrl": "http://www.yourcompany.com/notify",
  "wayCode": "EWALLET_MPESA",
  "customerName": "payer",
  "customerContact": "254115555076",
  "customerEmail": "xiaohua661085@126.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/payOut/unifiedOrder' \
--header 'X-API-KEY: 0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0' \
--header 'X-API-NONCE: 1704182130212' \
--header 'X-API-SIGNATURE: 304402200f978377ba9538594d77bb82e4eacabf41dbe500a6ccf8e4b31114e257ff60d102204fffdad3331cd90493f6ff16a045508d184d567f1aabf1debd2a8d8d4b2345d0' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": "100",
  "currency": "KES",
  "mchNo": "M1688443982",
  "mchOrderNo": "YN7220230300929",
  "notifyUrl": "http://www.yourcompany.com/notify",
  "wayCode": "EWALLET_MPESA",
  "customerName": "payer",
  "customerContact": "254115555076",
  "customerEmail": "xiaohua661085@126.com"
}'

Responses

🟢200成功

application/json

Body

code

integer

required

data

object

required

mchOrderNo

string

Merchant order number

required

payOrderId

string

Platform order number

required

msg

string

required

Example

{
    "code": 0,
    "data": {
        "mchOrderNo": "YN7220230300929",
        "payOrderId": "P1681112064487976961"
    },
    "msg": "SUCCESS",
    "sign": "304502203526e91debfaa0a85d8c7746844502dc989d7b4fde24d68bce8443b1c5e87cc0022100f7cbedee2886ab57919d3bea1502536ede930afb7c78e212626ba3812794246e"
}

Query deposit order status

Query withdraw order

Create withdraw order

Limit information#

Request

Request samples

Responses

Limit information