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
  • Body Parameters
  • Example Requests
  • Response
  • Responses
  1. REST API
  2. Payments

Request ACH Onboarding

PreviousGet ACH Agreement StatusNextGet ACH Deposit Limit

Last updated 1 day ago

POST

https://api.sfox.com/v1/account/onboard-ach

Initiate the process of enabling ACH transfers for a user by onboarding a user with a linked bank account to Dwolla. "Onboarding" consists of recording the user's acceptance of the , if applicable, and creating a Dwolla profile for the user.


The user must have a bank account linked to their sFOX account in order to initiate the request. Refer to the section of this documentation for details regarding linking and managing users' bank accounts.

Request

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

Body Parameters

Name
Type
Description

bank_account_display_id required

string

Example Requests

curl -X POST \
-H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
-H "Content-Type: application/json" \
-data '{"bank_account_display_id": "${BANK_ACCOUNT_DISPLAY_ID}"}'
\ "https://api.sfox.com/v1/account/onboard-ach"
const axios = require('axios');
axios({
  method: 'post',
  url: 'https://api.sfox.com/v1/account/onboard-ach',
  headers: {
    'Authorization': 'Bearer <USER_AUTH_TOKEN>',
  },
  data: {
    bank_account_display_id: 'aksaNjjsfdbn123ksd91283n',
  }
}).then(response => {
  console.log(response);
}).catch(error => {
  console.error(err);
});
import requests

data = requests.post(
    "https://api.sfox.com/v1/account/onboard-ach",
    headers = {
        "Authorization": "Bearer <USER_AUTH_TOKEN>",
        },
        data {"bank_account_display_id": "askdnasidu123Nisund",
        }
    )
print (data)
    

Response

Responses

200 OK
//ACH onboarding completed successfully.
{
    "data": {
        "success": true 
    }
}

The id parameter of the user's

agreements
Banking
User Auth Token
linked bank account