Get Bank Account

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 User Auth Token for authentication. Requests using your Connect API Key will be rejected.

Example Requests

Shell

curl -X GET \
-H "Authorization: Bearer ${USER_AUTH_TOKEN}"  \
'https://api.sfox.com/v1/user/bank'

NodeJS

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)
  });

Python

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