Webhook events available on Plural.

The table below list the available webhook events on Plural with discriptions.

WebhookDescription
ORDER_AUTHORIZEDWhen the order is ready for authorization.
ORDER_PROCESSEDWhen the payment is successfully received.
ORDER_CANCELLEDWhen the order is cancelled.
PAYMENT_FAILEDWhen the payment against an order get failed.
REFUND_PROCESSEDWhen the refund is successful.

Sample Payload

ORDER_AUTHORIZED

Triggered when the order is ready for authorization. Shown below are the sample payloads returned against different payment method.

{
  "event_type": "ORDER_AUTHORIZED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "AUTHORIZED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828181232-aa-7cGcgo-cc-h",
        "status": "AUTHORIZED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "product_name": "",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7248687871426329503954",
          "rrn": "424118053313"
        },
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:13:08.418627Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152152Z",
    "updated_at": "2024-08-28T18:13:08.418627Z"
  }
}
{
  "event_type": "ORDER_AUTHORIZED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "AUTHORIZED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828181232-aa-7cGcgo-cc-h",
        "status": "AUTHORIZED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_token_details": {
            "name": "Test",
            "last4_digit": "1091",
            "cvv": "123",
            "expiry_month": "01",
            "expiry_year": "2026",
            "token": "4000000000001091",
            "cryptogram": "wAAAAAAl9SX1HsAmWKSgqwAAAA",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7248687871426329503954",
          "rrn": "424118053313"
        },
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:13:08.418627Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152152Z",
    "updated_at": "2024-08-28T18:13:08.418627Z"
  }
}
{
  "eventType": "ORDER_AUTHORIZED",
  "data": {
    "orderId": "v1-240813114804-aa-tgiDMn",
    "merchantOrderReference": "bf53f2c1-0334-43fc-9ca1-3a6f8a2cc35a",
    "type": "CHARGE",
    "status": "AUTHORIZED",
    "merchantId": "109968",
    "orderAmount": {
      "value": 200,
      "currency": "INR"
    },
    "notes": "",
    "preAuth": false,
    "purchaseDetails": {
      "customer": {
        "emailId": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "customerId": "192212",
        "mobileNumber": "192192883",
        "billingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shippingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchantMetadata": {}
    },
    "payments": [
      {
        "id": "v1-240813114804-aa-tgiDMn-cc-W",
        "status": "AUTHORIZED",
        "paymentAmount": {
          "value": 100,
          "currency": "INR"
        },
        "paymentMethod": "CARD",
        "paymentOption": {
          "cardData": {
            "cardType": "CREDIT",
            "networkName": "VISA",
            "issuerName": "NONE",
            "productName": "",
            "cardCategory": "CONSUMER",
            "countryCode": "IND"
          }
        },
        "captureData": []
      },
      {
        "id": "v1-240813114804-aa-tgiDMn-pt-9",
        "status": "AUTHORIZED",
        "paymentAmount": {
          "value": 100,
          "currency": "INR"
        },
        "paymentMethod": "POINTS",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": []
      }
    ],
    "createdAt": "seconds: 1723549684\\nnanos: 642626000\\n",
    "updatedAt": "seconds: 1723549844\\nnanos: 844050000\\n"
  }
}

ORDER_PROCESSED

Triggered when the payment is successfully received. Shown below are the sample payloads returned against different payment method.

{
  "event_type": "ORDER_PROCESSED",
  "data": {
    "order_id": "v1-240909084141-aa-O2oJwd",
    "merchant_order_reference": "a51688bd-34bb-4714-b40d-5fbbf381ba87",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 200,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      }
    },
    "payments": [
      {
        "id": "v1-240909084141-aa-O2oJwd-cc-N",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 200,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "product_name": "",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7258713154996001403955",
          "rrn": "425308234545"
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 200,
              "currency": "INR"
            },
            "created_at": "2024-09-09T08:50:41.082671Z"
          }
        ],
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:13:08.418627Z"
      }
    ],
    "created_at": "2024-09-09T08:41:41.026661Z",
    "updated_at": "2024-09-09T08:50:41.082671Z"
  }
}
{
  "event_type": "ORDER_PROCESSED",
  "data": {
    "order_id": "v1-240909084141-aa-O2oJwd",
    "merchant_order_reference": "a51688bd-34bb-4714-b40d-5fbbf381ba87",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 200,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      }
    },
    "payments": [
      {
        "id": "v1-240909084141-aa-O2oJwd-cc-N",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 200,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_token_details": {
            "name": "Test",
            "last4_digit": "1091",
            "cvv": "123",
            "expiry_month": "01",
            "expiry_year": "2026",
            "token": "4000000000001091",
            "cryptogram": "wAAAAAAl9SX1HsAmWKSgqwAAAA",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7258713154996001403955",
          "rrn": "425308234545"
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 200,
              "currency": "INR"
            },
            "created_at": "2024-09-09T08:50:41.082671Z"
          }
        ],
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:13:08.418627Z"
      }
    ],
    "created_at": "2024-09-09T08:41:41.026661Z",
    "updated_at": "2024-09-09T08:50:41.082671Z"
  }
}
{
  "eventType": "ORDER_PROCESSED",
  "data": {
    "orderId": "v1-240813114804-aa-tgiDMn",
    "merchantOrderReference": "bf53f2c1-0334-43fc-9ca1-3a6f8a2cc35a",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchantId": "109968",
    "orderAmount": {
      "value": 200,
      "currency": "INR"
    },
    "notes": "",
    "preAuth": false,
    "purchaseDetails": {
      "customer": {
        "emailId": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "customerId": "192212",
        "mobileNumber": "192192883",
        "billingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shippingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchantMetadata": {}
    },
    "payments": [
      {
        "id": "v1-240813114804-aa-tgiDMn-cc-W",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 100,
          "currency": "INR"
        },
        "paymentMethod": "CARD",
        "paymentOption": {
          "cardData": {
            "cardType": "CREDIT",
            "networkName": "VISA",
            "issuerName": "NONE",
            "productName": "",
            "cardCategory": "CONSUMER",
            "countryCode": "IND"
          }
        },
        "captureData": [
          {
            "merchantCaptureReference": "138e4a3f-1792-4f79-8f87-862b47231fd2",
            "captureAmount": {
              "value": 100,
              "currency": "INR"
            },
            "createdAt": "seconds: 1723549889\\nnanos: 204477632\\n"
          }
        ]
      },
      {
        "id": "v1-240813114804-aa-tgiDMn-pt-9",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 100,
          "currency": "INR"
        },
        "paymentMethod": "POINTS",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": [
          {
            "merchantCaptureReference": "138e4a3f-1792-4f79-8f87-862b47231fd2",
            "captureAmount": {
              "value": 100,
              "currency": "INR"
            },
            "createdAt": "seconds: 1723549953\\nnanos: 204822932\\n"
          }
        ]
      }
    ],
    "createdAt": "seconds: 1723549684\\nnanos: 642626000\\n",
    "updatedAt": "seconds: 1723549953\\nnanos: 279280000\\n"
  }
}
{
  "event_type": "ORDER_PROCESSED",
  "data": {
    "order_id": "v1-240912090202-aa-LAKYlA",
    "merchant_order_reference": "6c59c3e2-3cc8-4207-bdf5-49b976cb8077",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "110047",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "joe",
        "last_name": "kumar",
        "customer_id": "192212",
        "mobile_number": "192192883",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-240912090202-aa-LAKYlA-up-s",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "UPI",
        "payment_option": {
          "upi_data": {
            "txn_mode": "INTENT",
            "payee": {
              "reference_id": "174425",
              "reference_type": "MERCHANT",
              "vpa": "pinelabs.24092@hdfcbank",
              "acquirer_name": "HDFC"
            },
            "payer": {
              "vpa": "saklania8-2@okicici",
              "phone_number": "918979279800",
              "account_type": "SAVINGS"
            }
          }
        },
        "acquirer_data": {
          "approval_code": "00",
          "acquirer_reference": "462274903205",
          "rrn": ""
        }
      }
    ],
    "created_at": "2024-09-12T09:02:02.024600Z",
    "updated_at": "2024-09-12T09:04:41.960102Z"
  }
}

