Create an XLM revoke sponsorship request

post

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

This endpoint creates an XLM revoke sponsorship request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Body Params

Creates an XLM Revoke Sponsorship Request. If toAddressId or toWhitelistedAddressIdis set, only one betweendataName, assetIDandofferIDcan be set. If not,claimableBalanceID` shall be set.

fromAddressId

string

required

toAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

toWhitelistedAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

destinationAddressMemo

string

A memo can be specified if the destination is a whitelisted address on a blockchain supporting memos.

claimableBalanceID

string

dataName

string

currencyID

string

Taurus-PROTECT Currency ID of the Whitelisted Contract Asset representing the XLM Asset for which the trustline is being revoked.

feeLimit

string

comment

string

externalRequestId

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

sponsoredByAddressId

string

If set, is the ID of the address who will sponsor the cost of the operation on the minimum balance of the source address

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.