Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a deposit.

Deposit events

Events

Payload

The webhook payload consists of:

data - represents all deposit fields returned by the get deposit endpoint
event_type - deposit events denoted by the format of deposit.{deposit_status}

{
    "data": {
        "deposit_id": "dep_2sOhrqqvczzMolLKkcWyWxquj0i",
        // ...
        "status": "PROCESSING",
        // ...
    },
    "event_type": "deposit.processing"
}

Processing

Event: deposit.processing

Triggered when a deposit is created and processing.

Field	Description
`deposit_id`	The unique deposit identifier.
`platform_id`	The unique platform identifier. Will be set if this deposit belongs to a platform.
`merchant_id`	The unique merchant identifier. Will be set if this deposit belongs to a merchant.
`status`	The status of the deposit, will be `PROCESSING`.
`amount`	The amount deposited, in minor units.
`deposit_type`	The types of of deposit. Valid values are `BILLING` or `FUNDING`. Billing only applies to merchants on gross billing.
`method_type`	The type of deposit method. Valid values are `ACH` or `PLAID_ACH`. Determines the `ach` or `plaid_ach` object is defined.
`ach`	ACH deposit method details, applicable if the `method_type` is `ACH`.
`plaid_ach`	ACH deposit method details from Plaid, applicable if the `method_type` is `PLAID_ACH`.
`created_at`	Date and time deposit was created at in UTC RFC 3339 format.

In review

Event: deposit.in_review

Triggered when a deposit is flagged for risk review. Funds have not been sent to the merchant or platform's bank account.

Field	Description
`deposit_id`	The unique deposit identifier.
`status`	The status of the deposit, will be `IN_REVIEW`.

Succeeded

Event: deposit.succeeded

Triggered when a deposit has completed processing and the funds have been deposited into the merchant or platform's bank account.

Field	Description
`deposit_id`	The unique deposit identifier.
`status`	The status of the deposit, will be `SUCCEEDED`.

Failed

Event: deposit.failed

Triggered when a deposit unsuccessfully attempts to process. We attempted to deposit the funds to the merchant or platform's bank account, but the deposit was returned.

Field	Description
`deposit_id`	The unique deposit identifier.
`status`	The status of the deposit, will be `FAILED`.