Retrieve a Bank Account by ID

Use this endpoint to retrieve a single bank account by its ID. The response includes masked account details (such as a partially redacted account number), the payment networks registered for the account, and the ID of the owning customer.

Endpoint

GET https://api.spherepay.co/v2/bank-account/{id}

Authentication

All requests require a Bearer token in the Authorization header.

Authorization: Bearer <token>

Path parameters

string

required

The bank account ID returned when the account was registered (e.g., "bankAccount_ce745ef7f3df4b9a8bff1301ce24b045").

  -H "Authorization: Bearer $SPHERE_API_KEY"

Response fields

string

Unique identifier for the bank account.

status

string

Account status (e.g., "active").

bankName

string

Name of the financial institution.

accountName

string

Descriptive label for the account.

customerId

string

ID of the customer who owns this account.

currency

string

Currency code: "usd", "eur", or "brl".

accountDetails

object

Masked account details. For USD accounts, contains accountNumber (partially redacted), routingNumber, and accountType. For EUR accounts, contains iban and bic. For BRL accounts, contains pixKey and pixKeyType.

accountOwner

object

Show properties

accountHolderName

string

Full legal name of the account holder.

relationship

string

Relationship of the account holder to the customer (e.g., "self").

networks

string[]

Payment networks registered for this account (e.g., ["ach", "wire"], ["sepa"], ["pix"]).

created

string

ISO 8601 timestamp of when the account was registered.

updated

string

ISO 8601 timestamp of the most recent update.

  "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"]
}

Error responses

Status	Code	Description
`400`	`address/invalid`	The request is malformed or the ID format is invalid.
`404`	`resource/not-found`	No bank account with the specified ID exists.
`422`	`validation/failed`	Validation failed. The response includes a per-field `errors` array.

​Endpoint

​Authentication

​Path parameters

​Response fields

​Error responses

Endpoint

Authentication

Path parameters

Response fields

Error responses