Deposit

Deposit Settled

Triggered when a deposit has been successfully processed and settled to the wallet balance.

Description

Sent when funds from a deposit have cleared all processing and are fully available in the wallet balance.

📦 Event Details

id string

Unique event identifier.

name string

Event name: deposit.settled.

account_id string

Unique identifier of the account associated with the deposit.

data object

Event payload containing deposit settlement details.

id string

Unique identifier of the deposit.

amount double

Deposit amount credited to the account.

currency string

Currency of the deposit (3-letter ISO-4217 code).

fee object

Fee charged for the deposit transaction, if any.

amount double

Fee amount applied to the deposit.

currency string

Currency of the fee (3-letter ISO-4217 code).

global_account_id string

Global account identifier linked to the deposit.

payer object

Details of the payer who initiated the deposit.

name string

Name of the payer.

provider_transaction_id string

Transaction identifier provided by the payment provider.

reference string

Client-provided reference for the deposit.

status string

Current deposit status. Value: SETTLED.

type string

Deposit method used. Value: BANK_TRANSFER.

settled_at long

Epoch timestamp (milliseconds) indicating when the deposit was settled.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "1a06397d-6919-40d7-98de-e10c66f250c1_deposit.settled",
  "name": "deposit.settled",
  "account_id": "acct_hUiVInamMd68NDDm5VVmyA",
  "data": {
    "amount": 50.0,
    "currency": "USD",
    "fee": {
      "amount": 0,
      "currency": "USD"
    },
    "global_account_id": "bc2669d5-9ae3-41a5-9589-f8c424c47da5",
    "id": "1a06397d-6919-40d7-98de-e10c66f250c1",
    "payer": {
      "name": "JS"
    },
    "provider_transaction_id": "5487287789",
    "reference": "123",
    "status": "SETTLED",
    "type": "BANK_TRANSFER",
    "settled_at": 1746006056378
  },
  "created_at": "2025-04-30T09:40:56+0000",
  "version": "2025-02-14"
}

Deposit Rejected

Triggered when a deposit has been rejected during processing by Zoqq or the clearing system.

Description

Sent when a deposit fails verification or is rejected by compliance checks, preventing settlement to the wallet balance.

📦 Event Details

id string

Unique event identifier.

name string

Event name: deposit.rejected.

account_id string

Unique identifier of the account associated with the deposit.

data object

Event payload containing deposit rejection details.

id string

Unique identifier of the deposit.

amount double

Deposit amount that was rejected.

currency string

Currency of the deposit (3-letter ISO-4217 code).

fee object

Fee details associated with the deposit, if any.

amount double

Fee amount applied to the deposit.

currency string

Currency of the fee (3-letter ISO-4217 code).

global_account_id string

Global account identifier linked to the deposit.

payer object

Details of the payer who initiated the deposit.

name string

Name of the payer.

provider_transaction_id string

Transaction identifier provided by the payment provider.

reference string

Client-provided reference for the deposit.

status string

Current deposit status. Value: REJECTED.

type string

Deposit method used. Value: BANK_TRANSFER.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "303ae28f-3ab0-4682-8253-3f605beb3db1_deposit.rejected",
  "name": "deposit.rejected",
  "account_id": "acct_hUiVInamMd68NDDm5VVmyA",
  "data": {
    "amount": 50.0,
    "currency": "USD",
    "fee": {},
    "global_account_id": "bc2669d5-9ae3-41a5-9589-f8c424c47da5",
    "id": "303ae28f-3ab0-4682-8253-3f605beb3db1",
    "payer": {
      "name": "JS"
    },
    "provider_transaction_id": "5487287789",
    "reference": "123",
    "status": "REJECTED",
    "type": "BANK_TRANSFER"
  },
  "created_at": "2025-04-30T12:05:35+0000",
  "version": "2025-02-14"
}