Documentation Index Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt
Use this file to discover all available pages before exploring further.
Use this endpoint to retrieve a paginated list of all bank accounts registered in your SpherePay account. You can optionally filter results by customer ID to fetch only the accounts belonging to a specific customer. Results are returned in descending order of creation time.
Endpoint GET https://api.spherepay.co/v2/bank-account
Authentication All requests require a Bearer token in the Authorization header.
Authorization: Bearer <token>
Query parameters Page number to retrieve. Defaults to "1".
Number of bank accounts to return per page. Defaults to "10".
Filter results to only bank accounts belonging to the specified customer ID.
-H "Authorization: Bearer $SPHERE_API_KEY "
Response fields Array of bank account objects. Unique identifier for the bank account.
Account status (e.g., "active").
Name of the financial institution.
Descriptive label for the account.
ID of the customer who owns this account.
Currency code: "usd", "eur", or "brl".
Masked account details specific to the account’s currency.
Account holder name and relationship.
Payment networks registered for this account.
ISO 8601 timestamp of when the account was registered.
ISO 8601 timestamp of the most recent update.
Pagination metadata. Number of items per page.
Total number of bank accounts matching the query.
Whether a next page exists.
Whether a previous page exists.
"data" : [ { "id" : "bankAccount_ce745ef7f3df4b9a8bff1301ce24b045" , "status" : "active" , "bankName" : "Chase" , "accountName" : "Jane Doe Checking" , "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" : "Jane Doe" , "relationship" : "self" }, "networks" : [ "ach" , "wire" ] } ], "pagination" : { "page" : 1 , "limit" : 10 , "total" : 1 , "totalPages" : 1 , "hasNext" : false , "hasPrevious" : false } }
Error responses Status Code Description 400address/invalidOne or more query parameters are invalid. 404resource/not-foundThe specified customer ID does not exist. 422validation/failedValidation failed. The response includes a per-field errors array.
