HomeGuidesAPI Reference
API Reference

Bind Ledger

post
https://example.com/ledger/bind

Define a new ledger integration

Body Params
string
required

Unique identifier for the ledger name. This value must be unique across all ledger bindings

string
required

Ledger adapter address in host:port format

auth
array

List of authentication mechanisms supported by this ledger

auth
idempotency
object

Idempotency configuration to prevent duplicate request processing

string

A human-readable name for the ledger that appears in user interfaces

string
required
length ≥ 1

The maximum time allowed for the entire request operation to complete, including all retry attempts. After this duration, the request will fail with a timeout error

string
required
length ≥ 1

The waiting period between consecutive retry attempts when a request fails. This delay helps prevent overwhelming the ledger adapter during temporary failures

string
required
length ≥ 1

The maximum time allowed for each individual request attempt. If a single attempt exceeds this duration, it will be retried according to the backoff configuration

boolean
Defaults to true

Indicates whether balance synchronization is enabled for this ledger

Responses
200

successful operation

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago