Webhooks are a mechanism for your software to automatically receive information about events. By leveraging webhooks, you remove the need to poll the API for state changes.
For general information related to webhooks, refer to the Implementing webhooks guide.
Clients can subscribe to webhooks, regardless of the API integration for incoming or outgoing securities transfers.
To reflect the related status changes, the following account transfer events are sent out.
| Status | Description |
|---|---|
ACCOUNT_TRANSFER.NEW | An account transfer has been requested. |
ACCOUNT_TRANSFER.PROCESSING | Processing of the transfer has started and instructions sent into the market. |
ACCOUNT_TRANSFER.PARTIALLY_SETTLED | Only part of the single positions within the account transfer were executed at the custodian level, so the account transfer is partially settled. |
ACCOUNT_TRANSFER.SETTLED | The transfer was executed at the custodian level. |
ACCOUNT_TRANSFER.CANCELLED | The transfer has been either canceled by Upvest or possibly rejected by the custodian bank. |
{
"id": "b5d0d9d0-bb8e-48b4-b2af-11df2b522353",
"created_at": "2024-01-22T14:10:00.00Z",
"type": "ACCOUNT_TRANSFER.NEW",
"object": {
"id": "63da4452-2dd3-4414-a7ca-66c0e3e89645",
"created_at": "2025-01-22T14:10:00.00Z",
"updated_at": "2025-01-22T14:12:34.56Z",
"direction": "INCOMING",
"status": "NEW",
"transfer_type": "NO_OWNER_CHANGE",
"instruments": [
{
"id": "US0378331005",
"id_type": "ISIN",
"quantity": "10",
"status": "NEW",
"transfer_id": "9637e68f-7065-4131-a072-6d57044ebd8c"
},
{
"id": "US64110L1061",
"id_type": "ISIN",
"quantity": "5",
"status": "NEW",
"transfer_id": "c2f84524-3f05-4849-909c-2998803327d3"
}
],
"user_id": "7e9a0529-d289-4f4a-ae01-c2cd013d582e",
"account_id": "d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4",
"settlement_reference": "b82dc5985558fdr2",
"counterparty": {
"bic": "ABCDDEFFXXX",
"account_number": "1234567891",
"name": "Max Mustermann"
}
},
"webhook_id": "cab4673a-1381-4404-aec4-982dae33a38c"
}{
"id": "b5d0d9d0-bb8e-48b4-b2af-11df2b522353",
"created_at": "2024-01-22T14:10:00.00Z",
"type": "ACCOUNT_TRANSFER.NEW",
"object": {
"id": "63da4452-2dd3-4414-a7ca-66c0e3e89645",
"created_at": "2025-01-22T14:10:00.00Z",
"updated_at": "2025-01-22T14:12:34.56Z",
"direction": "OUTGOING",
"status": "NEW",
"transfer_type": "NO_OWNER_CHANGE",
"instruments": [
{
"id": "US0378331005",
"id_type": "ISIN",
"quantity": "10",
"status": "NEW",
"transfer_id": "9637e68f-7065-4131-a072-6d57044ebd8c"
},
{
"id": "US64110L1061",
"id_type": "ISIN",
"quantity": "5",
"status": "NEW",
"transfer_id": "c2f84524-3f05-4849-909c-2998803327d3"
}
],
"user_id": "7e9a0529-d289-4f4a-ae01-c2cd013d582e",
"account_id": "d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4",
"settlement_reference": "b82dc5985558fdr2",
"counterparty": {
"bic": "ABCDDEFFXXX",
"account_number": "1234567891",
"name": "Max Mustermann"
}
},
"webhook_id": "cab4673a-1381-4404-aec4-982dae33a38c"
}