Reserve settlement advance credit
Holds credit so the maker can lock in a fee snapshot before requesting the settlement advance. Reservations expire after a short window (~15 minutes); after expiry the maker must reserve again.
Replaying the same idempotencyKey returns the existing reservation.
Submitting a different idempotencyKey while another reservation for
the same currency is still active will be rejected — the maker must
cancel the active reservation first before creating a new one. There
is one active reservation allowed per currency.
A reservation is automatically cancelled after a single settlement advance is made against it.
Calling /reserve is optional; the maker may skip it and go straight
to requesting the settlement advance.
Authorizations
Body
Request body for reserving settlement advance credit.
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.
"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
Response
Reservation created or existing reservation returned on idempotent replay.
Settlement advance reservation.
Status of a settlement advance reservation.
active-- reservation is live; holds available-balance capacity on the credit line.expired-- reservation window elapsed without an origination claiming it; terminal state.consumed-- origination claimed this reservation; terminal state.canceled-- reservation voided by admin or system action; terminal state.
active, expired, consumed, canceled "active"