ORDER_CANCELLED

Triggered when the order is cancelled. Shown below are the sample payloads returned against different payment method.

{
  "event_type": "ORDER_CANCELLED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "CANCELLED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828181232-aa-7cGcgo-cc-h",
        "status": "CANCELLED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "product_name": "",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7248688579796775203955",
          "rrn": "424118053313"
        },
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:14:18.965793Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152152Z",
    "updated_at": "2024-08-28T18:14:18.965793Z"
  }
}
{
  "event_type": "ORDER_CANCELLED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "CANCELLED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828181232-aa-7cGcgo-cc-h",
        "status": "CANCELLED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_token_details": {
            "name": "Test",
            "last4_digit": "1091",
            "cvv": "123",
            "expiry_month": "01",
            "expiry_year": "2026",
            "token": "4000000000001091",
            "cryptogram": "wAAAAAAl9SX1HsAmWKSgqwAAAA",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7248688579796775203955",
          "rrn": "424118053313"
        },
        "created_at": "2024-08-28T18:12:32.152152Z",
        "updated_at": "2024-08-28T18:14:18.965793Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152152Z",
    "updated_at": "2024-08-28T18:14:18.965793Z"
  }
}
{
  "eventType": "ORDER_CANCELLED",
  "data": {
    "orderId": "v1-240813104001-aa-NV193P",
    "merchantOrderReference": "merchant-reference-42",
    "type": "CHARGE",
    "status": "CANCELLED",
    "merchantId": "109968",
    "orderAmount": {
      "value": 1000,
      "currency": "INR"
    },
    "notes": "",
    "preAuth": false,
    "purchaseDetails": {
      "customer": {
        "emailId": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "customerId": "192212",
        "mobileNumber": "192192883",
        "billingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shippingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchantMetadata": {}
    },
    "payments": [
      {
        "id": "v1-240813104001-aa-NV193P-cc-9",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 500,
          "currency": "INR"
        },
        "paymentMethod": "CARD",
        "paymentOption": {
          "cardData": {
            "cardType": "CREDIT",
            "networkName": "VISA",
            "issuerName": "NONE",
            "productName": "",
            "cardCategory": "CONSUMER",
            "countryCode": "IND"
          }
        },
        "captureData": []
      },
      {
        "id": "v1-240813104001-aa-NV193P-pt-S",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 500,
          "currency": "INR"
        },
        "paymentMethod": "POINTS",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": []
      }
    ],
    "createdAt": "seconds: 1723545601\\nnanos: 914184000\\n",
    "updatedAt": "seconds: 1723565726\\nnanos: 776602000\\n"
  }
}

PAYMENT_FAILED

Triggered when the payment against an order get failed. Shown below are the sample payloads returned against different payment method.

{
  "event_type": "PAYMENT_FAILED",
  "data": {
    "order_id": "v1-240828180835-aa-IKvddb",
    "merchant_order_reference": "4de00e1f-4855-4454-bf50-c0f7dd680e27",
    "type": "CHARGE",
    "status": "FAILED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828180835-aa-IKvddb-cc-2",
        "status": "FAILED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "product_name": "",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248685878696292803954",
          "rrn": ""
        },
        "capture_data": [
          {
            "merchant_capture_reference": "f631c5ce-1c2b-4dca-a80b-59b0f055771e",
            "capture_amount": {
              "value": 100,
              "currency": "INR"
            },
            "created_at": "2024-09-05T06:30:39.296978016Z"
          }
        ],
        "error_detail": {
          "code": "PAYMENT_DECLINED",
          "message": "Transaction declined by Acquirer due to unknown reason"
        },
        "created_at": "2024-08-28T18:08:35.651366Z",
        "updated_at": "2024-08-28T18:10:15.584550Z"
      }
    ],
    "created_at": "2024-08-28T18:08:35.651366Z",
    "updated_at": "2024-08-28T18:10:15.584550Z"
  }
}
{
  "event_type": "PAYMENT_FAILED",
  "data": {
    "order_id": "v1-240828180835-aa-IKvddb",
    "merchant_order_reference": "4de00e1f-4855-4454-bf50-c0f7dd680e27",
    "type": "CHARGE",
    "status": "FAILED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828180835-aa-IKvddb-cc-2",
        "status": "FAILED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "product_name": "",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248685878696292803954",
          "rrn": ""
        },
        "error_detail": {
          "code": "USER_AUTHENTICATION_FAILED",
          "message": "Consumer Authentication failed"
        },
        "created_at": "2024-08-28T18:08:35.651366Z",
        "updated_at": "2024-08-28T18:10:15.584550Z"
      }
    ],
    "created_at": "2024-08-28T18:08:35.651366Z",
    "updated_at": "2024-08-28T18:10:15.584550Z"
  }
}
{
  "event_type": "PAYMENT_FAILED",
  "data": {
    "order_id": "v1-240828180835-aa-IKvddb",
    "merchant_order_reference": "4de00e1f-4855-4454-bf50-c0f7dd680e27",
    "type": "CHARGE",
    "status": "FAILED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-240828180835-aa-IKvddb-cc-2",
        "status": "FAILED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_token_details": {
            "name": "Test",
            "last4_digit": "1091",
            "cvv": "123",
            "expiry_month": "01",
            "expiry_year": "2026",
            "token": "4000000000001091",
            "cryptogram": "wAAAAAAl9SX1HsAmWKSgqwAAAA",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248685878696292803954",
          "rrn": ""
        },
        "capture_data": [
          {
            "merchant_capture_reference": "f631c5ce-1c2b-4dca-a80b-59b0f055771e",
            "capture_amount": {
              "value": 100,
              "currency": "INR"
            },
            "created_at": "2024-09-05T06:30:39.296978016Z"
          }
        ],
        "error_detail": {
          "code": "PAYMENT_DECLINED",
          "message": "Transaction declined by Acquirer due to unknown reason"
        },
        "created_at": "2024-08-28T18:08:35.651366Z",
        "updated_at": "2024-08-28T18:10:15.584550Z"
      }
    ],
    "created_at": "2024-08-28T18:08:35.651366Z",
    "updated_at": "2024-08-28T18:10:15.584550Z"
  }
}
{
  "eventType": "PAYMENT_FAILED",
  "data": {
    "orderId": "v1-240816104837-aa-ewN96Q",
    "merchantOrderReference": "merchant-reference-49",
    "type": "CHARGE",
    "status": "FAILED",
    "merchantId": "109968",
    "orderAmount": {
      "value": 10000,
      "currency": "INR"
    },
    "notes": "",
    "preAuth": false,
    "purchaseDetails": {
      "customer": {
        "emailId": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "customerId": "192212",
        "mobileNumber": "192192883",
        "billingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shippingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchantMetadata": {}
    },
    "payments": [
      {
        "id": "v1-240816104837-aa-ewN96Q-cc-O",
        "status": "FAILED",
        "paymentAmount": {
          "value": 5000,
          "currency": "INR"
        },
        "paymentMethod": "CARD",
        "paymentOption": {
          "cardData": {
            "cardType": "CREDIT",
            "networkName": "VISA",
            "issuerName": "NONE",
            "productName": "",
            "cardCategory": "CONSUMER",
            "countryCode": "IND"
          }
        },
        "capture_data": [
          {
            "merchant_capture_reference": "f631c5ce-1c2b-4dca-a80b-59b0f055771e",
            "capture_amount": {
              "value": 100,
              "currency": "INR"
            },
            "created_at": "2024-09-05T06:30:39.296978016Z"
          }
        ]
      },
      {
        "id": "v1-240816104837-aa-ewN96Q-pt-3",
        "status": "FAILED",
        "paymentAmount": {
          "value": 5000,
          "currency": "INR"
        },
        "paymentMethod": "POINTS",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": []
      }
    ],
    "createdAt": "seconds: 1723805317\\nnanos: 141879000\\n",
    "updatedAt": "seconds: 1723805614\\nnanos: 88148000\\n"
  }
}
{
  "event_type": "PAYMENT_FAILED",
  "data": {
    "order_id": "v1-240912102222-aa-lZedaQ",
    "merchant_order_reference": "99a6329d-031a-4c94-acd9-4c1682b1933e",
    "type": "CHARGE",
    "status": "FAILED",
    "merchant_id": "110047",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "notes": "some order",
    "pre_auth": false,
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "joe",
        "last_name": "kumar",
        "customer_id": "192212",
        "mobile_number": "192192883",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-240912102222-aa-lZedaQ-up-4",
        "status": "FAILED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "UPI",
        "payment_option": {
          "upi_data": {
            "txn_mode": "COLLECT",
            "payee": {},
            "payer": {}
          }
        },
        "error_detail": {
          "code": "UNAUTHORIZED",
          "message": "Merchant is not configured for payment"
        }
      }
    ],
    "created_at": "2024-09-12T10:22:22.383244Z",
    "updated_at": "2024-09-12T10:22:32.173377Z"
  }
}

