Bind Ledger

post

https://example.com/ledger/bind

Define a new ledger integration

Body Params

name

string

required

.*\S.*

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

endpoint

string

required

.*\S.*

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

retryStrategy

object

Per-binding retry policy for the external adapter's WORKFLOW-layer handling of transient (technical) errors. When omitted, the service falls back to the global retry defaults (prior behavior). transientErrorsMaxRetries and transientErrorsUnlimitedRetries are mutually exclusive; set at most one.

displayName

string

.*\S.*

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

requestTimeout

string

required

length ≥ 1

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

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

backoff

string

required

length ≥ 1

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

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

singleRequestTimeout

string

required

length ≥ 1

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

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

balanceSyncAllowed

boolean

Defaults to true

Indicates whether balance synchronization is enabled for this ledger

Responses

200

successful operation

400Bad Request

500Internal Server Error