Skip to main content

Payment Webhooks

This page covers every webhook event tied to the payment lifecycle — successful and failed payments, authorization/reversal, and pre-auth capture and void. For refund events, see Refund Webhooks. For payment link events, see Payment Link Webhooks.

Each event below shows its v3 and v4 payload. v3 sends the full payload as-is; v4 encodes and signs the same payload before sending it — open Decoded payload in the v4 tab to see what's inside it. The v4 signature field is named signature, not nimbbl_signature (the name used on the payment and checkout callbacks). See Webhook Payloads for how retries, idempotency, and payload versions work, and Validating Payment Response with Signature for signature validation logic.

Migration From v3 to v4

Moving a sub-merchant to v4? See Migrating Webhooks from v3 to v4 for what changes and how to roll it out safely.

Payment Lifecycle Events​

Payment Success Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
	"event_type": "payment_success",
	"status": "success",
	"message": "Payment Successful",
	"nimbbl_order_id": "<Order_ID>",
	"nimbbl_transaction_id": "<Transaction_ID>",
	"transaction": {
		"transaction_id": "<Transaction_ID>",
		"payment_partner": "<Payment Partner>",
		"status": "succeeded",
		"payment_mode": <Payment Mode>,
		"psp_credential_label": <Cred Label>,
		"retry_allowed": null,
		"processing_payment_partner": "<Payment Partner>",
		"payment_acquirer": null,
		"payment_arn": "<Payment ARN>",
		"subvention_id": null,
		"sub_payment_mode": {
			"bank_name": "<Bank Name>",
			"wallet_name": "<Wallet Name>",
			"upi_id": "Vpa Id",
			"upi_holder": "Vpa Holder",
			"upi_app_name": "Vpa App Name",
			"upi_instrument": "Upi Instrument",
			"upi_flow": "<Intent, Collect, QR>",
			"card_input_type": "<Card Input Type>",
			"issuer": "<Issuer>",
			"card_type": "<Card Type>",
			"scheme": "<Card Network>",
			"masked_card": "<Masked Card>",
			"expiry": "<Card Expiry>",
			"card_holder": "<Card Holder Name>",
			"network_token": "<Network Token>",
			"nimbbl_token_id": "<Nimbbl Token Id>",
			"emi": {
				"issuer_code": "<Issuer Code>",
				"card_network_code": "<Card Network Code>",
				"card_input_type": "<Card Input Type>",
				"masked_card": "<Masked Card>",
				"card_holder": "<Card Holder Name>",
				"subvention_type": "<Subvention Type>",
				"installment_amount": "<Formatted Installment Amount>",
				"interest_discount": "<Formatted Interest Discount>",
				"cashback_amount": "<Formatted Cashback Amount>",
				"tenure": "<EMI Tenure>",
				"frequency": "<EMI Frequency>",
				"processing_fee_data": {
					"fee": "<Formatted Processing Fee>",
					"gst_exclusive": "<GST Exclusive>"
				},
				"interest_amount": "<Formatted Interest Amount>",
				"interest_rate": "<Formatted Interest Rate>",
				"subvented_interest_rate": "<Formatted Subvented Interest Rate>",
				"network_token" : "<Network Token>",
				"nimbbl_token_id" : "<Nimbbl Token Id>",
			}
		},
		"psp_transaction_id": "<Pay_ID>",
		"nimbbl_consumer_message": "",
		"nimbbl_merchant_message": "",
		"nimbbl_error_code": "",
		"transaction_currency": "<ISO_4217 Alpha-3 format currency>",
		"transaction_amount": <Transaction amount with upto 2 decimal>,
		"additional_charges": <Convenience Fee>,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"offer_discount": <Offer discount>,
		"offer_id": "<Offer id from Nimbbl system>",
		"transaction_type": "payment"
	},
	"order": {
		"order_id" : <Order_ID>,
		"order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
		"amount_before_tax": <Amount before tax>,
		"tax": <Tax amount>,
		"total_amount": <Total Amount>,
		"referrer_platform": "<Integration Platform used>",
		"referrer_platform_version": "<Integration Platform version>",
		"invoice_id": "<Merchant invoice id>",
		"shopfront_domain": "<Shopfront domain>",
		"attempts": <#Transactions for the order>,
		"device_user_agent": "<User Agent>",
		"status": "completed",
		"currency": "<ISO_4217 Alpha-3 format currency>",
		"description": "",
		"cancellation_reason": "",
		"additional_charges": 0.0,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"shipping_address": {
			"first_name": "john",
			"last_name": "doe",
			"address_id": "address_81x7BgApPVVQ6v5N",
			"address_1": "1080 Beach Mansion",
			"street": "Magic Beach Drive",
			"landmark": "Opposite Magic Mountain",
			"area": "Elyria",
			"city": "Atlantis",
			"state": "Castalia",
			"pincode": "400069",
			"address_type": "Office",
			"label": "01",
			"source": "user"
		},
		"billing_address": {
			"first_name": "john",
			"last_name": "doe",
			"address_id": "address_81x7BgApPVVQ6v5N",
			"address_1": "1080 Beach Mansion",
			"street": "Magic Beach Drive",
			"landmark": "Opposite Magic Mountain",
			"area": "Elyria",
			"city": "Atlantis",
			"state": "Castalia",
			"pincode": "400069",
			"address_type": "Office",
			"label": "01",
			"source": "user"
		},
		"grand_total": <total_amount - offer_discount + additional_charges>,
		"offer_discount": 0,
		"refund_details": {
			"refundable_currency": "INR",
			"available_refundable_amount": 5.0,
			"refunded_amount": 0.0,
			"total_refundable_amount": 5.0
		},
		"currency_conversion": {
			"original_currency": "USD",
			"converted_currency": "INR",
			"exchange_rate": 100.0,
			"conversion_reason": "ALTERNATE_CURRENCY_CONFIG",
			"original_amount_before_tax": 8.0,
			"original_tax": 2.0,
			"original_total_amount": 10.0
		},
		"custom_attributes": [{
				"key_1": "val_1"
			},
			{
				"key_2": "val_2"
			}
		],
		"device": {
			"browser_name": "Chrome",
			"device_name": "Other",
			"os_name": "Windows",
			"ip_address": "127.0.0.1"
		}
	},
	"user": {
		"email": "[email protected]",
		"mobile": "9121212121",
		"name": "Shakthiman",
		"user_id": "<user_ID>"
	},
	"payment_link_info": {
		"merchant_invoice_id": "<Merchant invoice id>"
	},
	"psp_raw_response": null,
	"is_webhook": true,
	"merchant_invoice_id": "<Merchant invoice id>"
}

