Skip to navigation
TRANSFERS AND STAKINGRequests: XLM

Create an XLM create claimable balance request

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
amountstringRequired

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)

feeLimitstringOptional
fromAddressIdstringOptionalformat: "uint64"
fromWalletIdstringOptionalformat: "uint64"
toAddressIdstringOptionalformat: "uint64"
A destination should be specified. Either toAddressId or toWhitelistedAddressId.
toWhitelistedAddressIdstringOptionalformat: "uint64"
A destination should be specified. Either toAddressId or toWhitelistedAddressId.
commentstringOptional
externalRequestIdstringOptional
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
destinationAddressMemostringOptional
A memo can be specified if the destination is a whitelisted address on a blockchain supporting memos.
absoluteTimeBeforestringOptionalformat: "uint64"
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.
relativeTimeBeforestringOptionalformat: "uint64"

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

sponsoredByAddressIdstringOptionalformat: "uint64"
If set, is the ID of the address who will sponsor the cost of the operation on the minimum balance of the source address
feePayerIdstringOptionalformat: "uint64"

If set, the id of an XLM fee payer that will wrap this operation in a CAP-15 fee-bump. Inner tx fee is set to 0. Only supported for non-native (issued) assets.

Response

A successful response.
resultobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error