Webhook Events — Available Event Types

The table below list the available webhook events on Pine Labs Online with descriptions.

Webhook Events Name	Webhook Events Description
`CUSTOMER_ACTIVATED`	When the customer is activated on Pine Labs Online platform.
`CUSTOMER_DELETED`	When the customer is removed from Pine Labs Online system.
`CUSTOMER_SUSPENDED`	When the customer is temporarily suspended on the Pine Labs Online platform through the portal.
`CUSTOMER_CREATION_FAILED`	When the customer creation is failed.
`ORDER_AUTHORIZED`	When the order is ready for authorization.
`ORDER_PROCESSED`	When the payment is successfully received.
`ORDER_CANCELLED`	When the order is cancelled.
`PAYMENT_FAILED`	When the payment against an order get failed.
`ORDER_FAILED`	When the order is failed.
`REFUND_PROCESSED`	When the refund is successful.
`REFUND_FAILED`	When the refund against an order get failed.
`TOKEN_ACTIVATED`	When the token is activated via the network.
`TOKEN_DEACTIVATED`	When the token is deactivated.
`TOKEN_SUSPENDED`	When the token is suspended.
`TOKEN_PROVISION_FAILED`	When the token provisioning is failed.
`SUBSCRIPTION_ACTIVATED`	When the subscription is activated.
`SUBSCRIPTION_PENDING`	When the subscription is pending.
`SUBSCRIPTION_PAUSED`	When the subscription is paused.
`SUBSCRIPTION_RESUMED`	When the subscription is resumed.
`SUBSCRIPTION_COMPLETED`	When the subscription is completed.
`SUBSCRIPTION_CHARGED`	When the successful charge is made on the subscription.
`SUBSCRIPTION_HALTED`	When all retries have been exhausted and the subscription moves from the `PENDING` state to the `Halted` state.
`SUBSCRIPTION_CANCELLED`	When the subscription is successfully cancelled.
`SUBSCRIPTION_REVOKE_FAILED`	When the attempt to revoke the subscription fails.
`SUBSCRIPTION_UPDATED`	When the subscription is successfully updated.
`SUBSCRIPTION_UPDATE_FAILED`	When the attempt to update the subscription fails.
`payout-transaction-failed`	When the payout gets failed for any reasons.
`payout-transaction-success`	When the payout is successfully processed.
`ORDER_SETTLED`	For Cross Border import payments, Triggered when an order is successfully settled.
`ORDER_SETTLEMENT_REJECTED`	For Cross Border import payments, Triggered when an order is successfully settled.

Sample Payload

CUSTOMER_ACTIVATED

Triggered when the customer is activated at Pine Labs Online end. Shown below is the sample payload returned for customer activation scenario.

JSON

