Offloader Wallets API now available  View changelog
Offloader Wallet

List offloader wallets

List all offloader wallets

GET
/v2/offloader-wallet
AuthorizationBearer <token>

In: header

Query Parameters

pagestring

Page number of the list (default: 1)

Default"1"
limitstring

Number of items per page (default: 10)

Default"10"
customerId?string

Filter offloader wallets by customer ID. Only wallets belonging to this customer will be returned.

Response Body

curl -X GET "https://api.spherepay.co/v2/offloader-wallet?page=1&limit=10&customerId=customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
{
  "data": [
    {
      "id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
      "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
      "address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
      "currency": "usdc",
      "network": "ethereum",
      "destination": {
        "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
        "currency": "usd",
        "network": "ach",
        "achReference": "REF123"
      },
      "fees": {
        "integratorFee": {
          "bpsRate": "100",
          "currency": "usdc"
        },
        "platformFee": {
          "bpsRate": "30",
          "currency": "usdc"
        }
      },
      "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
      "created": "2024-06-15T10:30:00.000Z",
      "updated": "2024-06-15T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}