Skip to main content
POST
Build a deterministic close plan with decision points and estimates.

Authorizations

Authorization
string
header
required

Integrator API key

Path Parameters

network
enum<string>
required
Available options:
testnet,
mainnet

Body

application/json
source
string
required

Account to close (G...).

Example:

"GABC...XYZ"

destination
string

Destination for the recovered XLM (G...). Omit to preview without a destination.

Example:

"GDEF...UVW"

decisions
object[]

Answers to the plan's decision points (per-asset dispositions, etc.).

Response

Plan with pending decision points, fee and freed-reserve estimate.

planHash
string
required

Deterministic hash of this plan's content - unchanged inputs yield the same hash.

status
enum<string>
required
Available options:
ready,
needs_decisions,
blocked,
complete
steps
object[]
required
decisionPoints
object[]
required
blockers
object[]
required
estimate
object
required
execution
object
required