Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Building a Child Address Withdrawal Wallet

Before integrating the deposit and withdrawal APIs, complete the following steps first.
  1. Sign up
  2. Create a wallet
  3. Issue an API token
  4. Register API call IPs

Generally, a child address withdrawal wallet is built as follows. Other features can be implemented in various ways depending on the type of service.


Building a child address system​

Creating child addresses​

Creates addresses to be issued to end users. Generally, one child address is issued to each end user. Child addresses are created by calling the API, and you can check the list of issued child addresses on the console.

Managing child address balances​

You can check the balance of each child address by calling the Get Address Balance API.

👀

Most platforms have the same child address structure, but the child address structure may differ depending on the platform, so refer to the detailed guide for each platform.


Building a deposit system​

Adding tokens​

Octet only processes deposits of registered tokens. Therefore, before depositing a token, you must add that token to the wallet.

  • You can add tokens in [Wallet Settings] - [Token Management].
  • If the token you want is not in the list, you can request a new token on the [Request New Token Registration] page at the top right.

Checking for deposits​

1. Checking from the console​

You can check deposits in [Transactions] on the console. Deposits in the UNFINALIZED status are displayed as 'In progress', and deposits in the FINALIZED status are displayed as 'Completed'.

2. Checking with webhooks​

When a deposit to the main address or a child address is completed, a deposit webhook is sent. You can check whether the deposit was made from the webhook you receive. For how to use webhooks and the format of the data sent, see the Webhook page.


Building a withdrawal system​

Withdrawing from a child address​

Withdraws the assets held in a child address to the outside. You can request a withdrawal by calling the Child Address Withdrawal Request API.

Withdrawing from the main address​

Withdraws the assets held in the main address to the outside. You can request a withdrawal by calling the Request Withdrawal API or from the console.

Setting up withdrawal approval​

By default, all withdrawals proceed after being approved by an administrator. However, this setting can be disabled for API withdrawals, in which case the withdrawal proceeds as soon as it is requested.

  • API withdrawal - Administrator approval can be disabled.
  • Console withdrawal - Administrator approval is required.

Withdrawing​

Call the Request Withdrawal API to request a withdrawal from the main address to the outside. If the withdrawal request succeeds, a uuid value is returned. You can use this value to check the withdrawal progress.

Response example

{
"uuid": "18012e3f-07f3-45ec-862b-f020c0ca935a"
}


Checking withdrawal completion​

1. Checking from the console​

You can check withdrawals in [Transactions] on the console. Withdrawals in the AWAITING_WITHDRAWAL and PENDING statuses are displayed as 'In progress', and withdrawals in the FINALIZED status are displayed as 'Completed'.

2. Checking with the API​

Call the Get Withdrawal Request Information API to check the progress of a specific withdrawal transaction.

Response example

{
"idx": 490,
"uuid": "07efdcb2-b3fd-4fe7-bf47-c0b460b289e3",
"fromAddress": "0x71b5De2970A32eEf6362AE7Bc3B73103b4392bB0",
"toAddress": "0x295909dC67B76f936BD4119aDd877088602cCaD3",
"amount": "2.00000000000000000000",
"memo": null,
"requestId": "25",
"type": "API",
"description": "",
"requiredApprovalCount": 1,
"useApiAutoApproval": true,
"status": "SENT",
"createdDate": "2022-01-25T09:25:02.383Z",
"modifiedDate": "2022-01-25T09:25:10.000Z",
"rejectedDate": null
}

3. Checking with webhooks​

When a withdrawal from the main address to the outside is completed, a withdrawal webhook is sent. You can check whether the withdrawal was made from the webhook you receive. For how to use webhooks and the format of the data sent, see the Webhook page.