Payment Failed Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
	"event_type": "payment_failed",
	"status": "failed",
	"message": "Sorry, your payment could not be processed. Please try again or another payment option.",
	"nimbbl_order_id": "<Order_ID>",
	"nimbbl_transaction_id": "<Transaction_ID>",
	"transaction": {
		"transaction_id": "<Transaction_ID>",
		"payment_partner": "<Payment Partner>",
		"status": "failed",
		"payment_mode": <Payment Mode>,
		"psp_credential_label": <Cred Label>,
		"retry_allowed": true,
		"processing_payment_partner": "<Payment Partner>",
		"payment_acquirer": null,
		"payment_arn": null,
		"subvention_id": null,
		"sub_payment_mode": {},
		"psp_transaction_id": "<Pay_ID>",
		"nimbbl_consumer_message": "<Nimbbl Consumer Message>",
		"nimbbl_merchant_message": "<Nimbbl Merchant Message>",
		"nimbbl_error_code": "<Nimbbl Error Code>",
		"transaction_currency": "<ISO_4217 Alpha-3 format currency>",
		"transaction_amount": <Transaction amount with upto 2 decimal>,
		"additional_charges": <Convenience Fee>,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"offer_discount": <Offer discount>,
		"offer_id": "<Offer id from Nimbbl system>",
		"transaction_type": "payment"
	},
	"order": {
		"order_id" : <Order_ID>,
		"order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
		"amount_before_tax": <Amount before tax>,
		"tax": <Tax amount>,
		"total_amount": <Total Amount>,
		"invoice_id": "<Merchant invoice id>",
		"status": "failed",
		"currency": "<ISO_4217 Alpha-3 format currency>",
		"grand_total": <total_amount - offer_discount + additional_charges>,
		"custom_attributes": [],
		"device": {
			"browser_name": "Chrome",
			"device_name": "Other",
			"os_name": "Windows",
			"ip_address": "127.0.0.1"
		}
	},
	"user": {
		"email": "[email protected]",
		"mobile": "9121212121",
		"name": "Shakthiman",
		"user_id": "<user_ID>"
	},
	"psp_raw_response": null,
	"is_webhook": true,
	"merchant_invoice_id": "<Merchant invoice id>"
}

