EazzPay Initiate Payment API Documentation

The `EazzPay Initiate Payment API allows businesses to create payment requests and redirect customers to complete transactions. This guide includes step-by-step instructions and examples in different programming languages.

Request URL

To initiate a payment, make a POST request to the following API endpoint:

{base_URL}/api/v1/payments/initiate

Ensure to replace {base_URL} with the live API endpoint URL provided in your EazzPay Merchant Dashboard.

Request Headers

Include these headers in your request:

Header Name	Value
`Content-Type`	`"application/json"`
`Accept`	`"application/json"`
`eazzpay-client-secret`	Your API Key from the Merchant Dashboard

Request Parameters

Request Payload

Upon successful initiation, the API returns the following response:

{
  "cus_name": "John Doe", 
  "amount": 100, 
  "metadata": "{"order_id":"123456","items":[{"product_id":"A1B2C3","product_name":"Widget A","quantity":2,"price":50},{"product_id":"D4E5F6","product_name":"Widget B","quantity":1,"price":50.75}],"discount":"10% off for first order","customer_note":"Please deliver between 9 AM and 5 PM"}", 
  "success_url": "https://your-frontend.com/success", 
  "cancel_url": "https://your-frontend.com/cancel", 
  "ipn_url": "https://your-backend.com/ipn", 
  "ipn_method": "POST"
}

Parameter Details

Parameter	Required	Type	Description
`cus_name`	Yes	`string`	Customer's name (100 characters).
`amount`	Yes	`number`	Payment amount (valid numeric value).
`metadata`	No	`string`	JSON string for order details (max 1000 characters).
`success_url`	Yes	`string`	Redirect URL for successful payment (100 characters).
`cancel_url`	Yes	`string`	Redirect URL for canceled payment (100 characters).
`ipn_url`	Yes	`string`	IPN callback URL (100 characters).
`ipn_method`	No	`string`	HTTP method for IPN (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `OPTIONS`, and `HEAD`). Default: `POST`.

Success Response Example

Upon successful initiation, the API returns the following response:

{
  "data": {
    "payment_id": "67adb1d9a7436e9d01c5934c",
    "reference": "PAY--10001",
    "transaction_status": "INITIATED",
    "amount": 100,
    "payment_init_time": "2025-02-13T08:48:25.054Z",
    "eazzpay_url": "https://pay.eazzpay.com/payments/67adb1d9a7436e9d01c5934c",
    "success_url": "https:/your-frontend.com/success",
    "cancel_url": "https:/your-frontend.com/cancel",
    "ipn_url": "https://your-backend.com/ipn",
    "ipn_method": "POST"
  },
  "code": 201,
  "message": "Payment initiated successfully"
}

Response Fields

Root Level

Field	Type	Description
`code`	`number`	HTTP status code indicating success, e.g., `201`.
`message`	`string`	Descriptive message confirming the operation.

Data Object

Field	Type	Description
`payment_id`	`string`	Unique identifier for the payment transaction.
`reference`	`string`	A reference for the payment, useful for tracking.
`transaction_status`	`string`	Current status of the transaction, e.g., `INITIATED`.
`amount`	`number`	Payment amount.
`payment_init_time`	`string`	Timestamp of payment initiation.
`eazzpay_url`	`string`	URL for customer redirection to complete the payment.
`success_url`	`string`	Redirect URL for successful payment.
`cancel_url`	`string`	Redirect URL for canceled payment.
`ipn_url`	`string`	IPN callback URL.
`ipn_method`	`string`	HTTP method for IPN requests.

Error Response Example

In case of an error, the API returns the following response:

{
  "message": "Invalid eazzpay configuration",
  "error": "Not Acceptable",
  "code": 406
}

Error Response Fields

Field	Type	Description
`message`	`string`	Description of the error.
`error`	`string`	Error type, e.g., `Not Acceptable`.
`code`	`number`	HTTP status code indicating the error, e.g., `406`.

Example Requests

const axios = require('axios');
 
const eazzpay_base_url = "https://sandbox.eazzpay.com/api/v1";
const eazzpay_client_secret = "yQPslmdjbuNKUhf9dxoNpDm5pMhAXV3rcvWY";
 
const options = {
  method: 'POST',
  url: `${eazzpay_base_url}/payments/initiate`,
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'eazzpay-client-secret': eazzpay_client_secret
  },
  data: {
    cus_name: 'John Doe',
    amount: 100,
    metadata: {
      order_id: '123456',
      items: [
        { product_id: 'A1B2C3', product_name: 'Widget A', quantity: 2, price: 50 }
      ]
    },
    success_url: 'https://your-frontend.com/success',
    cancel_url: 'https://your-frontend.com/cancel',
    ipn_url: 'https://your-backend.com/ipn',
    ipn_method: 'POST'
  }
};
 
axios.request(options)
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

Notes

Sandbox Environment: Use this environment for testing your integration.
Live Environment: Switch to live after successful testing.