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>'
import requests

url = "https://api.spherepay.co/v2/bank-account/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.spherepay.co/v2/bank-account/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spherepay.co/v2/bank-account/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.spherepay.co/v2/bank-account/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.spherepay.co/v2/bank-account/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.spherepay.co/v2/bank-account/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "bankAccount_ce745ef7f3df4b9a8bff1301ce24b045",
  "status": "active",
  "customerId": "customer_66c4168d418a410eae282b83883bdc39",
  "created": "2025-01-01T00:00:00Z",
  "updated": "2025-01-01T00:00:00Z",
  "bankName": "Bank of America",
  "accountName": "Checking Account",
  "currency": "usd",
  "accountDetails": {
    "accountNumber": "****7890",
    "routingNumber": "021000021",
    "accountType": "checking"
  },
  "accountOwner": {
    "accountHolderName": "John Doe",
    "relationship": "self"
  },
  "networks": [
    "wire",
    "ach"
  ]
}
{
"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"
}
]
}
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"

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"

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"

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. For ACH/Wire: accountNumber, routingNumber, accountType. For SWIFT: accountNumber (masked), bic.

accountOwner
object
obrigatório

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

networks
obrigatório

The payment networks supported by this bank account. For USD ACH/Wire accounts, includes at least one of "ach" or "wire". For USD SWIFT accounts, is exactly ["swift"].

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