{
  "event_type": "CUSTOMER_ACTIVATED",
  "data": {
    "customer": {
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "merchant_customer_reference": "12345ABC",
      "first_name": "Kevin",
      "last_name": "Bob",
      "country_code": "91",
      "mobile_number": "9876543210",
      "email_id": "kevin.bob@example.com",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "gstin": "27ABCDE1234F2Z5",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "status": "ACTIVE",
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

CUSTOMER_DELETED

Triggered when the customer is deleted at the Pine Labs Online end. Shown below is the sample payload returned for Customer Deleted event.

JSON

{
  "event_type": "CUSTOMER_DELETED",
  "data": {
    "customer": {
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "merchant_customer_reference": "12345ABC",
      "first_name": "Kevin",
      "last_name": "Bob",
      "country_code": "91",
      "mobile_number": "9876543210",
      "email_id": "kevin.bob@example.com",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "gstin": "27ABCDE1234F2Z5",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "status": "DELETED",
      "status_reason": "customer deleted via Pine Labs Online customer dashboard",
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

CUSTOMER_SUSPENDED

Triggered when the customer is temporarily suspended at Pine Labs Online end via the portal. Shown below is the sample payload returned for Customer Suspended event.

JSON

{
  "event_type": "CUSTOMER_SUSPENDED",
  "data": {
    "customer": {
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "merchant_customer_reference": "12345ABC",
      "first_name": "Kevin",
      "last_name": "Bob",
      "country_code": "91",
      "mobile_number": "9876543210",
      "email_id": "kevin.bob@example.com",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "gstin": "27ABCDE1234F2Z5",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "status": "SUSPENDED",
      "status_reason": "customer suspended",
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

CUSTOMER_CREATION_FAILED

Triggered when customer creation fails. Shown below is the sample payload returned for Customer Creation Failure scenarios.

JSON

{
  "event_type": "CUSTOMER_CREATION_FAILED",
  "data": {
    "customer": {
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "merchant_customer_reference": "12345ABC",
      "first_name": "Kevin",
      "last_name": "Bob",
      "country_code": "91",
      "mobile_number": "9876543210",
      "email_id": "kevin.bob@example.com",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London"
      },
      "gstin": "27ABCDE1234F2Z5",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "status": "FAILED",
      "status_reason": "invalid_data",
      "failure_reason": {
        "code": "INVALID_REQUEST",
        "message": "Request is not well-formed, syntactically incorrect, or violates schema",
        "additional_error_details": {
          "source": "internal",
          "step": "creation",
          "reason": "invalid_data",
          "metadata": {}
        }
      },
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

ORDER_AUTHORIZED

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

JSON

{
  "event_type": "ORDER_AUTHORIZED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "AUTHORIZED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": true,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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",
          "is_aggregator": true
        },
        "created_at": "2024-08-28T18:12:32.152Z",
        "updated_at": "2024-08-28T18:13:08.418Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152Z",
    "updated_at": "2024-08-28T18:13:08.418Z",
    "integration_mode": "SEAMLESS"
  }
}

ORDER_PROCESSED

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

JSON

{
  "event_type": "ORDER_PROCESSED",
  "data": {
    "order_id": "v1-240909084141-aa-O2oJwd",
    "merchant_order_reference": "a51688bd-34bb-4714-b40d-5fbbf381ba87",
    "type": "CHARGE",
    "status": "PROCESSED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 200,
      "currency": "INR"
    },
    "pre_auth": true,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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",
          "is_aggregator": true
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 200,
              "currency": "INR"
            },
            "created_at": "2024-09-09T08:50:41.082Z"
          }
        ],
        "created_at": "2024-08-28T18:12:32.152Z",
        "updated_at": "2024-08-28T18:13:08.418Z"
      }
    ],
    "created_at": "2024-09-09T08:41:41.026Z",
    "updated_at": "2024-09-09T08:50:41.082Z",
    "integration_mode": "SEAMLESS"
  }
}

ORDER_CANCELLED

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

JSON

{
  "event_type": "ORDER_CANCELLED",
  "data": {
    "order_id": "v1-240828181232-aa-7cGcgo",
    "merchant_order_reference": "8e9b80ea-49c3-4d3e-860b-057890d2fd73",
    "type": "CHARGE",
    "status": "CANCELLED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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",
          "is_aggregator": true
        },
        "created_at": "2024-08-28T18:12:32.152Z",
        "updated_at": "2024-08-28T18:14:18.965Z"
      }
    ],
    "created_at": "2024-08-28T18:12:32.152Z",
    "updated_at": "2024-08-28T18:14:18.965Z",
    "integration_mode": "SEAMLESS"
  }
}

PAYMENT_FAILED

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

JSON

