Deposits

Receive updates regarding deposits have been sent to your global account.

EventNameDescription
deposit.funds.receivedDeposit is successfully received and added to your balance.

Objects Structure Samples

{
  "Id": "6819dbe4-bc22-484e-a5fc-d4fe5f587ab2",
  "Name": "deposit.funds.received",
  "AccountId": "a51ad689-bbca-42ac-8442-fe54c55b9a0e",
  "Data": {
    "Id": "550133521",
    "GlobalAccountId": "5b9c96fa-8033-4991-bd02-bc0c39afb8c7",
    "Type": "BANK_TRANSFER",
    "Status": "Received",
    "Currency": "CAD",
    "Amount": 451,
    "SettledAtUtc": "2025-06-12T07:39:12.38+00:00",
    "Fee": {
      "Type": "BANK_TRANSFER",
      "Currency": "CAD",
      "Amount": 0
    },
    "Payer": {
      "Name": "Paris",
      "Iban": null,
      "SwiftCode": null,
      "AccountNumber": null
    }
  },
  "CreateAtUtc": "2025-06-12T07:39:12.3838451Z"
}


Data Object For Deposits


PropertyTypeDescription
IdstringUnique identifier for the deposit event.
GlobalAccountIdGuidIdentifier of the global account to which the deposit was made.
TypestringType of deposit transaction ("BANK_TRANSFER").
StatusstringStatus of the deposit ("Received").
CurrencystringCurrency code in ISO 4217 format (e.g., "USD", "EUR").
AmountdecimalAmount received in the specified currency.
SettledAtUtcDateTimeOffsetTimestamp when the deposit was settled (in UTC).
FeeobjectInformation about the fee deducted from the deposit
Fee.TypestringType of fee applied ("BANK_TRANSFER").
Fee.CurrencystringCurrency Code in ISO 4217, in which the fee was charged.
Fee.AmountdecimalFee amount charged.
PayerobjectInformation about the payer who made the deposit
Payer.NamestringName of the entity or person who made the payment.
Payer.Ibanstring?IBAN of the payer, if available.
Payer.SwiftCodestring?SWIFT/BIC code of the payer, if applicable.
Payer.AccountNumberstring?Account number of the payer, if provided.