API Reference

Addresses

Generate dedicated deposit addresses for your customers. Each address is a muxed account derived off-chain from your master wallet — instant and free.

Create an address

POST/v1/wallets/:id/addresses

Body (all optional):

Field	Type	Description
customer_ref	string	Your own reference for the user. Echoed in webhooks.
metadata	object	Arbitrary JSON echoed back in webhooks for reconciliation.

Request

curl -X POST http://localhost:8080/v1/wallets/<WALLET_ID>/addresses \
  -H "authorization: Bearer octo_sk_test_ab12…" \
  -H "content-type: application/json" \
  -d '{ "customer_ref": "user_42", "metadata": { "plan": "pro" } }'

Response (201)

{
  "statusCode": 201,
  "message": "Created",
  "data": {
    "id": "8d22…",
    "muxed_address": "MA7…",
    "base_address": "GBYK…",
    "memo_id": 7,
    "customer_ref": "user_42",
    "metadata": { "plan": "pro" }
  }
}

List addresses

GET/v1/wallets/:id/addresses

Request

curl http://localhost:8080/v1/wallets/<WALLET_ID>/addresses \
  -H "authorization: Bearer octo_sk_test_ab12…"

Returns an array of address objects (same shape as above), most recent first.