Skip to main content

Memos

Some blockchain networks require a memo or tag field for transactions — for example, Cosmos, Stellar, and Ripple use memos to route deposits to the correct recipient at a shared address.

When Memos Are Needed

NetworkMemo FieldFormatMax Length
CosmosMemoFree text256 characters
StellarMemo (text)Free text28 characters
StellarMemo (id)Unsigned integer64-bit integer
RippleDestination TagUnsigned integer32-bit integer (0–4294967295)
TONMemoFree text or integer127 characters

Create a Memo

You can either provide your own memo value or let the platform generate one automatically.

With a custom memo

curl -X POST \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"addressId": "gMP71sR5sNUnGdKFTsNzp6",
"memo": "customer-12345",
"name": "Customer Deposit Memo"
}' \
https://api.carabaas.com/api/v1/memos

Auto-generated memo

Omit the memo field — the platform generates a unique value automatically:

curl -X POST \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"addressId": "gMP71sR5sNUnGdKFTsNzp6",
"name": "Customer Deposit Memo"
}' \
https://api.carabaas.com/api/v1/memos

The generated memo is returned in the response and is unique within the address.

Returns 200 if the memo already exists, 201 if newly created.

tip

For Ripple destination tags, use numeric strings (e.g., "memo": "123456"). For Cosmos and Stellar, any text within the character limit works.

List Memos

curl -H "Authorization: Bearer $TOKEN" \
https://api.carabaas.com/api/v1/memos

Get Memo Details

curl -H "Authorization: Bearer $TOKEN" \
https://api.carabaas.com/api/v1/memos/{memoId}

Update a Memo

curl -X PATCH \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "Updated Memo Name" }' \
https://api.carabaas.com/api/v1/memos/{memoId}

See Also