Skip to main content

SerializedActionSendToAddressTx

Destination payment target for a SendToAddress action.

typestringrequired

Possible values: [BOLT11_PAYMENT_REQUEST, BITCOIN_ADDRESS]

addressstringrequired
hyperlinkstringrequired
amount objectrequired

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

SerializedActionSendToAddressTx
{
"type": "BOLT11_PAYMENT_REQUEST",
"address": "string",
"hyperlink": "string",
"amount": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
}
}