Effortless customer verification now available   View changelog →
Sphere Paysphere
Bank Account

List Bank Accounts

List all bank accounts for a customer with pagination

GET
/v2/bank-account

Authorization

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 by customer ID

Response Body

curl -X GET "https://api.spherepay.co/v2/bank-account?page=1&limit=10&customerId=customer_66c4168d418a410eae282b83883bdc39"
{
  "data": [
    {
      "id": "bankAccount_ce745ef7f3df4b9a8bff1301ce24b045",
      "status": "active",
      "bankName": "Chase Bank",
      "accountName": "Checking Account",
      "customerId": "customer_66c4168d418a410eae282b83883bdc39",
      "created": "2025-01-01T00:00:00Z",
      "updated": "2025-01-01T00:00:00Z",
      "currency": "usd",
      "accountDetails": {
        "accountNumber": "****7890",
        "routingNumber": "021000021",
        "accountType": "checking"
      },
      "accountOwner": {
        "accountHolderName": "John Doe",
        "relationship": "self"
      },
      "networks": [
        "wire",
        "ach"
      ]
    }
  ],
  "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"
    }
  ]
}