1. Documentation
  2. Parameters Explanation

Parameters Explanation

Parameters For Request

Key Type Description Sample Value Required
fullname string Full name of the payer Rohim Khan Yes
email string Email address of the payer [email protected] Yes
amount int Payment amount 10 Yes
return_type string Response return type. Only GET and POST are allowed POST Yes
currency string Currency code USD Optional
currency_value float Conversion value of the currency relative to your base 120 Optional
redirect_url url URL to redirect to after a successful payment https://example.com/redirect.php Yes
cancelled_url url URL to redirect to if the payment is canceled https://example.com/cancelled.php Yes
metadata json Additional data about the transaction {"order_id" : 1, "product" : "apple"} Optional
webhook json URLs for success and cancellation events {"success" : URL, "cancel" : URL} Optional

Webhook Fields

Key Type Description Sample Value Required
success url Webhook URL to handle successful payment https://example.com/success.php Optional
cancel url Webhook URL to handle canceled payment https://example.com/cancel.php Optional

Returned Parameters After Request Created

Key Type Description Sample Value
responseCode int The response code indicating response status. 200
message string Response message corresponding to the responseCode. request created successfully
status string Returns the status of the request. success
paymentkey string A unique Key for the specific payment. paymentkey
payment_url url Direct URL for taking payment. payment_url

Returned Parameters On Error

Key Type Description Sample Value
responseCode int The response code indicating response status. 1011
message string Response message corresponding to the responseCode. something went wrong
status string Returns the status of the request. failed

Parameters For Verify And Execute

Key Type Description Sample Value Required
paymentkey string Unique payment key generated after creating payment request JeY5Bg44IG4E76uNHAO4 Yes