API Reference

Deposit Pending / Rejected / Completed

Published when a deposit is pending, rejected or completed.

Event metadata

  • name: DEPOSIT
  • types:
    • deposit.pending
    • deposit.compliance.rejected
    • deposit.completed

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringDesposit ID.
versionstringAPI Version number.
dataobjectObject containing deposit details associated with the event.

Notification examples

Pending

{
    "version": "V1.5.2", 
    "event_name": "DEPOSIT", 
    "event_type": "deposit.pending", 
    "event_id": "319318dc-934e-4d96-a994-601383e0d8a6", 
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
    "data": {
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9", 
        "account_name": "UQPAY PTE LTD.", 
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
        "deposit_currency": "USD", 
        "deposit_amount": "100", 
        "creator_id": "b6bd2cc2-ed8c-49ef-b8d3-b2292d47c5f8", 
        "creator_name": "Jim", 
        "create_time": "2024-07-18 14:19:52 +0800 CST", 
        "complete_time": "2024-07-18 14:19:52 +0800 CST", 
        "update_time": "2024-05-08 14:19:52 +0800 CST", 
        "deposit_status": "Pending"
    }
}

Rejected

{
    "version": "V1.5.2", 
    "event_type": "DEPOSIT", 
    "event_name": "deposit.compliance.rejected", 
    "event_id": "40f6b64c-e77f-43fb-af12-2cb4b35a8b71", 
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
    "data": {
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9", 
        "account_name": "UQPAY PTE LTD.", 
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
        "deposit_currency": "USD", 
        "deposit_amount": "100", 
        "creator_id": "b6bd2cc2-ed8c-49ef-b8d3-b2292d47c5f8", 
        "creator_name": "Jim", 
        "create_time": "2024-07-18 14:19:52 +0800 CST", 
        "complete_time": null, // complete time is null for rejection
        "update_time": "2024-05-08 14:19:52 +0800 CST", 
        "deposit_status": "Rejected"
    }
}

Completed

{
    "version": "V1.5.2", 
    "event_name": "DEPOSIT", 
    "event_type": "deposit.completed", 
    "event_id": "f531776b-df59-4d11-84f0-11e7ae3755f0", 
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
    "data": {
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9", 
        "account_name": "UQPAY PTE LTD.", 
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b", 
        "deposit_currency": "USD", 
        "deposit_amount": "100", 
        "creator_id": "b6bd2cc2-ed8c-49ef-b8d3-b2292d47c5f8", 
        "creator_name": "Jim", 
        "create_time": "2024-07-18 14:19:52 +0800 CST", 
        "complete_time": "2024-07-18 14:19:52 +0800 CST", 
        "update_time": "2024-05-08 14:19:52 +0800 CST", 
        "deposit_status": "Completed"
    }
}