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:

Creating External Wallets

External wallets can be created by leveraging the /api/external_wallets endpoint. You can test this API interactively in our Swagger documentation.

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.