Skip to main content
POST
Build the unsigned close transactions for a resolved plan.

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
required

Destination for the recovered XLM (G...).

Example:

"GDEF...UVW"

decisions
object[]

Resolved decision answers; every balance-bearing asset must have a disposition.

memo
string

Deposit memo value for exchange destinations that require one. The memo type is taken from the exchange registry, not the client.

Example:

"1234567890"

Response

Unsigned transaction envelopes ready for client signing.

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
transactions
object[]
required
remaining
object
required