JazzCash

Payment method's logo
Payment method's type	E-wallets
Country	Pakistan
Currency	PKR

To initiate a purchase with the JazzCash payment method, add the following parameters to your request:

Parameter	Type	Required	Description
merchantId	integer	Required	Your unique merchant ID that you got from Amanpay when integrating.
paymentId	string	Required	Payment ID unique within your system.
amount	number	Required	Purchase amount in major currency units, e.g., pass 10.52 for 10 dollars 52 cents or 11.00 for 11 dollars.
currency	string	Required	Code of the purchase currency in the ISO-4217 alpha-3 format.
customerId	string	Optional	Customer's ID unique within your system. If not passed in the request, the value from the customerEmail parameter is used.
customerEmail	string	Required	Customer's email.
paymentMethod	string	Optional	Payment method's code. Pass jazzcash in this parameter to preselect this payment method for your customer on the checkout page. If not passed, the customer will have to choose the payment method themselves on the checkout page.
jazzcashNumber	string	Optional	Customer's mobile phone number associated with their JazzCash e-wallet. If not passed, the customer will have to enter their mobile phone number themselves on the checkout page. Pass this parameter in the request together with the paymentMethod parameter.
returnUrl	string	Optional	URL to redirect the customer to after they've completed a payment.

You can also add any optional parameters described in the Create a purchase request section to your request.

Here is an example of a request to initiate a purchase with the JazzCash payment method.

curl -X POST "https://gateway.amanpay.io/payments/purchases/initiate" \
  -H "Content-Type: application/json" \
  -H "Authorization: b78d07bc3e51899182339bfb39c85ab8629085c80f9b2312444669a3bdd78cc0522a1bcca50ede6be3a90fcf489100304cde09e14fa51a175a5fed0e36f6c26b" \
  -d '{
    "merchantId": 1758378,
    "paymentId": "payment_812",
    "amount": 250.51,
    "currency": "PKR",
    "customerId": "customer174",
    "customerEmail": "mark_cooper@example.com",
    "paymentMethod": "jazzcash",
    "jazzcashNumber": "485927471757186"
}'

To initiate a payout with the JazzCash payment method, add the following parameters to your request:

Parameter	Type	Required	Description
merchantId	integer	Required	Your unique merchant ID that you got from Amanpay when integrating.
paymentId	string	Required	Payment ID unique within your system.
amount	number	Required	Payout amount in major currency units, e.g., pass 10.52 for 10 dollars 52 cents or 11.00 for 11 dollars.
currency	string	Required	Code of the payout currency in the ISO-4217 alpha-3 format.
customerId	string	Optional	Customer's ID unique within your system. If not passed in the request, the value from the customerEmail parameter is used.
customerEmail	string	Required	Customer's email.
customerName	string	Required	Customer's full name.
paymentMethod	string	Required	Payment method's code. Pass jazzcash in this parameter.
recipientType	string	Required	Customer's account type. Pass mobile_wallet in this parameter.
recipientMobileNumber	string	Required	Customer's mobile phone number associated with their JazzCash e-wallet.

You can also add any optional parameters described in the Create a payout request section to your request.

Here is an example of a request to initiate a payout with the JazzCash payment method.

curl -X POST "https://gateway.amanpay.io/payments/payouts/initiate" \
  -H "Content-Type: application/json" \
  -H "Authorization: b78d07bc3e51899182339bfb39c85ab8629085c80f9b2312444669a3bdd78cc0522a1bcca50ede6be3a90fcf489100304cde09e14fa51a175a5fed0e36f6c26b" \
  -d '{
    "merchantId": 1758378,
    "paymentId": "payment_812",
    "amount": 250.51,
    "currency": "PKR",
    "customerId": "customer174",
    "customerEmail": "mark_cooper@example.com",
    "customerName": "Mark Cooper",
    "paymentMethod": "jazzcash",
    "recipientType": "mobile_wallet",
    "recipientMobileNumber": "485927471757186"
}'