Guides
Guides/Deposit Webhooks

Deposit Webhooks

These webhooks notify you about incoming deposits to your FV Bank account, including their compliance lifecycle and final outcome.


📌 Deposit Event Types

Event TypeDescription
DEPOSIT_RECEIVEDTriggered when FV Bank receives a deposit against your deposit instructions. The funds are not yet credited and require compliance review.
DEPOSIT_AUTHORIZEDTriggered when the deposit is approved by compliance and funds are successfully credited to your account.
DEPOSIT_DENIEDTriggered when a deposit is rejected by the compliance team and will not be credited.
DEPOSIT_CANCELLEDTriggered when a deposit is cancelled by the compliance team before completion.
DEPOSIT_RETURNEDTriggered when the deposit is returned back to the original sender of funds.

📦 Example: Deposit Webhook

code

{
  "Date": "2022-01-13T04:41:53",
  "Data": {
    "CreatedDate": "2023-02-17T11:09:31.609Z",
    "TransactionNumber": "FV000014212",
    "Type": "Deposit - Domestic Wire",
    "Amount": "3999600.00",
    "From": "FALCONX LIMITED",
    "To": "Raj Biz Co - Raj Biz",
    "Currency": "USD",
    "Description": "DEPOSIT REFERENCE: 7801000107",
  …

🧾 Virtual Account Deposits

If a deposit is made to a virtual account mapped to a beneficiary, an additional field will be included in the webhook payload:

code

{
  "Date": "2022-01-13T04:41:53",
  "Data": {
    "CreatedDate": "2023-02-17T11:14:25.634Z",
    "TransactionNumber": "FV000014214",
    "Type": "Deposit - Domestic Wire",
    "Amount": "400000",
    "From": "FALCONX LIMITED",
    "To": "Raj Biz Co - Raj Biz",
    "Currency": "USD",
    "Description": "780008000006",
  …

🧠 How to Use These Events

  • Use DEPOSIT_RECEIVED to detect incoming funds awaiting approval
  • Use DEPOSIT_AUTHORIZED as the final success state (funds credited)
  • Handle DENIED, CANCELLED, and RETURNED as failure scenarios

⚠️ Important Notes

  • Deposits follow a compliance-driven lifecycle similar to payments
  • Funds are only available after DEPOSIT_AUTHORIZED
  • Always use TransactionNumber for reconciliation
  • Additional details (originator info, bank references) are available in AdditionalData

📌 Summary

code

RECEIVED → AUTHORIZED (Success)
         → DENIED / CANCELLED / RETURNED (Failure)

These webhooks enable real-time tracking and reconciliation of incoming funds into your FV account.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose