# Deposit events

# DepositBankAccountCreatedEvent

Triggered when a bank account is created for a tenant.

# Payload

key type description
depositId string A unique identifier for the deposit
externalId string The external identifier for the deposit
tenantId string A unique identifier for the tenant

# Example

{
  "depositId":"293fa026-df24-4eb4-a2b6-c530a523e5e2",
  "externalId":"123123",
  "tenantId":"19C01144-0C16-40AB-8845-B5FB231DDA34"
}

# DepositCreatedEvent

Triggered when a new deposit is created.

# Payload

key type description
depositId string A unique identifier for the deposit
externalId string The external identifier for the deposit

# Example

{
  "depositId":"293fa026-df24-4eb4-a2b6-c530a523e5e2",
  "externalId":"123123"
}

# DepositPartiallyFundedEvent

Triggered when partial payment has been made to the deposit.

# Payload

key type description
depositId string A unique identifier for the deposit
externalId string The external identifier for the deposit
funds decimal The amount of funds in the deposit

# Example

{
  "depositId":"293fa026-df24-4eb4-a2b6-c530a523e5e2",
  "externalId":"123123",
  "funds":24000.0
}

# DepositFullyFundedEvent

Triggered when full payment has been made to the deposit.

# Payload

key type description
depositId string A unique identifier for the deposit
externalId string The external identifier for the deposit
funds decimal The amount of funds in the deposit

# Example

{
  "depositId":"293fa026-df24-4eb4-a2b6-c530a523e5e2",
  "externalId":"123123",
  "funds":25000.0
}

# DepositTerminatedEvent

Triggered when a deposit account has been terminated and converted to a normal banking account.

# Payload

key type description
depositId string A unique identifier for the deposit
externalId string The external identifier for the deposit

# Example

{
  "depositId":"293fa026-df24-4eb4-a2b6-c530a523e5e2",
  "externalId":"123123"
}
Last updated: 5/5/2020, 7:51:37 PM