Disbursement (pay-out)

Pakistan region pay-out API (PKR). See Payment methods.

Request

POST/v2.0/disbursement/pay-out

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (Pakistan +05:00).
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID.

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	Merchant-unique id.
purpose	M	String(64)	Transaction memo.
merchant.merchantId	M	String	Smilepayz merchantId.
money.currency	M	String	Fixed to PKR.
money.amount	M	Number	Amount in PKR.
paymentMethod	M	String	JAZZCASH for JazzCash, EASYPAISA for Easypaisa.
cashAccount	M	String(32)	Beneficiary wallet number.
receiver	M	Object	Beneficiary information.
name	M	String	Beneficiary full name.
phone	M	String	Beneficiary wallet mobile number.
callbackUrl	O	String(256)	Async status URL.

Example Body

{
    "orderNo": "PKR_PAYOUT_10001",
    "purpose": "Pakistan wallet pay-out",
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "currency": "PKR",
        "amount": 1000
    },
    "paymentMethod": "JAZZCASH",
    "cashAccount": "03001234567",
    "receiver": {
        "name": "Ali Khan",
        "phone": "03001234567"
    },
    "callbackUrl": "https://www.example.com/callback"
}

Responses

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	Result message.
orderNo	M	String	Merchant order number.
tradeNo	O	String	Smilepayz trade number.
money.currency	M	String	PKR.
money.amount	M	Number	Order amount.
channel.paymentMethod	M	String	Pay-out method.
channel.cashAccount	M	String	Beneficiary wallet number.
status	O	String	INIT, PROCESSING, SUCCESS, FAILED, or EXPIRED.

Notification/Callback

Respond with the string SUCCESS only after the callback is accepted.