sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
On this page
  • Request
  • Example Requests
  • Response
  • Response Body
  • Responses
  1. REST API
  2. Payments

Get Bank Account

PreviousCreate Bank AccountNextGet Plaid Processors

Last updated 1 day ago

GET

https://api.sfox.com/v1/user/bank

Returns the account's currently linked bank account information and status.


Request

Authentication: This endpoint requires a for authentication. Requests using your Connect API Key will be rejected.

Example Requests

curl -X GET \
-H "Authorization: Bearer ${USER_AUTH_TOKEN}"  \
'https://api.sfox.com/v1/user/bank'
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.sfox.com/v1/user/bank',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.USER_AUTH_TOKEN}`
  }
}

axios(config)
  .then((response) => {
    console.log(response.status)
    console.log(respones.data)
  })
  .catch(err => {
    console.error(err.response.status)
    console.error(err.response.data)
  });
import requests
import os

data = requests.get(
  "https://api.sfox.com/v1/user/bank",
  headers={
    "Authorization": f"Bearer {os.environ['USER_AUTH_TOKEN']}"
  }
)
print(data.status_code)
print(data.json())

Response

Response Body

Key
Description
Example Value

id

Encrypted internal sFOX bank account ID

156c5beb-7c9f-4f68-83c0-9479703ac490

status

The status of the bank account

active

requires_verification

Whether or not the bank account requires additional verification

0

requires_support

Whether or not the bank account requires additional support

0

routing_number

Routing number of the bank account

*****1533

account_number

Account number of the bank account

**************00

ach_enabled

Whether the status is able to process ACH transaction

true

international_bank

Whether the bank location is international or domestic

false

name1

Name on bank account

Sean Fox

currency

Currency of the bank account

usd

type

Checking or Savings

checking

bank_name

Name of the bank

CITIZENS BANK NA

ref_id

Reference ID of the bank to be included in the memo of wire deposits

k34g8

Responses

200: OK
{
    "usd": [
        {
            "id": "fbb2a1e4-b21a-11ed-902c-0e5724aafd6b",
            "status": "active",
            "requires_verification": 0,
            "requires_support": 0,
            "routing_number": "*****4321",
            "account_number": "*******89",
            "name1": "Sean Fox",
            "currency": "usd",
            "type": "checking",
            "bank_name": "BCB Group",
            "ref_id": "j47LK"
        }
    ]
}
User Auth Token