Add External Wallets
How do I create external wallets to withdraw assets?
External wallets can be used to withdraw assets from the Cybrid Platform to self-custody or hosted wallets.
Types of External Wallets
There are two types of external wallets to understand in the Cybrid Platform:
Type | Description |
---|---|
Customer Wallets | Unique wallets that are individually attached to a specific customer, and can only be used by the customer that created them. |
Bank Wallets | General wallets that are attached to a specific bank, and can be used with any customer associated with the bank. |
Creating External Wallets
External wallets can be created by leveraging the POST /api/external_wallets
endpoint.
Creating a Customer Wallet
When you need to associate a unique wallet for a specific customer, you'll use the POST /api/external_wallets endpoint and providing a customer_guid, as shown in the below JSON code block.
{
"name": "Customer Wallet",
"customer_guid": "<customer-guid-here>",
"asset": "string",
"address": "string",
"tag": "string"
}
When external wallets are created this way, they will be uniquely attached to the specific user specified in the customer_guid property.
When to use:
This is useful when you have individual customers who are adding their own external wallets in order to withdraw assets from the platform.
Creating a Bank Wallet
When you need to create a general purpose wallet, you can also do this via the POST /api/external_wallets endpoint, however the customer_guid is not provided.
{
"name": "General Wallet",
"asset": "string",
"address": "string",
"tag": "string"
}
When an external wallet is added without an associated customer_guid, the wallet is attached to the bank and can be used with any customer associated with that bank.
When to use:
This is useful if you are transferring assets from multiple different customers to the same address. For example, this method would work well if there is an omnibus wallet on your platform that is designed to receive all withdrawals from the Cybrid Platform.
Wallet Screening
All wallets go through a screening process to determine the risk level of the wallet. There are three outcomes for screened wallets:
- Wallet is gauged to be high risk. Wallets in this category are automatically rejected.
- Wallet is gauged to be medium risk. Wallets in this category go into review by our Compliance team. Review targets can be found here. Once reviewed, the wallet will either be accepted or rejected.
- Wallet is gauged to be low risk. Wallets in this category are automatically accepted.
Updated 28 days ago