Pular para o conteúdo principal
Create a Bank Account
curl --request POST \
  --url https://api.spherepay.co/v2/bank-account \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "customer_66c4168d418a410eae282b83883bdc39",
  "bankName": "Chase",
  "accountName": "Jane Doe Checking",
  "currency": "usd",
  "accountDetails": {
    "accountNumber": "1234567890",
    "routingNumber": "021000021",
    "accountType": "checking"
  },
  "accountOwner": {
    "accountHolderName": "Jane Doe",
    "address": {
      "line1": "233 South Wacker Drive",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60606",
      "country": "USA"
    }
  },
  "networks": [
    "ach",
    "wire"
  ]
}
'
{
  "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 registrar a conta bancária fiat existente de um cliente no SpherePay. O SpherePay não abre nem gerencia contas bancárias — ele vincula uma conta que seu cliente já possui ao perfil do SpherePay para que possa ser usada como origem ou destino em transferências fiat. Você deve registrar pelo menos uma conta bancária (bank_account) antes de criar uma transferência que envolva moeda fiat. O cliente deve ter pelo menos um perfil de verificação aprovado antes que você possa registrar uma conta bancária em seu nome.

Autorizações

​
Authorization
string
header
obrigatório

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

Corpo

application/json
​
customerId
string
obrigatório

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

Minimum string length: 1
Exemplo:

"customer_66c4168d418a410eae282b83883bdc39"

​
bankName
string
obrigatório

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

Minimum string length: 1
Exemplo:

"Bank of America"

​
accountName
string
obrigatório

A descriptive name for this bank account (e.g., "Checking Account", "Business Account").

Minimum string length: 1
Exemplo:

"Checking Account"

​
currency
enum<string>
obrigatório

The currency of the bank account. When set to usd, accountDetails must contain accountNumber, routingNumber, and accountType.

Opções disponíveis:
usd
Exemplo:

"usd"

​
accountDetails
object
obrigatório

USD account details. Required fields: accountNumber, routingNumber, accountType.

​
accountOwner
object
obrigatório

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

​
networks
enum<string>[]
obrigatório

The payment networks supported by this bank account. For USD accounts, must include at least one of "ach" or "wire" (specify both wire and ach if unsure).

Minimum array length: 1
Opções disponíveis:
ach,
wire
Exemplo:
["wire", "ach"]

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