API Reference
  1. Close Loan
  2. Sub-account Close Loan with AUD

Request close loan with AUD (sub-account)

post
https://{domain}/api/sub-account/loans//close/fiat

This request will close the loan and unlock the security after reckoning.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the loan.

Body Params
string | null
enum
Defaults to NOT_SUPPLIED

Whether the funds were already supplied or not. Please note that if the funds are not provided by reckoning, the operation will be canceled, not postponed. BlockEarner makes the best effort trying to avoid the cancellation by processing this type of operations first. But if the cancellation still happens, you will be notified via a dedicated webhook and can resubmit the operation under fresh terms, reusing the same 'closeLoanExternalTransactionId' if needed.

Allowed:
string | null
deprecated

[DEPRECATED] Transaction ID in your external system for cross-referencing and idempotency.
This field is deprecated. Use 'repayExternalTransactionId' and 'closeLoanExternalTransactionId' instead.
When provided without the new fields, this ID will be assigned to the SECURITY_REPAY transaction only.
The new fields take precedence if both are provided.

string | null

Transaction ID for SECURITY_REPAY in your external system for cross-referencing and idempotency.

string | null

Transaction ID for CLOSE_LOAN in your external system for cross-referencing and idempotency.

Headers
string
required
length between 0 and 36

A unique client-generated identifier for idempotency. Prevents duplicate requests if the same ID is used more than once.

uuid
required

Sub-account ID.

string
required

SHA-256 signature of the JSON payload and private key. See API Key Authentication

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 4 months ago

Did this page help you?