Create Bank Account
POST
https://api.sfox.com/v1/user/bank
Link an end user's bank account to their sFOX account.
Request
Body Parameters
type required
string
Whether the bank account is for an individual or corporation. Possible values:
individual or corporate
bankAccountType required
string
Whether the bank account is a checking or savings account. Possible values: checking or savings
isInternational required
boolean
If the bank account is from an international bank. (US = False, International = True)
accountnumber required
string
Account number of the bank account.
routingnumber
string
Routing number of the bank. Required if isInternational = False
swiftnumber
string
SWIFT number of the bank. Required if isInternational = True
enableWires required
boolean
Whether the bank account is enabled to process wire transfers.
firstname required
string
First name on bank account.
If type = corporate, specify the first name of the person who is the primary owner of the account.
lastname required
string
Last name on bank account.
If type = corporate, specify the last name of the person who is the primary owner of the account.
name
string
Name of the business on the bank account. Required if type = corporate
bankCurrency
string
Currency code that the bank account transacts in. e.g. usd
bankname
string
Name of the bank. Required if isInternational = True
wireInstructions
string
Memo/correspondent bank/for further credit. Only applicable if isInternational = True
wireRoutingnumber
string
Routing number for wire transactions. Required if isInternational = False
Example Requests
curl -X POST \
-H 'Content-type: application/json' \
-H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
--data '{ "accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"enableWires": true,
"firstname": "Sean",
"isInternational": false,
"lastname": "Fox",
"name": "Sean Fox",
"routingnumber": "987654321",
"type": "individual",
"wireRoutingnumber": "987654321" }' \
'https://api.sfox.com/v1/user/bank'const axios = require('axios');
const data = JSON.stringify({
accountnumber: '123456789',
bankAccountType: 'checking',
bankCurrency: 'usd',
enableWires: true,
firstname: 'Sean',
isInternational: false,
lastname: 'Fox',
name: 'Sean Fox',
routingnumber: '987654321',
type: 'individual',
wireRoutingnumber: '987654321'
}
)
const config = {
method: 'post',
url: 'https://api.sfox.com/v1/user/bank',
headers: {
"Content-Type": "application/json",
'Authorization': `Bearer ${process.env.USER_AUTH_TOKEN}`
},
data: data
}
axios(config)
.then((response) => {
console.log(response.status)
console.log(response.data)
})
.catch(err => {
console.error(err.response.status)
console.error(err.response.data)
});import requests
import os
data = requests.post(
"https://api.sfox.com/v1/user/bank",
headers={
"Authorization": f"Bearer {os.environ['USER_AUTH_TOKEN']}"
},
json={
"accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"enableWires": true,
"firstname": "Sean",
"isInternational": false,
"lastname": "Fox",
"name": "Sean Fox",
"routingnumber": "987654321",
"type": "individual",
"wireRoutingnumber": "987654321"
}
)
print(data.status_code)
print(data.json())Request Body Examples
{
"accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"enableWires": true,
"firstname": "Sean",
"isInternational": false,
"lastname": "Fox",
"name": "Sean Fox",
"routingnumber": "987654321",
"type": "individual",
"wireRoutingnumber": "987654321"
}{
"accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"bankname": "BCB Group",
"enableWires": true,
"firstname": "Sean",
"isInternational": true,
"lastname": "Fox",
"name": "Sean Fox",
"swiftnumber": "987654321",
"type": "individual",
"wireInstructions": ""
}{
"accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"enableWires": true,
"firstname": "Sean",
"isInternational": false,
"lastname": "Fox",
"name": "Example Fund LP",
"routingnumber": "987654321",
"type": "corporate",
"wireRoutingnumber": "987654321"
}{
"accountnumber": "123456789",
"bankAccountType": "checking",
"bankCurrency": "usd",
"bankname": "BCB Group",
"enableWires": true,
"firstname": "Sean",
"isInternational": true,
"lastname": "Fox",
"name": "Sean Fox Hedge Fund",
"swiftnumber": "987654321",
"type": "corporate",
"wireInstructions": ""
}Responses
Last updated