Manage deposit addresses associated with your virtual account.
Depending on how virtual accounts are connected to the blockchain, the virtual accounts can be:
2 credits per API call
On Flow, additional 3000 credits are consumed for each created address.
Create a deposit address associated with a virtual account.
You can create multiple deposit addresses for one virtual account. When you have multiple deposit addresses created for the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
By default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
Virtual account cryptocurrency
Depending on the cryptocurrency of the virtual account, this API generates:
For fore information about supported blockchains and address types, see the API for creating virtual accounts.
Deposit addresses are generated in the natural order of the extended public key provided in the virtual account. The derivation index is the representation of that order; it starts from 0 and ends at 2^31.
When a new deposit address is generated, the last not used index is used to generate the address. You can skip some addresses to a different index, which means all the skipped addresses will no longer be used.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}
1 credit per API call
Get all deposit addresses generated for a virtual account.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
[- {
- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}
]
2 credits per API call + 1 credit for each created address
On Flow, additional 3000 credits are consumed for each created address.
Create multiple deposit addresses associated with a virtual account.
When you have multiple deposit addresses created for the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
By default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
Virtual account cryptocurrency
Depending on the cryptocurrency of the virtual account, this API generates:
For fore information about supported blockchains and address types, see the API for creating virtual accounts.
Deposit addresses are generated in the natural order of the extended public key provided in the virtual account. The derivation index is the representation of that order; it starts from 0 and ends at 2^31.
When a new deposit address is generated, the last not used index is used to generate the address. You can skip some addresses to a different index, which means all the skipped addresses will no longer be used.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "addresses": [
- {
- "accountId": "5e6be8e9e6aa436299950c41"
}
]
}
[- {
- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}
]
1 credit per API call
Check whether a blockchain address with the specified cryptocurrency is registered within Tatum and is assigned to a virtual account (that is, whether this blockchain address is a deposit address associated with the virtual account).
If the blockchain address is assigned to a virtual account, information about this account is returned. Otherwise, an error message is returned.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "id": "5e68c66581f2ee32bc354087",
- "balance": {
- "accountBalance": "1000000",
- "availableBalance": "1000000"
}, - "currency": "BTC",
- "frozen": false,
- "active": true,
- "customerId": "5e68c66581f2ee32bc354087",
- "accountNumber": "123456",
- "accountCode": "03_ACC_01",
- "accountingCurrency": "EUR",
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka"
}
2 credits per API call
Assign an existing blockchain address to a virtual account. The blockchain address becomes a deposit address associated with this account.Use this API when the virtual account has no default extended public key (xpub
) and deposit addresses are handled manually.
You can assign multiple blockchain addresses to one virtual account. When you have multiple blockchain addresses assigned to the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
By default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}
1 credit per API call
Remove a deposit address from the virtual account.
The deposit address will no longer be scanned for incoming deposits. You will no longer be able to generate this address again.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}