Receive Payment Notification (IPN)

The full official SSLCOMMERZ v4 reference for the Instant Payment Notification your IPN listener receives.

Validate Payment with IPN

Remember, We have set an IPN URL in first step so that your server can listen at the right moment when payment is done at Bank End. So, It is important to validate the transaction notification to maintain security and standard.

Grab the Notification

As IPN URL already set in panel. All the payment notification will reach through IPN prior to user return back. So it needs validation for amount and transaction properly.

The IPN will send a POST REQUEST with below parameters. Grab the post notification with your desired platform ( PHP: $_POST)

Param Name	Data Type	Description
status	string (20)	Transaction Status - as VALID / FAILED / CANCELLED / EXPIRED / UNATTEMPTED This parameter needs to be checked before update your database VALID : A successful transaction. FAILED : Transaction is declined by customer's Issuer Bank. CANCELLED : Transaction is cancelled by the customer. UNATTEMPTED : Customer did not choose to pay any channel. EXPIRED : Payment Timeout.
tran_date	datetime	Transaction date - Payment completion date as 2016-05-08 15:53:49 ( PHP date('Y-m-d H:i:s') )
tran_id	string (30)	Transaction ID (Unique) that was sent by you during initiation. This parameter needs to be validated with your system database for security
val_id	string (50)	A Validation ID against the Transaction which is provided by SSLCOMMERZ.
amount	decimal (10,2)	The total amount sent by you. However, it could be changed based on currency type. This parameter needs to be validated with your system database for security
store_amount	decimal (10,2)	The amount what you will get in your account after bank charge ( Example: 100 BDT will be your store amount of 96 BDT after 4% Bank Commission )
card_type	string (50)	The Bank Gateway Name that customer selected
card_no	string (80)	Customer’s Card number. However, for Mobile Banking and Internet Banking, it will return customer's reference id.
currency	string (3)	Currency Type which will be settled with your merchant account after deducting the Gateway charges. This parameter is the currency type of the parameter amount
bank_tran_id	string (80)	The transaction ID at Banks End
card_issuer	string (100)	Issuer Bank Name
card_brand	string (30)	VISA, MASTER, AMEX, IB or MOBILE BANKING
card_issuer_country	string (50)	Country of Card Issuer Bank
card_issuer_country_code	string (2)	2 digits short code of Country of Card Issuer Bank
currency_type	string (3)	The currency you have sent during initiation of this transaction. If the currency is different than BDT, then it will be converted to BDT by the current conversion rate. This parameter needs to be validated with your system database for security
currency_amount	decimal (10,2)	The currency amount you have sent during initiation of this transaction. If the amount is not mentioned in BDT, then it will be converted to BDT by the current conversion rate and return by the above field amount. This parameter needs to be validated with your system database for security
value_a	string (255)	Same Value will be returned as Passed during initiation
value_b	string (255)	Same Value will be returned as Passed during initiation
value_c	string (255)	Same Value will be returned as Passed during initiation
value_d	string (255)	Same Value will be returned as Passed during initiation
verify_sign	string (255)	Data Validation Key
verify_key	string	Data Validation Key
risk_level	integer (1)	Transaction's Risk Level - High (1) for most risky transactions and Low (0) for safe transactions. Please hold the service and proceed to collect customer verification documents
risk_title	string (50)	Transaction's Risk Level Description

cURL

POST <YOUR IPN LISTENER>

$ curl -X POST <YOUR IPN LISTENER MENTIONED BY YOU IN YOUR MERCHANT PANEL>
-d
'tran_id=5a16c68b23783&
val_id=1711231900331kHP17lnrr9T8Gt&
amount=100&
card_type=VISA-Dutch Bangla&
store_amount=97&
card_no=425272XXXXXX3456&
bank_tran_id=1711231900331S0R8atkhAZksmM&
status=VALID&
tran_date=2017-11-23 18:59:55&
currency=BDT&
card_issuer=Standard Chartered Bank&
card_brand=VISA&
card_issuer_country=Bangladesh&
card_issuer_country_code=BD&
store_id=testbox&
verify_sign=8070c0cefed9e629b01100d8a92afda2&
verify_key=amount,bank_tran_id,base_fair,card_brand,card_issuer,card_issuer_country,card_issuer_country_code,card_no,card_type,currency,currency_amount,currency_rate,currency_type,risk_level,risk_title,status,store_amount,store_id,tran_date,tran_id,val_id,value_a,value_b,value_c,value_d&
cus_fax=01711111111&
currency_type=BDT&
currency_amount=100.00&
currency_rate=1.0000&
base_fair=0.00&
value_a=ref001_A&
value_b=ref002_B&
value_c=ref003_C&
value_d=ref004_D&
risk_level=0&
risk_title=Safe'

Response Example

<YOU CAN PRINT ANY MESSAGE>

PHP

<?php

// Your IPN listener endpoint - the URL registered in the merchant panel.
$notification = $_POST;

if (($notification['status'] ?? null) !== 'VALID') {
    http_response_code(200); // acknowledge receipt; nothing to do yet
    exit;
}

// Never trust the notification on its own - always re-validate
// server-to-server via the Order Validation API below before updating
// your database.

Laravel

use Illuminate\Http\Request;

public function handle(Request $request)
{
    $notification = $request->all();

    if (($notification['status'] ?? null) !== 'VALID') {
        return response()->noContent(); // acknowledge; nothing to do yet
    }

    // Never trust the notification on its own - always re-validate
    // server-to-server via the Order Validation API below before updating
    // your database.
}