Create an XLM create claimable balance request

post

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

This endpoint creates a create claimable balance requests for an XLM claimant address.
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

amount

string

required

Amount in the smallest currency unit, based on the currency decimals. For example, 1 corresponds to 1 'stroop' (one ten-millionth of XLM), and 1 XLM corresponds to 10000000 (7 decimals)

feeLimit

string

fromAddressId

string

fromWalletId

string

toAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

toWhitelistedAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

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

destinationAddressMemo

string

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

absoluteTimeBefore

string

A relative deadline for when the claimable balance can be claimed. The value represents the number of seconds since the close time of the ledger which created the claimable balance.

relativeTimeBefore

string

Unix epoch representing a deadline for when the claimable balance can be claimed. If the balance is claimed before the date then this clause of the condition is satisfied. Example: 1603303504267

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.