Create an XLM CAP-33 sponsored-reserve request

post

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xlm/reserve-sponsorship

Creates a CAP-33 sponsored-reserve XLM operation where the fee-source address sponsors the account reserve and pays the fee. The operation is one of the operation oneof branches.
Required role: RequestCreator.
Idempotent via externalRequestId.

Body Params

Creates a CAP-33 sponsored-reserve XLM operation where the fee-source address sponsors the account reserve and pays the fee. The changeTrust operation must be set.

feeSourceAddressId

string

required

ID of the XLM address that sponsors the reserve and pays the outer fee. Must be governed by an XLM_ReserveSponsor rule line.

outerMaxFee

string

Absolute cap on the outer fee in stroops, as a decimal string.

sponsoreeSignature

string

required

Raw 64-byte ed25519 signature the sponsoree produced over the inner transaction hash.

comment

string

Optional reconciliation note included in transaction history.

externalRequestId

string

Caller-supplied idempotency key. Repeats with the same id return the original request unchanged.

changeTrust

object

createAccount

object

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.