Mobile Money

This endpoint initiates a mobile money payment transaction.

Payment Flow

1. You send a request to payment/mobile-money.
2. We either reject the transaction (status: 'ERROR') or return it as pending (status: 'PENDING_PAYMENT').
3. If pending, the customer approves the transaction in the JazzCash/Easypaisa app.
4. After approval, we send an IPN notification to your notifyUrl.

note

Currently, only PKR currency is supported, and this endpoint is available only for customers in Pakistan (country code PK).

POST - Sandbox

https://sandbox.paypaygateway.com/fn-execute/payment/mobile-money

POST - Production

https://api.paypaygateway.com/fn-execute/payment/mobile-money

Header Parameters

Parameter	Description	Type	R/O
Authorization	Authorization header containing your Secret Key	string	R
mid	mid header containing your merchant ID	string	O

Body Parameters

Parameter	Description	Type	R/O
amount	Amount to charge, in the minor unit of your selected currency. All currencies are standardized to 100 units. For example, an amount of 10000 in PKR is equal to 100 PKR	number	R
currency	Currency code. Currently only "PKR" is accepted	string	O
provider	Mobile money provider. Currently supports "jazzcash" and "easypaisa"	string	R
firstName	Customer first name	string	R
lastName	Customer last name	string	R
email	Customer email address	string	R
phone	Customer phone number (format 03xxxxxxxxx)	string	R
ip	Customer IP address	string	R
country	Customer country code. Currently only "PK" accepted	string	O
notifyUrl	URL to send notifications when the transaction status changes	string	R

Request Example

{
  "amount": 10000,
  "currency": "PKR",
  "provider": "jazzcash",
  "customer": {
    "firstName": "Alex",
    "lastName": "Fox",
    "email": "some_mail@mail.com",
    "ip": "192.168.1.1",
    "phone": "03123123123",
    "country": "PK"
  },
  "notifyUrl": "https://example.com"
}

Responses

Success Response

200

{
  status: 'successful',
  code: '2002',
  messagetype: 'acquirerRes',
  message: {
    status: 'PENDING_PAYMENT',
    message: 'Transaction initiated. Awaiting customer payment confirmation.',
    referenceNo: '1775111354575-309',
    transactionId: '69ce0cbd446203142755ea26',
    amount: 10000,
    currency: 'PKR'
  }
}

Failure Response

200

{
  status: 'successful',
  code: '2002',
  messagetype: 'acquirerRes',
  message: {
    referenceNo: '1775111354575-309',
    amount: 10000,
    currency: 'PKR',
    transactionId: '69ce0cbd446203142755ea26',
    status: 'ERROR',
    message: 'Generic Decline'
  }
}

Status Codes

For a comprehensive list of status codes and their meanings, please refer to the Status Codes documentation.