For AI agents: visit https://docs.blockearner.com.au/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Block Earner API Documentation
API ReferenceChangelog
Log InBlock Earner API Documentation
API Reference
Log In
StagingAPI ReferenceChangelog

Getting Started

  • Overview
  • Authentication
  • Endpoint Overview

Use Case

  • Create Loan Application for Entity

Account Management

  • Account Management Overview
  • Main Account Deposit
    • Get deposit bank details (main account)get
    • Get deposit PayID (main account)get
    • Get crypto deposit wallet (main account)get
  • Main Account Withdrawal
    • Get withdrawal details (main account)get
    • Request fiat withdrawal (main account)post
    • Request crypto withdrawal (main account)post
    • Delete withdrawal detail (main account)del
  • Main Account Balance
    • Get fiat balance (main account)get
    • Get crypto balances (main account)get
    • Get crypto balance (main account)get
  • Main Account Health
    • Get health (main account)get
    • Retrieve the crypto float balance for the main account.get
  • Sub-account Management
    • Create sub-account (main account)post
    • Get all sub-accounts (main account)get
    • Delete a sub-account (main account)del
    • Perform a credit check on a sub-accountpost
    • Retrieve the latest credit check for a sub-accountget
  • Sub-account Balance
    • Get fiat balance summary (sub-account)get
    • Get crypto balance summary (sub-account)get
    • Get crypto balance (sub-account)get

Loan Calculator

  • Explain Loan Offer
  • Main Account Loan Calculator
  • Get price estimation (main account)get
  • Main Account Loan Offers
    • Get loan offers (main-account)get
    • Get fiat borrow limits (main-account)post
    • Get projected repayment schedule (main-account)post
    • Get projected interest (main-account)post

Loan Application

  • Loan Application Overview
  • Sub-account Loan Application
    • Get price estimation (sub-account)get
    • Get loan offers (sub-account)get
    • Get projected total interest (sub-account)post
    • Get fiat borrow limits (sub-account)post
    • Get projected repayment schedule (sub-account)post
    • Preview loan application agreement (sub-account)post
    • Get document upload link (sub-account)get
    • Create a loan application (sub-account)post
    • Update a loan application (sub-account)patch
    • Get loan applications(sub-account)get
    • Update application intentionpatch
    • Withdraw loan application (sub-account)post
  • Sub-account Loan Display
    • Get loans (sub-account)get
    • Get loan information (sub-account)get
    • Get loan agreements (sub-account)get
  • Get loans (main account)get

Security Management

  • Security Management Overview
  • Sub-account Security Top Up
    • Preview top up security (sub-account)post
    • Request top up security (sub-account)post
  • Sub-account Security Withdrawal
    • Preview withdraw security (sub-account)post
    • Request withdraw security (sub-account)post

Loan Repayment

  • Loan Repayment Overview
  • Get repayment schedule (sub-account)get
  • Sub-account Repay with AUD
    • Preview fiat repayment (sub-account)post
    • Request fiat repayment (sub-account)post
  • Sub-account Repay with security
    • Preview security repayment (sub-account)post
    • Request security repayment (sub-account)post

Redraw Application

  • Redraw Application Overview
  • Sub-account Loan Redraw
    • Calculate projected interest (sub-account)post
    • Preview redraw loan agreement (sub-account)post
    • Preview redraw application (sub-account)post
    • Create redraw application (sub-account)post
    • Get redraw applications (sub-account)get

Close Loan

  • Close Loan Overview
  • Sub-account Close Loan with AUD
    • Preview close loan with AUD (sub-account)post
    • Request close loan with AUD (sub-account)post
  • Sub-account Close Loan with Security
    • Preview close loan with security (sub-account)post
    • Request close loan with security (sub-account)post

Rollover

  • Rollover Overview
  • Sub-account Loan Rollover
    • Preview rollover loan agreement (sub-account)post
    • Preview rollover application (sub-account)post
    • Create rollover application (sub-account)post

Webhooks

  • Webhooks Guide
  • Webhook Management
    • Subscribe to a webhookpost
    • Get all webhook subscriptionsget
    • Get webhook details by subscription IDget
    • Delete webhook subscriptiondel
    • Testing Webhookpost
    • Retry Webhookpost
    • Search webhook executionsget
  • Webhooks
    • Fiat Deposit Receivedpost
    • Crypto Deposit Receivedpost
    • Loan Application Status Updatepost
    • Redraw Application Status Updatepost
    • Rollover Application Status Updatepost
    • Loan Health Status Updatepost
    • Loan Updatepost
    • Loan Default Statuspost
    • Cash Repayment Confirmedpost
    • Security Top Up Confirmedpost
    • Pre-Reckoning Reportpost
    • Post-Reckoning Reportpost
    • Insufficient Fiat Balancepost
    • Insufficient Crypto Balancepost
    • Automatic repayment occurredpost

Other

  • Allowed Actions
  • Reckoning
  • Get loan history (main account)post
  • Get loan history (sub-account)post
  • Link loan transactions with an external IDpatch
Powered by 
  1. Getting Started

Endpoint Overview

📘

Swagger Documentation

EnvironmentURL
Staginghttps://api.stg.blockearner.com.au/api/api-docs/blockearner-whitelabel-openapi.json
Productionhttps://api.blockearner.com.au/api/api-docs/blockearner-whitelabel-openapi.json

Updated 4 months ago


Authentication
Create Loan Application for Entity
Did this page help you?

Updated 4 months ago


Authentication
Create Loan Application for Entity
Did this page help you?