balance-update webhook will be triggered when the user balance changed.
settlement-update webhook will be triggered when the settlement status changed.
Examples:
- User deposits 500 USD
balance-update : group=settlement, category=WIRE_RECEIVED
{"uid":"123","group":"settlement","category":"WIRE_RECEIVED","reference_id":"ac2df0d0-115b-4f77-ac36-bf7669d664e2","reference":"","asset":"USD","amount_change":500,"amount_before":0,"amount_after":"500.0000","created_at":"2023-01-18T06:55:19.000000Z"}
settlement-update: status=”settled”
{"uid":"123","settlement_id":"ac2df0d0-115b-4f77-ac36-bf7669d664e2","category":"WIRE_RECEIVED","asset":"USD","amount":"500","status":"settled","updated_at":"2023-01-18T06:55:19.000000Z","reference":"","txid":""}
- User sends "buy" order for 500 USDT/USD
There are 2 balance-update:
Group=trade, category=buy, asset= “USD“, USD decreased
{"uid":"123","group":"trade","category":"buy","reference_id":"227681ef-d369-4d24-a554-c24799a64cb9","reference":"807a7242-6eae-4eec-b6f0-151e3a6452cd","asset":"USD","amount_change":-500,"amount_before":500,"amount_after":"0.0000","created_at":"2023-01-19T20:16:16.818101Z"}
Group=trade, category=buy, asset= “USDT“, USDT increased
{"uid":"123","group":"trade","category":"buy","reference_id":"227681ef-d369-4d24-a554-c24799a64cb9","reference":"807a7242-6eae-4eec-b6f0-151e3a6452cd","asset":"USDT","amount_change":492.4233,"amount_before":0,"amount_after":"492.4233","created_at":"2023-01-19T20:16:16.818101Z"}
- Auto withdraw crypto started
settlement-update: category=CRYPTO_SENT, status=”pending”.
balance-update: group=settlement, category=CRYPTO_SENT, asset= “USDT“,
{"uid":"123","settlement_id":"f8fdb5a1-139c-4744-8d60-6147e67cb916","category":"CRYPTO_SENT","asset":"USDT","amount":492.4233,"status":"pending","updated_at":"2023-01-19T20:17:16.818101Z","reference":"807a7242-6eae-4eec-b6f0-151e3a6452cd","txid":""}
- Crypto out completed
settlement-update: category=CRYPTO_SENT, status=”settled”
{"uid":"123","settlement_id":"f8fdb5a1-139c-4744-8d60-6147e67cb916","category":"CRYPTO_SENT","asset":"USDT","amount":"492.4233","status":"settled","updated_at":"2023-01-19T20:27:16.818101Z","reference":"807a7242-6eae-4eec-b6f0-151e3a6452cd","txid":"12344555"}
- User sells 60 USDT
settlement-update:categoy=CRYPTO_RECEIVED, status=”settled”
{"uid":"123","settlement_id":"26566705-e67f-423a-ac9d-1e8981736d15","category":"CRYPTO_RECEIVED","asset":"USDT","amount":"60.00000000","status":"settled","updated_at":"2023-06-11T19:22:03.000000Z","reference":null,"txid":""}
- Create fiat withdraw settlement automatically right after the trade
settlement-update:
{"uid":"123","settlement_id":"fe2b1247-05da-45a0-bcbc-77bd5788e6f9","category":"WIRE_SENT","asset":"EUR","amount":"53.14","status":"pending","updated_at":"2024-06-11T19:21:57.000000Z","reference":"c57227bb-bfc3-40b4-9a2b-438cca4ec1b0","txid":""}
balance-update:(the reference id here is settlement_id in the settlement-update webhook)
{"uid":"123","group":"settlement","category":"WIRE_SENT","reference_id":"fe2b1247-05da-45a0-bcbc-77bd5788e6f9","reference":"c57227bb-bfc3-40b4-9a2b-438cca4ec1b0","asset":"EUR","amount_change":-53.14,"amount_before":53.1468,"amount_after":"0.0068","created_at":"2024-06-11T19:21:58.014615Z"}
- The settlement status will be settled once we initiate the wire:
settlement-update
{"uid":"123","settlement_id":"fe2b1247-05da-45a0-bcbc-77bd5788e6f9","category":"WIRE_SENT","asset":"EUR","amount":"53.14","status":"settled","updated_at":"2024-06-11T19:21:57.000000Z","reference":"c57227bb-bfc3-40b4-9a2b-438cca4ec1b0","txid":""}