Events

Event Name	Status	Description
`deposit.completed`	COMPLETED	Deposit successfully credited to account
`deposit.failed`	FAILED	Deposit transaction failed
`deposit.reversed`	REVERSED	Completed deposit was reversed

deposit.completed

Triggered when a deposit transaction is successfully completed and funds are credited to the customer's account.

Payload

{
  "event_name": "deposit.completed",
  "resource": {
    "type": "deposits",
    "id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "data": {
    "status": "COMPLETED",
    "customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:30:00.000Z"
  }
}

Fields

Field	Type	Description
`status`	string	Always `COMPLETED` for this event
`customer_id`	string	The customer ID who received the deposit
`transaction_id`	string	Unique identifier for the deposit transaction
`created_at`	string	ISO 8601 timestamp when the deposit was initiated
`modified_at`	string	ISO 8601 timestamp when the deposit was completed

deposit.failed

Triggered when a deposit transaction fails.

Payload

{
  "event_name": "deposit.failed",
  "resource": {
    "type": "deposits",
    "id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "data": {
    "status": "FAILED",
    "customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:30:00.000Z"
  }
}

Fields

Field	Type	Description
`status`	string	Always `FAILED` for this event
`customer_id`	string	The customer ID
`transaction_id`	string	Unique identifier for the deposit transaction
`created_at`	string	ISO 8601 timestamp when the deposit was initiated
`modified_at`	string	ISO 8601 timestamp when the deposit failed

deposit.reversed

Triggered when a previously completed deposit is reversed. This typically occurs when:

A withdrawal is returned and the funds are credited back
An administrative reversal occurs

Payload

{
  "event_name": "deposit.reversed",
  "resource": {
    "type": "deposits",
    "id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "data": {
    "status": "REVERSED",
    "customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference_transaction_id": "wd_xyz789",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T14:00:00.000Z"
  }
}

Fields

Field	Type	Description
`status`	string	Always `REVERSED` for this event
`customer_id`	string	The customer ID
`transaction_id`	string	Unique identifier for the deposit transaction
`reference_transaction_id`	string \| null	Related withdrawal transaction ID (if this deposit is from a returned withdrawal)
`created_at`	string	ISO 8601 timestamp when the deposit was originally created
`modified_at`	string	ISO 8601 timestamp when the deposit was reversed