Deposit

Webhook events will be triggered whenever a deposit is made into the user's Multi-Currency Account.

Event Category:

MULTI_CURRENCY_ACCOUNT

Event Type:

MULTI_CURRENCY_ACCOUNT.DEPOSIT.CREATE
MULTI_CURRENCY_ACCOUNT.DEPOSIT.UPDATE

Example webhook event

The data object is expected to have the same structure as the response from the Retrieve a Deposit endpoint.

{
  eventId: 'evt_14321582b0d12335e9',
  eventCategory: 'MULTI_CURRENCY_ACCOUNT',
  eventType: 'MULTI_CURRENCY_ACCOUNT.DEPOSIT.UPDATE',
  eventAction: 'UPDATE',
  data:{
    createdAt: "2025-02-25T17:52:00.728965+00:00",
    updatedAt: "2025-02-25T17:58:00.579+00:00",
    id: "e37f0299-37b6-492b-8bee-263ee3f95979",
    userId: "0e965562-047c-43ae-9481-fd894f7e6706",
    type: "EXTERNAL",
    currencyAccountId: "80f08151-01ec-479b-9304-5d2820a21abd",
    sourceAmount: 10,
    sourceCurrency: "USD",
    receivedAmount: 10,
    receivedCurrency: "USD",
    feeAmount: 0,
    feeCurrency: "USD",
    feeRate: "",
    debitedAmount: 10,
    debitedCurrency: "USD",
    rate: 1,
    status: "COMPLETED",
    swiftCode: "CITIUS22XXX",
    payee: {
      name: "Henry Wu",
      address: "",
      accountNumber: "71080000000444366"
    },
    payer: {
      name: "BANK OF AMERICA",
      country: "",
      address: "",
      bankName: "",
      accountNumber: "",
      userId: null
    },
    bankReference: "025056001474411",
    rejectReason: "",
    declareId: "",
    remark: null,
    reference: null
  },
  createdAt: '2025-03-07T15:54:01.420Z',
  timestamp: '2025-03-07T15:54:20.357Z',
  version: 'v2'
}