Note: Capture block will be present if the capture for an order fails.

REFUND_PROCESSED

Triggered when the refund is successful. Shown below are the sample payloads returned against different payment method.

{
  "event_type": "REFUND_PROCESSED",
  "data": {
    "order_id": "v1-240828181713-aa-hNlYwt",
    "merchant_order_reference": "18c693c4-27ce-444d-a040-9dc3dcc06213",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {},
    "payments": [
      {
        "id": "v1-240828181713-aa-hNlYwt-cc-K",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248690362736367903954",
          "rrn": ""
        },
        "created_at": "2024-08-28T18:17:13.147756Z",
        "updated_at": "2024-08-28T18:17:17.157774Z"
      }
    ],
    "created_at": "2024-08-28T18:17:13.147756Z",
    "updated_at": "2024-08-28T18:17:17.157774Z"
  }
}
{
  "event_type": "REFUND_PROCESSED",
  "data": {
    "order_id": "v1-240828181713-aa-hNlYwt",
    "merchant_order_reference": "18c693c4-27ce-444d-a040-9dc3dcc06213",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {},
    "payments": [
      {
        "id": "v1-240828181713-aa-hNlYwt-cc-K",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248690362736367903954",
          "rrn": ""
        },
        "created_at": "2024-08-28T18:17:13.147756Z",
        "updated_at": "2024-08-28T18:17:17.157774Z"
      }
    ],
    "created_at": "2024-08-28T18:17:13.147756Z",
    "updated_at": "2024-08-28T18:17:17.157774Z"
  }
}
{
  "eventType": "ORDER_PROCESSED",
  "data": {
    "orderId": "v1-240820071549-aa-WxMmCj",
    "merchantOrderReference": "1a560755-be72-4873-a5a7-36d362301574",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchantId": "109968",
    "orderAmount": {
      "value": 50000,
      "currency": "INR"
    },
    "notes": "",
    "preAuth": false,
    "purchaseDetails": {
      "customer": {
        "emailId": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "customerId": "192212",
        "mobileNumber": "192192883",
        "billingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shippingAddress": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchantMetadata": {}
    },
    "payments": [
      {
        "id": "v1-240820071549-aa-WxMmCj-cc-3",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 15000,
          "currency": "INR"
        },
        "paymentMethod": "CARD",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": []
      },
      {
        "id": "v1-240820071549-aa-WxMmCj-pt-7",
        "status": "PROCESSED",
        "paymentAmount": {
          "value": 35000,
          "currency": "INR"
        },
        "paymentMethod": "POINTS",
        "paymentOption": {
          "cardData": {
            "cardType": "",
            "networkName": "",
            "issuerName": "",
            "productName": "",
            "cardCategory": "",
            "countryCode": ""
          }
        },
        "captureData": []
      }
    ],
    "createdAt": "seconds: 1724138149\\nnanos: 328290000\\n",
    "updatedAt": "seconds: 1724138154\\nnanos: 552240000\\n"
  }
}
{
  "event_type": "REFUND_PROCESSED",
  "data": {
    "order_id": "v1-240912062449-aa-V2v5g5",
    "merchant_order_reference": "42f74f54-f9fa-477a-aabb-082682ee3074",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "110047",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {},
    "payments": [
      {
        "id": "v1-240912062449-aa-V2v5g5-up-T",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "UPI",
        "payment_option": {
          "upi_data": {
            "txn_mode": "INTENT",
            "payee": {
              "reference_id": "174425",
              "reference_type": "MERCHANT",
              "vpa": "pinelabs.24092@hdfcbank",
              "acquirer_name": "HDFC"
            },
            "payer": {
              "vpa": "saklania8-2@okicici",
              "phone_number": "918979279800",
              "account_type": "SAVINGS"
            }
          }
        },
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "425600485036",
          "rrn": ""
        }
      }
    ],
    "created_at": "2024-09-12T06:24:49.834631Z",
    "updated_at": "2024-09-12T06:24:53.389484Z"
  }
}
{
  "event_type": "REFUND_PROCESSED",
  "data": {
    "order_id": "v1-240828181713-aa-hNlYwt",
    "merchant_order_reference": "18c693c4-27ce-444d-a040-9dc3dcc06213",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "purchase_details": {},
    "payments": [
      {
        "id": "v1-240828181713-aa-hNlYwt-cc-K",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248690362736367903954",
          "rrn": ""
        },
        "created_at": "2024-08-28T18:17:13.147756Z",
        "updated_at": "2024-08-28T18:17:17.157774Z"
      },
      {
        "id": "v1-240828182019-aa-aclhwT-cc-v",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "8948680362736382908954",
          "rrn": ""
        },
        "created_at": "2024-08-28T18:14:19.147756Z",
        "updated_at": "2024-08-28T18:14:19.157774Z"
      }
    ],
    "created_at": "2024-08-28T18:17:13.147756Z",
    "updated_at": "2024-08-28T18:17:17.157774Z"
  }
}