{
  "event_type": "PAYMENT_FAILED",
  "data": {
    "order_id": "v1-240828180835-aa-IKvddb",
    "merchant_order_reference": "4de00e1f-4855-4454-bf50-c0f7dd680e27",
    "type": "CHARGE",
    "status": "ATTEMPTED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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": "",
          "is_aggregator": true
        },
        "error_detail": {
          "code": "USER_AUTHENTICATION_FAILED",
          "message": "Consumer Authentication failed"
        },
        "created_at": "2024-08-28T18:08:35.651Z",
        "updated_at": "2024-08-28T18:10:15.584Z"
      }
    ],
    "created_at": "2024-08-28T18:08:35.651Z",
    "updated_at": "2024-08-28T18:10:15.584Z",
    "integration_mode": "SEAMLESS"
  }
}

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

ORDER_FAILED

Triggered when order is in FAILED state and respective payments are FAILED or CANCELLED. Shown below are the sample payloads returned against ORDER_FAILED event.

JSON

{
  "event_type": "ORDER_FAILED",
  "data": {
    "order_id": "v1-240828180835-aa-IKvddb",
    "merchant_order_reference": "4de00e1f-4855-4454-bf50-c0f7dd680e27",
    "type": "CHARGE",
    "status": "FAILED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": true,
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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": "",
          "rrn": "",
          "is_aggregator": true
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 100,
              "currency": "INR"
            },
            "created_at": "2024-08-28T18:10:15.584Z"
          }
        ],
        "error_detail": {
          "code": "PAYMENT_DECLINED",
          "message": "Transaction declined by Acquirer due to unknown reason"
        },
        "created_at": "2024-08-28T18:08:35.651Z",
        "updated_at": "2024-08-28T18:10:15.584Z"
      }
    ],
    "created_at": "2024-08-28T18:08:35.651Z",
    "updated_at": "2024-08-28T18:10:15.584Z",
    "integration_mode": "SEAMLESS"
  }
}

REFUND_PROCESSED

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

JSON

{
  "event_type": "REFUND_PROCESSED",
  "data": {
    "order_id": "v1-240828181713-aa-hNlYwt",
    "parent_order_id": "v1-241010055924-aa-AHbN0s",
    "merchant_order_reference": "18c693c4-27ce-444d-a040-9dc3dcc06213",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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-240828181713-aa-hNlYwt-cc-K",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7248690362736367903954",
          "rrn": "",
          "is_aggregator": true
        },
        "created_at": "2024-08-28T18:17:13.147Z",
        "updated_at": "2024-08-28T18:17:17.157Z"
      }
    ],
    "created_at": "2024-08-28T18:17:13.147Z",
    "updated_at": "2024-08-28T18:17:17.157Z",
    "integration_mode": "SEAMLESS"
  }
}

REFUND_FAILED

Triggered when the refund against an order get failed. Shown below is a sample payload returned against REFUND_FAILED event.

JSON

{
  "event_type": "REFUND_FAILED",
  "data": {
    "order_id": "v1-240924042246-aa-5oxVVr",
    "parent_order_id": "v1-240924042153-aa-mROLIp",
    "merchant_order_reference": "e5e32cb6-e5a6-4c37-9bbd-cb3552965088",
    "type": "REFUND",
    "status": "FAILED",
    "merchant_id": "109500",
    "order_amount": {
      "value": 199,
      "currency": "INR"
    },
    "pre_auth": "false",    
    "notes": "order1",
    "purchase_details": {},
    "payments": [
      {
        "id": "v1-240924042246-aa-5oxVVr-cc-N",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "status": "FAILED",
        "payment_amount": {
          "value": 199,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7271517532766944103954",
          "rrn": "",
          "is_aggregator": true
        },
        "created_at": "2024-09-24T04:22:46.880734Z",
        "updated_at": "2024-09-24T04:24:04.901502Z"
      }
    ],
    "created_at": "2024-09-24T04:22:46.880778Z",
    "updated_at": "2024-09-24T04:24:04.901573Z",
    "integration_mode": "SEAMLESS"
  }
}

TOKEN_ACTIVATED

Triggered when the token is activated via the network. Shown below is the sample payload returned against token activation method.

JSON

