Summary

The following funding deposit and submerchant deposit webhooks provide real-time updates on the funding process, allowing you to track when deposits are funded or rejected. See the following sections for webhook descriptions, payload structures, data schemas, and trigger conditions.

Funding Deposit Webhooks

Funding deposit webhooks trigger when a funding deposit reaches a final status of Funded, Rejected, or Partially Rejected.

Webhook Name	Type	Description
Funding Deposit Funded	6	Triggers when a funding deposit is successfully funded
Funding Deposit Rejected	7	Triggers when a funding deposit is completely rejected
Funding Deposit Partially Rejected	8	Triggers when one or more merchants in a funding deposit are rejected, but others are funded

Payload Structure

The funding deposit webhooks listed above (Funding Deposit Funded, Funding Deposit Rejected, and Funding Deposit Partially Rejected) use the following payload structure:

{
  "tenantSlug": "string",
  "fundingDepositId": 123,
  "fundingStatus": 2
}

Data Schema

Field	Description
tenantSlug	Unique identifier for the tenant/organization
fundingDepositId	Internal ID of the funding deposit
fundingStatus	Numeric status code (see the Status Values table below)

Status Values

Status	Description
2 = Funded	All transactions in the deposit were successfully funded
3 = Rejected	All transactions in the deposit were rejected and will not be funded
4 = PartiallyRejected	Some transactions were funded while others were rejected

Trigger Conditions

These webhooks...

fire when the overall funding deposit status changes to Funded, Rejected, or PartiallyRejected.
only fire once per deposit per final status.
require an active webhook subscription for each specific webhook type.

Submerchant Deposit Webhook

The submerchant deposit webhook triggers when an individual merchant's deposit enters the Rejected status.

Webhook Name	Type	Description
Submerchant Deposit Rejected	5	Triggers when a specific merchant's deposit within a funding deposit is rejected

Payload Structure

The Submerchant Deposit Rejected webhook uses the following payload structure:

{
  "tenantSlug": "string",
  "merchantMid": "string",
  "merchantId": 123,
  "submerchantDepositId": 456,
  "fundingDepositId": 789,
  "fundingStatus": 3
}

Data Schema

Field	Description
tenantSlug	Unique identifier for the tenant/organization
merchantMid	Merchant ID (MID) assigned by the payment processor
merchantId	Internal merchant identifier
submerchantDepositId	Internal ID of the specific submerchant deposit
fundingDepositId	Internal ID of the associated funding deposit
fundingStatus	Numeric status code (always "3 - Rejected" for this webhook)

Status Values

Status	Description
3 = Rejected	The submerchant deposit was rejected and will not be funded

Trigger Conditions

This webhook...

fires when an individual merchant's portion of a funding deposit is rejected.
only fires for the Rejected status (does not fire for Funded).
can fire multiple times per funding deposit if multiple merchants are rejected.
requires an active webhook subscription for Submerchant Deposit Rejected.