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

Get Plaid Processors

PreviousGet Bank AccountNextAmend Plaid Processors

Last updated 1 day ago

GET

https://api.sfox.com/v1/bank-account/${BANK_ACCOUNT_ID}/plaid-processors

Retrieve a list of Plaid processors associated with an end user's bank account.


Sandbox Only

Please note that this endpoint is currently only available for testing in the Sandbox environment and may undergo changes as we continue to improve the feature.

Request

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

Path Parameters

Name
Type
Description

BANK_ACCOUNT_ID required

string

Example Requests

curl --location 'https://api.sfox.com/v1/bank-accounts/${BANK_ACCOUNT_ID}/plaid-processors' \
--header 'Authorization: Bearer ${USER_AUTH_TOKEN}'
const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://api.sfox.com/v1/bank-accounts/${BANK_ACCOUNT_ID}/plaid-processors',
  headers: { 
    'Authorization': 'Bearer ${USER_AUTH_TOKEN}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
import requests

url = "https://api.sfox.com/v1/bank-accounts/${BANK_ACCOUNT_ID}/plaid-processors"

payload = {}
headers = {
  'Authorization': 'Bearer ${USER_AUTH_TOKEN}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response

Response Body

Name
Type
Description

data

[object]

The Plaid processor_tokens and associated processors

processor

string

The processor associated with the token that was processed. Possible values: sfox, dwolla

status

string

The status of processing the token.

bank_account_id

string

date_added

string

Date-time the token was added.

date_updated

string

Date-time the token was last updated.

Responses

200: OK
{
    "data": [
        {
            "processor": "sfox",
            "status": "created",
            "bank_account_id": "05a59670-e7c2-4611-a356-d20cae93e939",
            "date_added": "2025-05-14T01:55:35.664Z",
            "date_updated": "2025-05-14T01:55:35.664Z"
        },
        {
            "processor": "dwolla",
            "status": "created",
            "bank_account_id": "05a59670-e7c2-4611-a356-d20cae93e939",
            "date_added": "2025-05-14T01:55:38.786Z",
            "date_updated": "2025-05-14T01:55:38.786Z"
        }
    ]
}
401: Unauthorized

Invalid user auth token

{
    "error": "user lookup failed"
}

The ID of the end user's bank account (id from ).

The ID of the associated bank account. (id from )

User Auth Token
Get Bank Account
Get Bank Account