Wallet API

The Wallet API allows you to manage your Routstr wallet, check your balance, add funds, and withdraw your remaining balance.

Base URL

https://api.routstr.com/v1/wallet

Authentication

All wallet endpoints require authentication with your Cashu token. Include it in the Authorization header:

Authorization: Bearer YOUR_CASHU_TOKEN

Endpoints

Get Account Information

GET /v1/wallet/

Retrieve information about your account, including your current balance.

Request Headers

HeaderDescription
AuthorizationBearer YOUR_CASHU_TOKEN

Example Request

curl -X GET https://api.routstr.com/v1/wallet/ \
  -H "Authorization: Bearer YOUR_CASHU_TOKEN"

Example Response

{
  "balance": 0.00045,
  "user_id": "user_123abc",
  "created_at": "2023-05-12T15:30:00Z",
  "stats": {
    "total_requests": 15,
    "total_tokens": 1250
  }
}

Add Funds to Your Wallet

POST /v1/wallet/topup

Add funds to your wallet using another Cashu token.

Request Parameters

ParameterTypeDescription
cashu_tokenstringThe Cashu token containing funds to add to your wallet

Request Headers

HeaderDescription
AuthorizationBearer YOUR_CASHU_TOKEN

Example Request

curl -X POST "https://api.routstr.com/v1/wallet/topup?cashu_token=cashuA1DkpNewToken..." \
  -H "Authorization: Bearer YOUR_CASHU_TOKEN"

Example Response

{
  "previous_balance": 0.00045,
  "added_amount": 0.0010,
  "new_balance": 0.00145,
  "status": "success"
}

Withdraw Your Balance

POST /v1/wallet/refund

Withdraw your remaining balance as a Cashu token.

Request Headers

HeaderDescription
AuthorizationBearer YOUR_CASHU_TOKEN

Example Request

curl -X POST https://api.routstr.com/v1/wallet/refund \
  -H "Authorization: Bearer YOUR_CASHU_TOKEN"

Example Response

{
  "previous_balance": 0.00145,
  "withdrawn_amount": 0.00145,
  "new_balance": 0,
  "cashu_token": "cashuA1DkpRefundToken...",
  "status": "success"
}

Error Handling

Status CodeDescription
401Unauthorized - Invalid Cashu token
402Payment Required - Insufficient funds
400Bad Request - Invalid request parameters
500Server Error - Something went wrong