Payment Webhook services allows you to enable automatic updates regarding payment enquiry. It allows you to get notified about the status of your payments.

Webhook provide you with information on:

Payment status
Payment charges

📘
Important information

Responding to the webhook you receive
To acknowledge that you received the web hook without any problem, your server should return response as json { status: "OK" }. You need to respond to the web hook.

What happens when a webhook is not received?
When a webhook is not received for whatever reason, will continue trying to send the web hook once every hour for a maximum of 3 attempts after which they will be discarded. Web hooks will automatically be deactivated if three or more events get discarded.

Payment status

{
  "service": "svWebHookPaymentStatus",
  "companyCode": "Company_Code",
  "payments": [
    {
      "payId": "Payment_ID",
      "authId": "Authentication_ID",
      "seqNum": "Sequence_Number",
      "svRefId": "SV_Reference_ID",
      "amount": 00.00,
      "currency": "Currency",
      "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
      "status": Status_Code, // 0 - COMPLETED, 1 - FAILED, 2 - BANK PROCESS, 3 - ONHOLD, 4 -OPEN
      "approval_status": Approval_Status_Code // 0 - IN PROGRESS, 1 - REVIEWED, 2 - APPROVED, 3 - EXECUTED, 4 - REJECTED 
    },
    {
      "payId": "Payment_ID",
      "authId": "Authentication_ID",
      "seqNum": "Sequence_Number",
      "svRefId": "SV_Reference_ID",
      "amount": 00.00,
      "currency": "Currency",
      "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
      "status": Status_Code, // 0 - COMPLETED, 1 - FAILED, 2 - BANK PROCESS, 3 - ONHOLD, 4 -OPEN
      "approval_status": Approval_Status_Code // 0 - IN PROGRESS, 1 - REVIEWED, 2 - APPROVED, 3 - EXECUTED, 4 - REJECTED
    }
  ]
}

Response description:

JSON Tag	Description	Data type
svWebHookPaymentStatus	Web Hook Payment Status response tag	Object
companyCode	Unique company code	String
payment	Array of payments	Array
authId	SingleView Authentication ID	String
payId	Unique reference id toward payment request from ERP	String
seqNum	Sequence number	String
svRefId	SingleView Reference ID	String
amount	Amount	String
currency	Currency of payment	String
txnDate	Transaction date	String
status	Status of the payment	String
approval_status	Approval status of the payment request	String

Payment charges

{
  "service": "svWebHookPaymentCharge",
  "companyCode": "Company_Code",
  "payments": [
    {
      "payId": "Payment_ID",
      "authId": "Authentication_ID",
      "seqNum": "Sequence_Number",
      "svRefId": "SV_Reference_Number",
      "amount": 00.00,
      “bankCharges”: “Y or N”,  // Y - Post , N - don’t Post
      "chargeAmount":00.00,
      "currency": "Currency",
      "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
      "status": Status_Code, // 0 - COMPLETED , 1 -  FAILED, 2 - BANK PROCESS , 3 - ONHOLD , 4 -OPEN
      "approval_status": Approval_Status_Code // 0 -  IN PROGRESS, 1 - REVIEWED, 2 - APPROVED , 3 - EXECUTED , 4 - REJECTED 
    },
    {
      "payId": "Payment_ID",
      "authId": "Authentication_ID",
      "seqNum": "Sequence_Number",
      "svRefId": "SV_Reference_Number",
      "amount": 00.00, 
      "bankCharges": "Y or N",  // Y - Post , N - Don’t Post
      "chargeAmount":00.00,
      "currency": "Currency",
      "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
      "status": Status_Code, // 0 - COMPLETED, 1 - FAILED, 2 - BANK PROCESS, 3 - ONHOLD, 4 -OPEN
      "approval_status": Approval_Status_Code // 0 - IN PROGRESS, 1 - REVIEWED, 2 - APPROVED, 3 - EXECUTED, 4 - REJECTED
    }
  ]
}

JSON Tag	Description	Data type
svWebHookPaymentCharge	Web Hook Payment Status response tag	Object
companyCode	Unique company code	String
payment	Array of payments	Array
payId	Unique reference id toward payment request from ERP	String
authId	SingleView Authentication ID	String
seqNum	Sequence number	String
svRefId	SingleView Reference ID	String
amount	Amount	String
chargeAmount	Amount charged	String
currency	Currency of payment	String
txnDate	Transaction date	String
approval_status	Approval status of the payment request	String
bankCharges	Amount charged by the bank	String
status	Status of the payment	String

📘
Note
Refer Types & Statuses for more info on payment status update codes.

Webhook

📘
Important information

Payment status

Payment charges

📘
Note

📘Important information

Payment status

Payment charges

📘Note

📘
Important information

📘
Note