Payment Authorized Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "payment_authorized",
  "status": "authorized",
  "message": "Payment Authorized",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Transaction_ID>",
  "transaction": {
    "transaction_id": "<Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "authorized",
    "payment_mode": "<Payment Mode>",
    "psp_credential_label": "<Cred Label>",
    "sub_payment_mode": {},
    "psp_transaction_id": "<PSP_Transaction_ID>",
    "nimbbl_consumer_message": "",
    "nimbbl_merchant_message": "",
    "nimbbl_error_code": "",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Authorized amount>",
    "transaction_type": "payment",
    "authorization_details": {
      "mechanism": "pre_auth",
      "capture_mode": "manual",
      "authorized_time": "2025-06-15T10:30:00Z",
      "expiry_time": "2025-06-20T10:30:00Z",
      "captured_amount": 0.0,
      "voided_amount": 0.0,
      "available_authorized_amount": 1000.0
    },
    "retry_allowed": false
  },
  "order": {
    "order_id": "<Order_ID>",
    "order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
    "amount_before_tax": "<Amount before tax>",
    "tax": "<Tax amount>",
    "total_amount": "<Total Amount>",
    "status": "lapsed",
    "lapsed_reason": "payment_authorized",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "description": "",
    "cancellation_reason": "",
    "additional_charges": 0.0,
    "shipping_charges": 0.0,
    "cod_charges": 0.0,
    "grand_total": "<Grand Total>",
    "offer_discount": 0,
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}
Authorization Details

The authorization_details object is present only on the authorized payment transaction.

Payment Reversing Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
	"event_type": "payment_reversing",
	"status": "reversing",
	"message": "Payment in Reversing",
	"nimbbl_order_id": "<Order_ID>",
	"nimbbl_transaction_id": "<Transaction_ID>",
	"transaction": {
		"transaction_id": "<Transaction_ID>",
		"payment_partner": "<Payment Partner>",
		"status": "reversing",
		"payment_mode": <Payment Mode>,
		"psp_credential_label": <Cred Label>,
		"retry_allowed": null,
		"processing_payment_partner": "<Payment Partner>",
		"payment_acquirer": null,
		"payment_arn": "<Payment ARN>",
		"subvention_id": null,
		"sub_payment_mode": {},
		"psp_transaction_id": "<Pay_ID>",
		"nimbbl_consumer_message": "",
		"nimbbl_merchant_message": "",
		"nimbbl_error_code": "",
		"transaction_currency": "<ISO_4217 Alpha-3 format currency>",
		"transaction_amount": <Transaction amount with upto 2 decimal>,
		"additional_charges": <Convenience Fee>,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"offer_discount": <Offer discount>,
		"offer_id": "<Offer id from Nimbbl system>",
		"transaction_type": "payment"
	},
	"order": {
		"order_id" : <Order_ID>,
		"order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
		"amount_before_tax": <Amount before tax>,
		"tax": <Tax amount>,
		"total_amount": <Total Amount>,
		"status": "completed",
		"currency": "<ISO_4217 Alpha-3 format currency>",
		"grand_total": <total_amount - offer_discount + additional_charges>,
		"refund_details": {
			"refundable_currency": "INR",
			"available_refundable_amount": 5.0,
			"refunded_amount": 0.0,
			"total_refundable_amount": 5.0
		},
		"custom_attributes": [],
		"device": {
			"browser_name": "Chrome",
			"device_name": "Other",
			"os_name": "Windows",
			"ip_address": "127.0.0.1"
		}
	},
	"user": {
		"email": "[email protected]",
		"mobile": "9121212121",
		"name": "Shakthiman",
		"user_id": "<user_ID>"
	},
	"psp_raw_response": null,
	"is_webhook": true,
	"merchant_invoice_id": "<Merchant invoice id>"
}

