Pular para o conteúdo principal
Get a Bank Account
curl --request GET \
  --url https://api.spherepay.co/v2/bank-account/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  ]
}
Use este endpoint para recuperar uma única conta bancária pelo seu ID. A resposta inclui detalhes mascarados da conta (como um número de conta parcialmente redigido), as redes de pagamento registradas para a conta e o ID do cliente proprietário.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

The bank account ID

Minimum string length: 1
Exemplo:

"bankAccount_ce745ef7f3df4b9a8bff1301ce24b045"

Resposta

id
string
obrigatório

The unique identifier of the bank account.

Exemplo:

"bankAccount_ce745ef7f3df4b9a8bff1301ce24b045"

status
enum<string>
obrigatório

The current status of the bank account.

Opções disponíveis:
pending,
active,
inactive,
invalid
Exemplo:

"active"

bankName
string
obrigatório

The name of the financial institution where the account is held.

Exemplo:

"Bank of America"

accountName
string
obrigatório

A descriptive name for this bank account.

Exemplo:

"Checking Account"

customerId
string
obrigatório

The unique identifier of the customer who owns this bank account.

Exemplo:

"customer_66c4168d418a410eae282b83883bdc39"

created
string
obrigatório

The ISO 8601 timestamp when the bank account was created.

Exemplo:

"2025-01-01T00:00:00Z"

updated
string
obrigatório

The ISO 8601 timestamp when the bank account was last updated.

Exemplo:

"2025-01-01T00:00:00Z"

currency
enum<string>
obrigatório

The currency of the bank account.

Opções disponíveis:
usd
Exemplo:

"usd"

accountDetails
object
obrigatório

USD account details including accountNumber, routingNumber, and accountType.

accountOwner
object
obrigatório

Information about the account owner, including their name and relationship to the customer.

networks
enum<string>[]
obrigatório

The payment networks supported by this bank account. For USD accounts, includes at least one of "ach" or "wire".

Opções disponíveis:
ach,
wire
Exemplo:
["wire", "ach"]
Última modificação em 18 de junho de 2026