Request ACH Onboarding

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 agreements, 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 Banking section of this documentation for details regarding linking and managing users' bank accounts.

Request

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

Body Parameters

Name

Type

Description

bank_account_display_id required

string

The id parameter of the user's linked bank account

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

PreviousGet ACH Agreement Status NextGet ACH Deposit Limit

Last updated 5 months ago