Payment Reversal Failed Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
	"event_type": "payment_reversal_failed",
	"status": "reversal_failed",
	"message": "Payment Reversal Failed",
	"nimbbl_order_id": "<Order_ID>",
	"nimbbl_transaction_id": "<Transaction_ID>",
	"transaction": {
		"transaction_id": "<Transaction_ID>",
		"payment_partner": "<Payment Partner>",
		"status": "reversal_failed",
		"payment_mode": <Payment Mode>,
		"psp_credential_label": <Cred Label>,
		"retry_allowed": null,
		"processing_payment_partner": "<Payment Partner>",
		"payment_acquirer": null,
		"payment_arn": "<Payment ARN>",
		"subvention_id": null,
		"sub_payment_mode": {},
		"psp_transaction_id": "<Pay_ID>",
		"nimbbl_consumer_message": "",
		"nimbbl_merchant_message": "",
		"nimbbl_error_code": "",
		"transaction_currency": "<ISO_4217 Alpha-3 format currency>",
		"transaction_amount": <Transaction amount with upto 2 decimal>,
		"additional_charges": <Convenience Fee>,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"offer_discount": <Offer discount>,
		"offer_id": "<Offer id from Nimbbl system>",
		"transaction_type": "payment"
	},
	"order": {
		"order_id" : <Order_ID>,
		"order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
		"amount_before_tax": <Amount before tax>,
		"tax": <Tax amount>,
		"total_amount": <Total Amount>,
		"status": "completed",
		"currency": "<ISO_4217 Alpha-3 format currency>",
		"grand_total": <total_amount - offer_discount + additional_charges>,
		"refund_details": {
			"refundable_currency": "INR",
			"available_refundable_amount": 5.0,
			"refunded_amount": 0.0,
			"total_refundable_amount": 5.0
		},
		"custom_attributes": [],
		"device": {
			"browser_name": "Chrome",
			"device_name": "Other",
			"os_name": "Windows",
			"ip_address": "127.0.0.1"
		}
	},
	"user": {
		"email": "[email protected]",
		"mobile": "9121212121",
		"name": "Shakthiman",
		"user_id": "<user_ID>"
	},
	"psp_raw_response": null,
	"is_webhook": true,
	"merchant_invoice_id": "<Merchant invoice id>"
}

