Scenario 1. Purchase with payment instructions

When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).

Countries and regions Pakistan
Payment currencies PKR
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.
Special considerations
  • Payment finalization may take as long as 24 hours.
  • If the customer fails to enter the valid transaction ID within one hour after the payment was initiated, the payment is automatically declined.
  • If the customer enters an incorrect payment amount, the payment is processed in a specific way described in the section Handling payments with amount changed by customer.

Operations support

Interfaces
Payment Page Gate Dashboard
Purchase

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Easypaisa payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Easypaisa payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The checkout page is displayed to the customer.
  4. The customer chooses to make a purchase with the Easypaisa payment method.
  5. The payment platform forwards the request to the Easypaisa service.
  6. The Easypaisa service generates the payment instructions to show to the customer and sends them to the payment platform.
  7. The checkout page displays the payment instructions to the customer.
  8. The customer completes the purchase.
  9. The Easypaisa service sends the transaction ID to the customer.
  10. The customer enters the transaction ID on the checkout page.
  11. The payment platform forwards the request with the transaction ID to the Easypaisa service.
  12. The Easypaisa service sends the purchase result information to the payment platform.
  13. The payment platform sends a callback with the payment result to your system.
  14. The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Easypaisa payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ParameterDescription

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

account_customer_name
string
required

Customer's full name.

Example: John Doe

account_number
string
required

Customer's e-wallet number.

Example: 1234567

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: PKR

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 PKR must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the Easypaisa payment method for your customer and skip the page with payment method selections.

To enforce the Easypaisa payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to easypaisa-wallet. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'easypaisa-wallet'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_email: 'johndoe@example.com',
		account_customer_name: 'John Doe',
		account_number: '1234567',
		payment_currency: 'PKR',
		payment_amount: 10000,
		force_payment_method: 'easypaisa-wallet',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Easypaisa payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "easypaisa",
        "sum": {
            "amount": 10000,
            "currency": "PKR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "PKR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PKR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 3. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "easypaisa",
        "sum": {
            "amount": 10000,
            "currency": "PKR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "PKR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PKR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Purchase by using Gate

General information

To perform a purchase by using Gate with the Easypaisa payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with payment instructions to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Easypaisa payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the Easypaisa service.
  5. The Easypaisa service generates the payment instructions to show to the customer and sends them to the payment platform.
  6. The payment platform forwards the instructions to your system in the display_data array.
  7. Your system displays the payment instructions to the customer.
  8. The customer completes the purchase.
  9. The Easypaisa service sends the transaction ID to the customer.
  10. The customer enters the transaction ID in your system.
  11. Your system sends the request with the transaction ID to the payment platform.
  12. The payment platform sends your system the response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  13. The payment platform forwards the request with the transaction ID to the Easypaisa service.
  14. The Easypaisa service informs the payment platform about the purchase result.
  15. The payment platform sends the callback with the payment result to your system.
  16. Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Easypaisa payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/wallet/easypaisa/sale
Full API endpoint specification /v2/payment/wallet/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.
ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

number
string
strictly required

Customer's e-wallet number.

Example: 1234567890

customer_name
string
strictly required

Customer's full name.

Example: John Doe

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: PKR

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 PKR must be sent as 10000

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Easypaisa payment method:

Figure 5. Example of the purchase request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "1234567890123456",
        "customer_name": "John Doe"
    },
    "payment": {
        "currency": "PKR",
        "amount": 10000
    }
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Each element of this array contains the following parameters:

  • type—element type. its value is always add_info.
  • title—name of the payment instruction data, can take one the following values:
    • receiver_name—name of the payment recipient
    • account_number—account number of the payment recipient
  • data—payment instruction data

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "receiver_name",
        "data": "example"
    },
    {
        "type": "add_info",
        "title": "account_number",
        "data": "1234567891"
    }
]

The following is an example of payment instructions which you can display in your system:

Instruction text in Urdu Instruction text in English

ادائیگی کے لیے اہم ہدایات

  1. براہ کرم اس صفحہ پر دکھائی گئی رقم کے مطابق سختی سے فنڈز منتقل کریں،اور رقم میں ترمیم نہ کریں۔
  2. جب آپ ٹرانسفر کرتے ہیں تو آپ کو یہ یقینی بنانا ہوگا کہ ہمیں کل رقم بغیر کسی کٹوتی کے ملے۔
  3. غلطی کی صورت میں ہمیں کم یا زیادہ رقم مل جاتی ہے، ہم اس کے مطابق آپ کے اکاؤنٹ میں کریڈٹ کر دیں گے۔
  4. براہ کرم پہلے سے استعمال شدہ اکاؤنٹ میں براہ راست رقم نہ بھیجیں۔ ہم اس طرح کے ٹرانزیکشن کے ذمہ دار نہیں ہوں گے۔ ادائیگی کرتے وقت ہمیشہ ایک نیا آرڈر بنائیں۔
  5. براہ کرم 1 گھنٹے کے اندر ادائیگی مکمل کریں۔ اگر آپ 1 گھنٹے کے بعد ادائیگی کرتے ہیں تو براہ کرم کسٹمر سپورٹ سے رابطہ کریں۔
  6. براہ کرم مندرجہ بالا ادائیگی کی ہدایات کی سختی سے پابندی کریں۔ اگر کوئی خلاف ورزی ہوتی ہے، تو اکاؤنٹ میں کریڈٹ نہیں کیا جائے گا، اور پلیٹ فارم کسی بھی نقصان کے لیے ذمہ دار نہیں ہوگا۔
  7. براہ کرم آسان پیسہ ٹرانزیکشن آئی ڈی درج کریں۔
  8. براہ کرم درست رقم درج کریں۔
  9. براہ کرم ہمیں درست معلومات فراہم کریں جیسے کامیاب ٹرانزیکشن آئی ڈی اور رقم آپ کے اکاؤنٹ میں رقم جمع کرنے کے لیے۔

Payment Instructions

  1. Please transfer funds strictly in accordance with the amount displayed on this page,and do not modify amount.
  2. When you Transfer you have to make sure we receive the same amount without any deduction.
  3. In case of mistake we receive less or more amount, we will credit to your account accordingly.
  4. Please do not send money directly to the previously deposit accounts. It may not be trackable and we will not responsible for such transactions. Always place a new order before you like to pay.
  5. Please complete the payment within 1 hour. If you pay such transaction after 1 hour please contact with the customer support.
  6. *Please strictly abide by the above payment instructions. If there is any violation, the account will not be credited, and the platform will not be responsible for any losses caused. :
  7. Please enter Easypaisa transaction id
  8. Please Enter Correct Amount
  9. Please provide us correct information such as successful transaction ID and amount in order to funds credit to your account.

Submitting the transaction ID to the payment platform

After you received the transaction ID from the customer, you need to send it to the payment platform in a new request. Listed below are the instructions on how to build the request with the transaction ID.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/clarification
Table 3. Basic parameters of the request with the transaction ID

strictly required—the parameter must be in the initial request.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

additional_data
object
strictly required

additional_data
object
strictly required

txref
string
strictly required

The transaction ID your customer obtained from the Easypaisa service.

Example: 1234567890

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request with the transaction ID:

Figure 6. Example of the data from a request with the transaction ID 
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "additional_data": {
        "additional_data": {
            "txref": "1234567890"
        }
    }
}

Callback

In the Easypaisa payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 7. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "easypaisa",
        "sum": {
            "amount": 10000,
            "currency": "PKR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "PKR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PKR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 8. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "easypaisa",
        "sum": {
            "amount": 10000,
            "currency": "PKR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "PKR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PKR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics