post
https://bank.sandbox.cybrid.app/api/external_wallets
Create an ExternalWallet.
Wallet creation
External Wallets can be created for a Bank or a Customer.
To create a wallet for your Bank, omit the customer_guid parameter in the request body. To create a wallet for your Customers, include the customer_guid parameter in the request body.
State
| State | Description |
|---|---|
| storing | The Platform is storing the external wallet details in our private store |
| pending | The Platform is waiting for the external wallet to be created |
| reviewing | The Platform is reviewing the external wallet for compliance |
| completed | The Platform has created the external wallet |
| failed | The Platform was not able to successfully create the external wallet |
| deleting | The Platform is deleting the external wallet |
| deleted | The Platform has deleted the external wallet |
Failure Codes
| Code | Description |
|---|---|
| invalid_address | The provided wallet address is invalid |
| prohibited_address | The provided wallet address failed screening |
External wallets can be added to the bank by leaving the customer_guid blank. External wallets added to the bank can be used by any customer of the bank.
External wallets can also be added to a specific customer by providing the customer_guid. External wallets added to a customer can only be used by that customer.
Required scope: external_wallets:execute