Payment Reversed Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
	"event_type": "payment_reversed",
	"status": "reversed",
	"message": "Payment Reversed",
	"nimbbl_order_id": "<Order_ID>",
	"nimbbl_transaction_id": "<Transaction_ID>",
	"transaction": {
		"transaction_id": "<Transaction_ID>",
		"payment_partner": "<Payment Partner>",
		"status": "reversed",
		"payment_mode": <Payment Mode>,
		"psp_credential_label": <Cred Label>,
		"retry_allowed": null,
		"processing_payment_partner": "<Payment Partner>",
		"payment_acquirer": null,
		"payment_arn": "<Payment ARN>",
		"subvention_id": null,
		"sub_payment_mode": {},
		"psp_transaction_id": "<Pay_ID>",
		"nimbbl_consumer_message": "",
		"nimbbl_merchant_message": "",
		"nimbbl_error_code": "",
		"transaction_currency": "<ISO_4217 Alpha-3 format currency>",
		"transaction_amount": <Transaction amount with upto 2 decimal>,
		"additional_charges": <Convenience Fee>,
		"shipping_charges": 0.0,
		"cod_charges": 0.0,
		"offer_discount": <Offer discount>,
		"offer_id": "<Offer id from Nimbbl system>",
		"transaction_type": "payment"
	},
	"order": {
		"order_id" : <Order_ID>,
		"order_date": "<Date in yyyy-mm-dd hh:mm:ss format>",
		"amount_before_tax": <Amount before tax>,
		"tax": <Tax amount>,
		"total_amount": <Total Amount>,
		"status": "completed",
		"currency": "<ISO_4217 Alpha-3 format currency>",
		"grand_total": <total_amount - offer_discount + additional_charges>,
		"refund_details": {
			"refundable_currency": "INR",
			"available_refundable_amount": 0.0,
			"refunded_amount": 5.0,
			"total_refundable_amount": 5.0
		},
		"custom_attributes": [],
		"device": {
			"browser_name": "Chrome",
			"device_name": "Other",
			"os_name": "Windows",
			"ip_address": "127.0.0.1"
		}
	},
	"user": {
		"email": "[email protected]",
		"mobile": "9121212121",
		"name": "Shakthiman",
		"user_id": "<user_ID>"
	},
	"psp_raw_response": null,
	"is_webhook": true,
	"merchant_invoice_id": "<Merchant invoice id>"
}

Capture Events​

Capture Success Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "capture_success",
  "status": "success",
  "message": "Capture Successful",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Capture_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Capture_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "succeeded",
    "payment_mode": "<Payment Mode>",
    "psp_credential_label": "<Cred Label>",
    "sub_payment_mode": {},
    "psp_transaction_id": "<PSP_Transaction_ID>",
    "nimbbl_consumer_message": "",
    "nimbbl_merchant_message": "",
    "nimbbl_error_code": "",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Captured amount>",
    "transaction_type": "capture",
    "capture_type": "full",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>"
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "completed",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "additional_charges": 0.0,
    "shipping_charges": 0.0,
    "cod_charges": 0.0,
    "grand_total": "<Grand Total>",
    "offer_discount": 0,
    "refund_details": {
      "refundable_currency": "INR",
      "available_refundable_amount": 1000.0,
      "refunded_amount": 0.0,
      "total_refundable_amount": 1000.0
    },
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}

Capture Pending Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "capture_pending",
  "status": "pending",
  "message": "Capture Pending",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Capture_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Capture_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "pending",
    "payment_mode": "<Payment Mode>",
    "psp_credential_label": "<Cred Label>",
    "sub_payment_mode": {},
    "psp_transaction_id": "<PSP_Transaction_ID>",
    "nimbbl_consumer_message": "",
    "nimbbl_merchant_message": "",
    "nimbbl_error_code": "",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Capture amount>",
    "transaction_type": "capture",
    "capture_type": "full",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>"
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "pending",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "additional_charges": 0.0,
    "shipping_charges": 0.0,
    "cod_charges": 0.0,
    "grand_total": "<Grand Total>",
    "offer_discount": 0,
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}

Capture Failed Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "capture_failed",
  "status": "failed",
  "message": "Capture Failed",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Capture_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Capture_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "failed",
    "payment_mode": "<Payment Mode>",
    "psp_credential_label": "<Cred Label>",
    "sub_payment_mode": {},
    "psp_transaction_id": "<PSP_Transaction_ID>",
    "nimbbl_consumer_message": "<Consumer Message>",
    "nimbbl_merchant_message": "<Merchant Message>",
    "nimbbl_error_code": "<Error Code>",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Capture amount>",
    "transaction_type": "capture",
    "capture_type": "full",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>",
    "retry_allowed": false
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "pending",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "additional_charges": 0.0,
    "shipping_charges": 0.0,
    "cod_charges": 0.0,
    "grand_total": "<Grand Total>",
    "offer_discount": 0,
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}