{
  "event_type": "TOKEN_ACTIVATED",
  "data": {
    "token": {
      "merchant_payment_reference": "payment-v1-0811030624",
      "token_id": "token-v1-0811030624-aa-RBDgpR",
      "merchant_token_reference": "",
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "status": "ACTIVE",
      "payment_method": "CARD",
      "expired_at": "2024-10-04T13:11:29.645591Z",
      "status_reason": null,
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "card_data": {
        "last4_digit": "2363",
        "card_type": "CREDIT",
        "network_name": "VISA",
        "issuer_name": "HDFC",
        "card_category": "Consumer",
        "country_code": "IND",
        "international": false,
        "emi": true,
        "cvv_required": false
      },
      "is_compliant": true,
      "created_at": "2024-10-04T13:11:29.645657Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

TOKEN_DEACTIVATED

Triggered when the token is Deactivated. Shown below is the sample payload returned for token deactivation scenario.

JSON

{
  "event_type": "TOKEN_DEACTIVATED",
  "data": {
    "token": {
      "merchant_payment_reference": "payment-v1-0811030624",
      "token_id": "token-v1-0811030624-aa-RBDgpR",
      "merchant_token_reference": "",
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "status": "DEACTIVATED",
      "payment_method": "CARD",
      "expired_at": "2024-10-04T13:11:29.645591Z",
      "status_reason": "card stolen",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "card_data": {
        "last4_digit": "2363",
        "card_type": "CREDIT",
        "network_name": "VISA",
        "issuer_name": "HDFC",
        "card_category": "Consumer",
        "country_code": "IND",
        "international": false,
        "emi": true,
        "cvv_required": false
      },
      "is_compliant": true,
      "created_at": "2024-10-04T13:11:29.645657Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

TOKEN_SUSPENDED

Triggered when the token is Suspended. Shown below is the sample payload returned against token service providers.

JSON

{
  "event_type": "TOKEN_SUSPENDED",
  "data": {
    "token": {
      "merchant_payment_reference": "payment-v1-0811030624",
      "token_id": "token-v1-0811030624-aa-RBDgpR",
      "merchant_token_reference": "",
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "status": "SUSPENDED",
      "payment_method": "CARD",
      "expired_at": "2024-10-04T13:11:29.645591Z",
      "status_reason": "card stolen",
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "card_data": {
        "last4_digit": "2363",
        "card_type": "CREDIT",
        "network_name": "VISA",
        "issuer_name": "HDFC",
        "card_category": "Consumer",
        "country_code": "IND",
        "international": false,
        "emi": true,
        "cvv_required": false
      },
      "is_compliant": true,
      "created_at": "2024-10-04T13:11:29.645657Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

TOKEN_PROVISION_FAILED

Triggered when token provisioning fails. Shown below is the sample payload returned when token provisioning failed.

JSON

{
  "event_type": "TOKEN_PROVISION_FAILED",
  "data": {
    "token": {
      "merchant_payment_reference": "payment-v1-0811030624",
      "token_id": "token-v1-0811030624-aa-RBDgpR",
      "merchant_token_reference": "",
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "status": "FAILED",
      "payment_method": "CARD",
      "expired_at": "2024-10-04T13:11:29.645591Z",
      "status_reason": "card is not elegible for tokenisation",
      "failure_reason": {
        "code": "INVALID_REQUEST",
        "message": "Request is not well-formed, syntactically incorrect, or violates schema",
        "additional_error_details": {
          "source": "network",
          "step": "token_provision",
          "reason": "card is not elegible for tokenisation",
          "metadata": {}
        }
      },
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "card_data": {
        "last4_digit": "2363",
        "card_type": "CREDIT",
        "network_name": "VISA",
        "issuer_name": "HDFC",
        "card_category": "Consumer",
        "country_code": "IND",
        "international": false,
        "emi": true,
        "cvv_required": false
      },
      "is_compliant": true,
      "created_at": "2024-10-04T13:11:29.645657Z",
      "updated_at": "2024-10-04T13:11:29.645657Z"
    }
  }
}

SUBSCRIPTION_ACTIVATED

Triggered when the subscription is activated. Shown below is the sample payload returned when subscription is activated.

JSON

{
  "event_type": "SUBSCRIPTION_ACTIVATED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "ACTIVE",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_PENDING

Triggered when the subscription is pending. Shown below is the sample payload returned for subscription pending scenario.

JSON

{
  "event_type": "SUBSCRIPTION_PENDING",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "CREATED",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_PAUSED

Triggered when the subscription is paused. Shown below is the sample payload returned for subscription paused scenario.

JSON

{
  "event_type": "SUBSCRIPTION_PAUSED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "PAUSED",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_RESUMED

Triggered when the subscription is resumed. Shown below is the sample payload returned for subscription resumed scenario.

JSON

{
  "event_type": "SUBSCRIPTION_RESUMED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "RESUMED",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_COMPLETED

Triggered when the subscription is completed. Shown below is the sample payload returned for subscription completed scenario.

JSON

{
  "event_type": "SUBSCRIPTION_COMPLETED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "COMPLETED",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_CHARGED

Triggered when the subscription is charged. Shown below is the sample payload returned for subscription charged scenario.

JSON

{
  "event_type": "SUBSCRIPTION_CHARGED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "ACTIVE",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_HALTED

Triggered when the subscription is halted. Shown below is the sample payload returned for subscription halted scenario.

JSON

{
  "event_type": "SUBSCRIPTION_HALTED",
  "event_id": "v1-event-002",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "16be0ed6-6e26-4598-b1c0-7470e8d2d065",
      "order_id": "v1-250612055134-aa-4tvxe4",
      "payment_id": "v1-250612055134-aa-4tvxe4-up-a",
      "subscription_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 436364,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_plan_reference": "1234567890",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 50,
          "currency": "INR"
        },
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "INACTIVE",
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "123456789012345"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  }
}

SUBSCRIPTION_CANCELLED

Triggered when the subscription is cancelled. Shown below is the sample payload returned for subscription cancelled scenario.

JSON

{
  "event_type": "SUBSCRIPTION_CANCELLED",
  "event_id": "v1-event-101",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-101-aa-xyz123",
      "merchant_subscription_reference": "sub-cancel-ref-001",
      "order_id": "v1-250612055134-aa-cancel1",
      "payment_id": "v1-250612055134-aa-cancel1-up-a",
      "subscription_amount": {
        "value": 20000,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 20000,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 20000,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\", \"CARD\"]",
      "is_tpv_enabled": false,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-101-aa-xyz123",
        "plan_name": "Basic Plan",
        "plan_description": "Basic subscription plan",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 20000,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 20000,
          "currency": "INR"
        },
        "trial_period_in_days": 0,
        "start_date": "2025-01-01T00:00:00Z",
        "end_date": "2025-12-31T23:59:59Z",
        "merchant_plan_reference": "plan-basic-ref-001",
        "auto_debit_ot": false,
        "initial_debit_amount": {
          "value": 0,
          "currency": "INR"
        },
        "merchant_metadata": {
          "source": "web"
        },
        "created_at": "2025-01-01T00:00:00Z",
        "modified_at": "2025-06-01T00:00:00Z"
      },
      "quantity": 1,
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2025-12-31T23:59:59Z",
      "customer_id": "cust-001",
      "payment_mode": [
        "UPI",
        "CARD"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "campaign": "summer-sale"
      },
      "status": "CANCELLED",
      "bank_account": {
        "account_number": "1111222233334444",
        "name": "John Doe",
        "ifsc": "IFSC0001234"
      },
      "created_at": "2025-01-01T00:00:00Z",
      "modified_at": "2025-06-01T00:00:00Z"
    }
  }
}

SUBSCRIPTION_REVOKE_FAILED

Triggered when the subscription revoke fails. Shown below is the sample payload returned for subscription revoke failed scenario.

JSON

{
  "event_type": "SUBSCRIPTION_REVOKE_FAILED",
  "event_id": "v1-event-102",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-102-aa-xyz124",
      "merchant_subscription_reference": "sub-revoke-fail-ref-002",
      "order_id": "v1-250612055134-aa-revoke2",
      "payment_id": "v1-250612055134-aa-revoke2-up-a",
      "subscription_amount": {
        "value": 30000,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 30000,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 30000,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-102-aa-xyz124",
        "plan_name": "Premium Plan",
        "plan_description": "Premium subscription plan",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 30000,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 30000,
          "currency": "INR"
        },
        "trial_period_in_days": 7,
        "start_date": "2025-02-01T00:00:00Z",
        "end_date": "2025-11-30T23:59:59Z",
        "merchant_plan_reference": "plan-premium-ref-002",
        "auto_debit_ot": true,
        "initial_debit_amount": {
          "value": 5000,
          "currency": "INR"
        },
        "merchant_metadata": {
          "source": "mobile-app"
        },
        "created_at": "2025-02-01T00:00:00Z",
        "modified_at": "2025-06-01T00:00:00Z"
      },
      "quantity": 1,
      "start_date": "2025-02-01T00:00:00Z",
      "end_date": "2025-11-30T23:59:59Z",
      "customer_id": "cust-002",
      "payment_mode": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "campaign": "holiday-offer"
      },
      "status": "ACTIVE",
      "bank_account": {
        "account_number": "5555666677778888",
        "name": "Jane Smith",
        "ifsc": "IFSC0005678"
      },
      "created_at": "2025-02-01T00:00:00Z",
      "modified_at": "2025-06-01T00:00:00Z"
    }
  }
}

SUBSCRIPTION_UPDATED

Triggered when the subscription is updated. Shown below is the sample payload returned for subscription updated scenario.

JSON

{
  "event_type": "SUBSCRIPTION_UPDATED",
  "event_id": "v1-event-103",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-103-aa-xyz125",
      "merchant_subscription_reference": "sub-update-ref-003",
      "order_id": "v1-250612055134-aa-update3",
      "payment_id": "v1-250612055134-aa-update3-up-a",
      "subscription_amount": {
        "value": 25000,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 25000,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 25000,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"CARD\"]",
      "is_tpv_enabled": false,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-103-aa-xyz125",
        "plan_name": "Standard Plan",
        "plan_description": "Standard subscription plan",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 25000,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 25000,
          "currency": "INR"
        },
        "trial_period_in_days": 3,
        "start_date": "2025-03-01T00:00:00Z",
        "end_date": "2025-09-30T23:59:59Z",
        "merchant_plan_reference": "plan-standard-ref-003",
        "auto_debit_ot": false,
        "initial_debit_amount": {
          "value": 0,
          "currency": "INR"
        },
        "merchant_metadata": {
          "source": "api"
        },
        "created_at": "2025-03-01T00:00:00Z",
        "modified_at": "2025-06-01T00:00:00Z"
      },
      "quantity": 1,
      "start_date": "2025-03-01T00:00:00Z",
      "end_date": "2025-09-30T23:59:59Z",
      "customer_id": "cust-003",
      "payment_mode": [
        "CARD"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "campaign": "spring-promo"
      },
      "status": "ACTIVE",
      "bank_account": {
        "account_number": "9999000011112222",
        "name": "Alice Johnson",
        "ifsc": "IFSC0009999"
      },
      "created_at": "2025-03-01T00:00:00Z",
      "modified_at": "2025-06-01T00:00:00Z"
    }
  }
}

SUBSCRIPTION_UPDATE_FAILED

Triggered when the subscription update fails. Shown below is the sample payload returned for subscription update failed scenario.

JSON

{
  "event_type": "SUBSCRIPTION_UPDATE_FAILED",
  "event_id": "v1-event-104",
  "merchant_id": "2345",
  "data": {
    "subscription": {
      "subscription_id": "v1-sub-104-aa-xyz126",
      "merchant_subscription_reference": "sub-update-fail-ref-004",
      "order_id": "v1-250612055134-aa-updatefail4",
      "payment_id": "v1-250612055134-aa-updatefail4-up-a",
      "subscription_amount": {
        "value": 18000,
        "currency": "CURRENCY_INR"
      },
      "order_amount": {
        "value": 18000,
        "currency": "CURRENCY_INR"
      },
      "subscription_max_limit_amount": {
        "value": 18000,
        "currency": "CURRENCY_INR"
      },
      "allowed_payment_mode": "[\"UPI\", \"CARD\"]",
      "is_tpv_enabled": true,
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-104-aa-xyz126",
        "plan_name": "Economy Plan",
        "plan_description": "Economy subscription plan",
        "frequency_count": 1,
        "frequency": "Month",
        "amount": {
          "value": 18000,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 18000,
          "currency": "INR"
        },
        "trial_period_in_days": 0,
        "start_date": "2025-04-01T00:00:00Z",
        "end_date": "2025-10-31T23:59:59Z",
        "merchant_plan_reference": "plan-economy-ref-004",
        "auto_debit_ot": false,
        "initial_debit_amount": {
          "value": 0,
          "currency": "INR"
        },
        "merchant_metadata": {
          "source": "web"
        },
        "created_at": "2025-04-01T00:00:00Z",
        "modified_at": "2025-06-01T00:00:00Z"
      },
      "quantity": 1,
      "start_date": "2025-04-01T00:00:00Z",
      "end_date": "2025-10-31T23:59:59Z",
      "customer_id": "cust-004",
      "payment_mode": [
        "UPI",
        "CARD"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "campaign": "flash-sale"
      },
      "status": "ACTIVE",
      "bank_account": {
        "account_number": "4444555566667777",
        "name": "Bob Martin",
        "ifsc": "IFSC0004444"
      },
      "created_at": "2025-04-01T00:00:00Z",
      "modified_at": "2025-06-01T00:00:00Z"
    }
  }
}

Payout Transaction Failed

When the payout gets failed for any reasons.

JSON

{
  "eventId": "pytw-c560ba0822fd4502bbf5e38618b0cd58",
  "data": {
    "amount": {
      "currency": "INR",
      "value": 480
    },
    "fees": {
      "currency": "INR",
      "value": 0
    },
    "tax": {
      "currency": "INR",
      "value": 0
    },
    "clientReferenceId": "Payout_webhook_testing_02",
    "paymentReferenceId": "txn-10a144c183dd4fd5875f33ee076f8d80",
    "message": "Beneficiary Account blocked/frozen",
    "mode": "NEFT",
    "bankTransactionReferenceId": "UTR502ce08380",
    "createdAt": "2025-01-15T09:19:16Z",
    "remarks": "del",
    "scheduledAt": "",
    "status": "FAILED",
    "updatedAt": "2025-01-15T09:28:53Z"
  },
  "eventVersion": "1.0",
  "eventSource": "PAYOUT",
  "eventType": "payout-transaction-failed",
  "sentAt": "1736933335020",
  "eventTimeStamp": "2025-01-15T09:28:54Z"
}

Payout Transaction Success

When the payout is successfully processed.

JSON

{
  "eventId": "pytw-fc18909dee5e4430bb7d9914124e8d79",
  "data": {
    "amount": {
      "currency": "INR",
      "value": 480
    },
    "fees": {
      "currency": "INR",
      "value": 0
    },
    "tax": {
      "currency": "INR",
      "value": 0
    },
    "clientReferenceId": "Payout_webhook_testing_01",
    "paymentReferenceId": "txn-e28f0bcb241043c5959815f090e7971e",
    "message": "Payment instruction successfully executed with bank",
    "mode": "NEFT",
    "bankTransactionReferenceId": "UTR604ed3",
    "createdAt": "2025-01-15T09:04:49Z",
    "remarks": "del",
    "scheduledAt": "",
    "status": "SUCCESS",
    "updatedAt": "2025-01-15T09:15:12Z"
  },
  "eventVersion": "1.0",
  "eventSource": "PAYOUT",
  "eventType": "payout-transaction-success",
  "sentAt": "1736932513053",
  "eventTimeStamp": "2025-01-15T09:15:12Z"
}

ORDER_SETTLED

Triggered when the order is successfully settled for a Cross border import payments merchant. Shown below is the sample payload returned for a payment method.

JSON

{
  "event_type": "ORDER_SETTLED",
  "data": {
    "order_id": "v1-240909084141-aa-O2oJwd",
    "merchant_order_reference": "a51688bd-34bb-4714-b40d-5fbbf381ba87",
    "type": "CHARGE",
    "status": "SETTLED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 200,
      "currency": "INR"
    },
    "pre_auth": true,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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",
          "is_aggregator": true
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 200,
              "currency": "INR"
            },
            "created_at": "2024-09-09T08:50:41.082Z"
          }
        ],
        "created_at": "2024-08-28T18:12:32.152Z",
        "updated_at": "2024-08-28T18:13:08.418Z"
      }
    ],
    "created_at": "2024-09-09T08:41:41.026Z",
    "updated_at": "2024-09-09T08:50:41.082Z",
    "integration_mode": "SEAMLESS",
    "cross_border_details": {
      "flow_type": "NON_LRS",
      "purpose_code": "S1005",
      "commodity_type": "GOODS",
      "invoice_data": {
        "invoice_id": "In-260729075112-aa-HRk0c4-a",
        "invoice_number": "953c2651-e1ca-4d6b-a63b-73dd295cbd11-inv"
      }
    }
  }
}

