Receive Withdrawal Notifications
Once the transaction has been submitted, the following webhooks are sent out for each stage of the withdrawal process.
layer1:crypto:withdrawal:status-change
updates on any change of the withdrawal status.layer1:digital:balance:updated
gives an update of the wallet balances within your Asset Pool.
The "balance updated" webhooks
The following webhooks are sent out to update the current balance within the corresponding master address:
- The "funds reserved" update indicates the withdrawal amount has been moved from
AVAILABLE
toRESERVED
balance. - The "funds released" update indicates that the funds have been removed from the
RESERVED
pool following a successful withdrawal.
{
"event": "layer1:digital:balance:updated",
"timestamp": "2024-06-06T19:33:25.059079161Z",
"data": {
"reference": "AssetPoolTwo",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"asset": "ETH",
"funds": [
{
"type": "AVAILABLE",
"balance": "0.19848315335156838671875",
"delta": "-0.00114716058324173828125"
},
{
"type": "BLOCKCHAIN",
"balance": "0.199630313934810125",
"delta": "0.00"
},
{
"type": "RESERVED",
"balance": "0.00114716058324173828125",
"delta": "0.00114716058324173828125"
}
]
}
}
{
"event": "layer1:digital:balance:updated",
"timestamp": "2024-06-06T19:34:38.763517740Z",
"data": {
"reference": "AssetPoolTwo",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"asset": "ETH",
"funds": [
{
"type": "AVAILABLE",
"balance": "0.198496131149297125",
"delta": "0.000012977797728738"
},
{
"type": "BLOCKCHAIN",
"balance": "0.198496131149297125",
"delta": "-0.001134182785513"
},
{
"type": "RESERVED",
"balance": "0.00",
"delta": "-0.001147160583241738"
}
]
}
}
The "status change" webhooks
The following webhooks are sent out to inform about the current status of the withdrawal:
Status | Description |
---|---|
CREATED | The withdrawal request is first registered with the created status. |
FUNDS_NEEDED | The withdrawal is paused if there are insufficient funds within the asset pool to action the withdrawal. The transaction automatically progresses once matching funds are detected, or is rejected after 24 hours. |
FUNDS_REQUESTED | A top up of funds has been requested to ensure enough balance is present to process withdrawal. |
REJECTED | The withdrawal is rejected if there are insufficient funds within the asset pool to action the withdrawal. |
FUNDS_RESERVED | The withdrawal has moved funds from the available balance to the reserved balance. |
APPROVAL_REQUESTED | The withdrawal requires approval and is pending review by approvers. |
SCREENING_REQUESTED | The withdrawal has moved into the screening phase and requires screening. |
HELD | The withdrawal has been held to be manually reviewed. |
SCREENING_PASSED | The withdrawal has passed screening, manual or automatic. |
SIGNED | The withdrawal is signed and submitted to the blockchain. |
DETECTED | The withdrawal has been detected and distributed on the blockchain, but does not yet have any confirmations. At this stage, the transaction is already on the relevant blockchain and can now be traced with the hash provided in the webhook. |
FAILED | The withdrawal failed due to an on-chain error that occurred during execution, which could be due to due to multiple underlying reasons. |
UNCONFIRMED | The withdrawal has had one or more blockchain confirmations, but has not yet reached the required confirmation limit. |
CONFIRMED | The withdrawal has reached the required confirmation limit and is not fully confirmed on the blockchain. |
SUCCESS | The withdrawal is successful, and the balance of the asset pool is updated to reflect this. |
BLOCKED | An unexpected failure has occurred. Withdrawal must be checked by support before retrying. |
REPLACED | An unexpected failure has occurred and manual action was required by the Layer1 team. The replaced withdrawal will have the same reference value. |
Most common webhook examples
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:25.139504437Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001",
"status": "CREATED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.000147160583241738",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
},
{
"amount": "0.001",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:25.109693Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84A4a239805d06c685219801B82BEA7c76702214"
}
]
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:25.332170456Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001",
"status": "SCREENING_REQUESTED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.000147160583241738",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
},
{
"amount": "0.001",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:25.298837Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84A4a239805d06c685219801B82BEA7c76702214"
}
]
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:26.038587396Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001",
"status": "FUNDS_RESERVED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.000147160583241738",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
},
{
"amount": "0.001",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:25.987397Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84A4a239805d06c685219801B82BEA7c76702214"
}
]
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:26.620045369Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001",
"status": "SIGNED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.000147160583241738",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
},
{
"amount": "0.001",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:26.596896Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84A4a239805d06c685219801B82BEA7c76702214"
}
]
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:31.090682810Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"hash": "0xd5048b414557978a4c271998b3fda04b0f6228edbdb47500a045f12bf22b1ee2",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001",
"status": "DETECTED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.001",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:31.046673Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84a4a239805d06c685219801b82bea7c76702214"
}
]
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:33:38.477488250Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"hash": "0xd5048b414557978a4c271998b3fda04b0f6228edbdb47500a045f12bf22b1ee2",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001134182785513",
"status": "UNCONFIRMED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.001134182785513",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:33:38.447726Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84a4a239805d06c685219801b82bea7c76702214"
}
],
"networkDetail": {
"fee": {
"asset": "ETH",
"amount": "0.000134182785513"
},
"block": {
"number": 6053161,
"timestamp": "2024-06-06T19:33:36Z"
}
}
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:34:38.719132837Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"hash": "0xd5048b414557978a4c271998b3fda04b0f6228edbdb47500a045f12bf22b1ee2",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001134182785513",
"status": "CONFIRMED",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.001134182785513",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:34:38.697222Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84a4a239805d06c685219801b82bea7c76702214"
}
],
"networkDetail": {
"fee": {
"asset": "ETH",
"amount": "0.000134182785513"
},
"block": {
"number": 6053161,
"timestamp": "2024-06-06T19:33:36Z"
}
}
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"timestamp": "2024-06-06T19:34:38.822842496Z",
"data": {
"id": "018fef0aab157afb966b7d20c89b55048e1fcdb58edc49b792891c41c5bcd81869",
"hash": "0xd5048b414557978a4c271998b3fda04b0f6228edbdb47500a045f12bf22b1ee2",
"type": "WITHDRAWAL",
"asset": "ETH",
"amount": "0.001134182785513",
"status": "SUCCESS",
"address": {
"id": "8e1fcdb5-8edc-49b7-9289-1c41c5bcd818",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d",
"network": "ETHEREUM",
"keyPairId": "fdc9f5a0-698c-4163-ab21-df85f343a2a4",
"reference": "AssetPoolTwo",
"assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
},
"sources": [
{
"amount": "0.001134182785513",
"address": "0x96073c4b415d60ade18de32e43efc2914731e03d"
}
],
"createdAt": "2024-06-06T19:33:24.885Z",
"reference": "myUniqueRef333",
"updatedAt": "2024-06-06T19:34:38.802803Z",
"destinations": [
{
"amount": "0.001",
"address": "0x84a4a239805d06c685219801b82bea7c76702214"
}
],
"networkDetail": {
"fee": {
"asset": "ETH",
"amount": "0.000134182785513"
},
"block": {
"number": 6053161,
"timestamp": "2024-06-06T19:33:36Z"
}
}
}
}
{
"event": "layer1:digital:withdrawal:status-change",
"eventId": "0198f073-80fa-7937-b9d0-ec65cd720d46",
"timestamp": "2025-08-28T11:32:38.266465881Z",
"data": {
"id": "0198f0734ca67f07b2dd2dce33b0d2bdbe82d3b6724241288626f199041bc2986955534454",
"type": "WITHDRAWAL",
"asset": "USDT",
"amount": "111.00",
"status": "HELD",
"address": {
"id": "be82d3b6-7242-4128-8626-f199041bc298",
"address": "TJ61SeQ22JZXAH5kkWky6y4Eas7Cc5zfvZ",
"network": "TRON",
"keyPairId": "025aaa9f-95dc-49be-b205-ecba5c0724bf",
"reference": "AssetPoolTwo",
"assetPoolId": "99a25ffd-ab8d-4445-baf9-b10172039789"
},
"sources": [
{
"asset": "TRX",
"amount": "13.3735",
"address": "TJ61SeQ22JZXAH5kkWky6y4Eas7Cc5zfvZ"
},
{
"asset": "USDT",
"amount": "111.00",
"address": "TJ61SeQ22JZXAH5kkWky6y4Eas7Cc5zfvZ"
}
],
"createdAt": "2025-08-28T11:32:24.870Z",
"reference": "myUniqueRef333",
"updatedAt": "2025-08-28T11:32:38.242953Z",
"destinations": [
{
"asset": "USDT",
"amount": "111.00",
"address": "TEAhQNyqfPds5d3ztLZbyiwLHqBFWN7k7r"
}
]
}
}
Updated 15 days ago