Void Events​

Void Success Webhook​

void_success also arrives when Nimbbl auto-resolves an authorization at its expiry deadline (if your account's expiry action is void) — the event shape is the same one shown below either way. See the note after the examples for what does (and doesn't) let you tell the two apart.

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "void_success",
  "status": "success",
  "message": "Authorization Voided",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Void_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Void_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "succeeded",
    "payment_mode": "<Payment Mode>",
    "psp_credential_label": "<Cred Label>",
    "sub_payment_mode": {},
    "psp_transaction_id": "<PSP_Transaction_ID>",
    "nimbbl_consumer_message": "",
    "nimbbl_merchant_message": "",
    "nimbbl_error_code": "",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Authorized amount>",
    "transaction_type": "void",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>"
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "lapsed",
    "lapsed_reason": "merchant_voided_preauth",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "additional_charges": 0.0,
    "shipping_charges": 0.0,
    "cod_charges": 0.0,
    "grand_total": "<Grand Total>",
    "offer_discount": 0,
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}
Comment Field Identifies the Void's Cause

Use the transaction's comment field to check whether the void was done by you or an auto-void happened: an automatic void always carries "Auto-voided by the Nimbbl system", while a void you trigger via the API carries whatever comment you passed, or none.

Void Pending Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "void_pending",
  "status": "pending",
  "message": "Void Pending",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Void_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Void_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "pending",
    "payment_mode": "<Payment Mode>",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Authorized amount>",
    "transaction_type": "void",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>"
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "pending",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "grand_total": "<Grand Total>",
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}

Void Failed Webhook​

Your endpoint receives this over HTTPS POST:

{
    "payload": "<base64>",
    "signature": "<hmac-sha256-hex>",
    "sub_merchant_id": "<sub_merchant_id>",
    "version": "v4"
}

Base64-decode payload to get the JSON below — the full payment details for this event, verified by the accompanying signature.

Decoded payload
{
  "event_type": "void_failed",
  "status": "failed",
  "message": "Void Failed",
  "nimbbl_order_id": "<Order_ID>",
  "nimbbl_transaction_id": "<Void_Transaction_ID>",
  "transaction": {
    "transaction_id": "<Void_Transaction_ID>",
    "payment_partner": "<Payment Partner>",
    "status": "failed",
    "payment_mode": "<Payment Mode>",
    "nimbbl_consumer_message": "<Consumer Message>",
    "nimbbl_merchant_message": "<Merchant Message>",
    "nimbbl_error_code": "<Error Code>",
    "transaction_currency": "<ISO_4217 Alpha-3 format currency>",
    "transaction_amount": "<Authorized amount>",
    "transaction_type": "void",
    "original_payment_transaction_id": "<Original_Authorization_Transaction_ID>",
    "payment_transaction_amount": "<Original authorized amount>",
    "retry_allowed": false
  },
  "order": {
    "order_id": "<Order_ID>",
    "status": "lapsed",
    "lapsed_reason": "payment_authorized",
    "currency": "<ISO_4217 Alpha-3 format currency>",
    "total_amount": "<Total Amount>",
    "grand_total": "<Grand Total>",
    "custom_attributes": [],
    "device": {
      "browser_name": "Chrome",
      "device_name": "Other",
      "os_name": "Windows",
      "ip_address": "127.0.0.1"
    }
  },
  "psp_raw_response": null,
  "user": {
    "email": "[email protected]",
    "mobile": "9121212121",
    "name": "Shakthiman",
    "user_id": "<user_ID>"
  }
}
Callback PayloadsThe inline result delivered at checkout, as an alternative or complement to webhooksTransaction EnquiryThe pull-based alternative for polling status on demandPre-auth and CaptureIntegrating the authorization, capture, and void flow end to end