API Reference

Account Management Overview

Block Earner's white-label solution is managed through a Main Account and Sub-account structure. This structure is the foundation for integrating Block Earner's crypto-backed loan services. It gives businesses centralized control over deposits, withdrawals, and account creation, enabling seamless management of individual users under the business's umbrella.


📘

Main account KYC requirement

The business has been onboarded with Block Earner and all the KYC requirement has passed

Main Account

The main account serves as the primary account for the business and is responsible for the following functionalities:

1. Asset Management

  • AUD Deposits and withdrawals:
    • Retrieve an AUD deposit bank account or PayID
    • Create AUD withdrawal details
    • Initiate AUD withdrawal to a specified AUD withdrawal account.
  • Cryptocurrency deposit and withdrawals:
    • Retrieve address for crypto deposit
    • Withdraw cryptocurrencies to a specified wallet address.
❗️

Important Guidelines for Seamless Fund Flow

To ensure the seamless operation for fund flow, Block Earner strongly recommend the following:

  • AUD deposit : Block Earner uses a name match check for incoming AUD deposits. To avoid delays in crediting funds to your main account, we recommend making a small test deposit from the originating account before automating AUD transfers.
  • Crypto deposit: For businesses with a custom crypto custody setup, please provide the wallet address that will be used for deposits into the main account. This ensures the wallet address is monitored and deposits are credited promptly.
👩🏻‍💻

API for main account deposits

Deposit fiat to main account flow

Deposit crypto to main account flow

❗️

For crypto deposit into Block Earner main account, we would need to whitelist your deposit address. We will only be listening to your whitelisted address deposit and the deposit comes from other wallet address will be ignored

👩🏻‍💻

API for main account withdrawal

👩🏻‍💻

API for main account balance

2. Sub-account management

  • All sub-accounts operate under the umbrella of the main account.
  • Asset deposits and withdrawals can only occur through the main account.

Sub-account

The sub-account represents individual users managed by the business. Sub-accounts allow businesses to allocate and manage assets and loans for their users. Key features include:

1. Creation and Management

  • Businesses can create or remove sub-accounts under their main account to represent individual users.
ℹ️

Sub-account KYC requirement

Sub-accounts do not require individual KYC verification within the Block Earner API. It is assumed that the partner has already completed the necessary KYC processes for their users before creating sub-accounts under the main account.

2. Asset and Loan Management

  • Balances:
    • Each sub-account maintains its own cryptocurrency and AUD balances.
  • Loans:
    • Sub-accounts can apply for and manage loans independently.
  • Restrictions:
    • Sub-accounts cannot directly accept deposits or withdrawals of assets.
    • All deposit and withdrawal operations must flow through the main account.
Main and sub account structure

Main and sub-account structure


👩🏻‍💻

API for sub account management

👩🏻‍💻

API for sub account balance