GuidesAPI ReferenceChangelog
API Reference

Deposits

Webhook events for deposit transaction status changes. These events apply to both fiat and crypto deposits.

Events

Event NameStatusDescription
deposit.pendingPENDINGDeposit transaction is pending
deposit.completedCOMPLETEDDeposit successfully credited to account
deposit.failedFAILEDDeposit transaction failed
deposit.reversedREVERSEDReturned withdrawal funds credited to account

deposit.pending

Triggered when a deposit transaction is pending.

Payload

{
  "event_name": "deposit.pending",
  "resource": {
    "type": "deposits",
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "data": {
    "status": "PENDING",
    "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "account_id": "BZ-ABCD-1234",
    "transaction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "currency": "USD",
    "amount": "100.05",
    "network": "SWIFT",
    "created_at": "2026-01-22T12:00:00.000Z",
    "modified_at": "2026-01-22T12:30:00.000Z"
  }
}

Fields

FieldTypeDescription
statusstringAlways PENDING for this event
customer_idstringThe customer ID
account_idstring | nullAccount ID of the customer, or null when unavailable
transaction_idstringUnique identifier for the deposit transaction
currencystringCurrency or token of the deposit
amountstringAmount associated with the deposit
networkstringNetwork used by the deposit. For crypto deposits, this is the blockchain name such as ETHEREUM, POLYGON, etc. For fiat deposits, this is the public bank network name such as US_ACH, US_FEDWIRE, US_RTP, SWIFT, or CUBIX.
created_atstringISO 8601 timestamp when the deposit was initiated
modified_atstringISO 8601 timestamp when the deposit was last updated

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",
    "account_id": "BZ-ABCD-1234",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "currency":"USD",
    "amount":"100.05",
    "network":"SWIFT",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:30:00.000Z"
  }
}

Fields

FieldTypeDescription
statusstringAlways COMPLETED for this event
customer_idstringThe customer ID who received the deposit
account_idstring | nullAccount ID of the customer, or null when unavailable
transaction_idstringUnique identifier for the deposit transaction
currencystringCurrency that received and credited in platform
amountstringActual net amount received
networkstringNetwork used by the deposit. For crypto deposits, this is the blockchain name such as ETHEREUM, POLYGON, etc. For fiat deposits, this is the public bank network name such as US_ACH, US_FEDWIRE, US_RTP, SWIFT, or CUBIX.
created_atstringISO 8601 timestamp when the deposit was initiated
modified_atstringISO 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",
    "account_id": "BZ-ABCD-1234",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "currency":"USD",
    "amount":"100.05",
    "network":"SWIFT",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:30:00.000Z"
  }
}

Fields

FieldTypeDescription
statusstringAlways FAILED for this event
customer_idstringThe customer ID
account_idstring | nullAccount ID of the customer, or null when unavailable
transaction_idstringUnique identifier for the deposit transaction
currencystringCurrency or token of the deposit
amountstringAmount associated with the deposit
networkstringNetwork used by the deposit. For crypto deposits, this is the blockchain name such as ETHEREUM, POLYGON, etc. For fiat deposits, this is the public bank network name such as US_ACH, US_FEDWIRE, US_RTP, SWIFT, or CUBIX.
created_atstringISO 8601 timestamp when the deposit was initiated
modified_atstringISO 8601 timestamp when the deposit failed

deposit.reversed

Triggered when funds from a returned or reversed fiat withdrawal are credited back to the customer through a corresponding deposit transaction. The transaction_id identifies this credit deposit, and reference_transaction_id links it to the original withdrawal when available.

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",
    "account_id": "BZ-ABCD-1234",
    "transaction_id": "dep_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "currency":"USD",
    "amount":"100.05",
    "network":"SWIFT",
    "reference_transaction_id": "wd_xyz789",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T14:00:00.000Z"
  }
}

Fields

FieldTypeDescription
statusstringAlways REVERSED for this event
customer_idstringThe customer ID
account_idstring | nullAccount ID of the customer, or null when unavailable
transaction_idstringUnique identifier for the deposit transaction
currencystringFiat currency of the returned withdrawal funds
amountstringAmount associated with the deposit
networkstringPublic bank network used for the return credit deposit, such as US_ACH, US_FEDWIRE, or SWIFT.
reference_transaction_idstring | nullRelated withdrawal transaction ID (if this deposit is from a returned withdrawal)
created_atstringISO 8601 timestamp when the return credit deposit was created
modified_atstringISO 8601 timestamp when the return credit deposit was completed