ORDER_SETTLEMENT_REJECTED

Triggered when the order settlement is rejected for a Cross border import payments merchant merchant. Shown below is the sample payload returned for a payment method.

JSON

{
  "event_type": "ORDER_SETTLEMENT_REJECTED",
  "data": {
    "order_id": "v1-240909084141-aa-O2oJwd",
    "merchant_order_reference": "a51688bd-34bb-4714-b40d-5fbbf381ba87",
    "type": "CHARGE",
    "status": "SETTLEMENT_REJECTED",
    "callback_url": "https://sample-callback-url",
    "failure_callback_url": "https://failure.callback.com",
    "merchant_id": "109500",
    "order_amount": {
      "value": 200,
      "currency": "INR"
    },
    "pre_auth": true,    
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "kevin.bob@example.com",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "country_code": "91",
        "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",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "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",
          "is_aggregator": true
        },
        "capture_data": [
          {
            "merchant_capture_reference": "2a2ef9cd-6edd-4df0-8c26-d2e81249ac4d",
            "capture_amount": {
              "value": 200,
              "currency": "INR"
            },
            "created_at": "2024-09-09T08:50:41.082Z"
          }
        ],
        "created_at": "2024-08-28T18:12:32.152Z",
        "updated_at": "2024-08-28T18:13:08.418Z"
      }
    ],
    "created_at": "2024-09-09T08:41:41.026Z",
    "updated_at": "2024-09-09T08:50:41.082Z",
    "integration_mode": "SEAMLESS",
    "cross_border_details": {
      "flow_type": "NON_LRS",
      "purpose_code": "S1005",
      "commodity_type": "GOODS",
      "invoice_data": {
        "invoice_id": "In-260729075112-aa-HRk0c4-a",
        "invoice_number": "953c2651-e1ca-4d6b-a63b-73dd295cbd11-inv"
      }
    }
  }
}