Skip to main content

​
Event metadata

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

​
Request body

​
Notification examples

​
Pending

The deposit status Pending in webhook payloads corresponds to the status PENDING in query API responses. 
{
    "version": "V1.6.0",
    "event_name": "DEPOSIT",
    "event_type": "deposit.pending",
    "event_id": "319318dc-934e-4d96-a994-601383e0d8a6",
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
    "data": {
        "direct_id": "0",
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9",
        "account_name": "UQPAY PTE LTD.",
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
        "short_reference_id": "230907-GwisGvJK",
        "deposit_currency": "USD",
        "deposit_fee": "0",
        "deposit_amount": "100",
        "create_time": "2024-07-18T14:19:52+08:00",
        "complete_time": "2024-07-18T14:19:52+08:00",
        "update_time": "2024-05-08T14:19:52+08:00",
        "deposit_status": "Pending",
        "deposit_reference": ""
    }
}

​
Rejected

The deposit status Rejected in webhook payloads corresponds to the status FAILED in query API responses. 
{
    "version": "V1.6.0",
    "event_type": "DEPOSIT",
    "event_name": "deposit.compliance.rejected",
    "event_id": "40f6b64c-e77f-43fb-af12-2cb4b35a8b71",
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
    "data": {
        "direct_id": "0",
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9",
        "short_reference_id": "230907-GwisGvJK",
        "account_name": "UQPAY PTE LTD.",
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
        "deposit_currency": "USD",
        "deposit_fee": "0",
        "deposit_amount": "100",
        "create_time": "2024-07-18T14:19:52+08:00",
        "complete_time": null, // complete time is null for rejection
        "update_time": "2024-05-08T14:19:52+08:00",
        "deposit_status": "Rejected",
        "deposit_reference": ""
    }
}

​
Completed

The deposit status Completed in webhook payloads corresponds to the status COMPLETED in query API responses. 
{
    "version": "V1.6.0",
    "event_name": "DEPOSIT",
    "event_type": "deposit.completed",
    "event_id": "f531776b-df59-4d11-84f0-11e7ae3755f0",
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
    "data": {
        "direct_id": "0",
        "account_id": "ac1e31ab-f0fd-4432-91fb-b06ec1b3d7b9",
        "short_reference_id": "230907-GwisGvJK",
        "account_name": "UQPAY PTE LTD.",
        "deposit_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
        "deposit_currency": "USD",
        "deposit_fee": "5",
        "deposit_amount": "100",
        "create_time": "2024-07-18T14:19:52+08:00",
        "complete_time": "2024-07-18T14:19:52+08:00",
        "update_time": "2024-07-18T14:19:52+08:00",
        "deposit_status": "Completed",
        "deposit_reference": ""
    }
}