Amend Plaid Processors

PUT

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

Modify the Plaid processors associated with a bank account.


Request

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

Path Parameters

Name
Type
Description

BANK_ACCOUNT_ID required

string

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

Body Parameters

Name
Type
Description

data required

[object]

The Plaid processor_tokens and associated processors

processor required

string

The processor associated with this token. Possible values: sfox, dwolla

token required

string

The processor_token retrieved from Plaid.

Example Requests

#Update bank account with new sFOX and Dwolla processor tokens
curl --location --request PUT 'https://api.sfox.com/v1/bank-accounts/${BANK_ACCOUNT_ID}/plaid-processors' \
  -H 'Content-type: application/json' \
  -H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
  -d '{ 
      "data": [
        {
          "processor": "sfox",
          "token": "${SFOX_PLAID_PROCESSOR_TOKEN}"
        },
        {
          "processor": "dwolla",
          "token": "${DWOLLA_PLAID_PROCESSOR_TOKEN}"
        }
      ]
   }'

#Update bank account with new sFOX processor token
curl --location --request PUT 'https://api.sfox.com/v1/bank-accounts/${BANK_ACCOUNT_ID}/plaid-processors' \
  -H 'Content-type: application/json' \
  -H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
  -d '{ 
      "data": [{
        "processor": "sfox",
        "token": "${SFOX_PLAID_PROCESSOR_TOKEN}"
      }]
   }'

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

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

date_added

string

Date-time the token was added.

date_updated

string

Date-time the token was last updated.

Responses

201: Created

sFOX and Dwolla p-tokens processed successfully

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

sFOX p-token successfully processed

{
    "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"
        }
    ]
}
422: Unprocessable Entity

Active bank account is linked to this end user's account. To link a new bank account, remove the current bank account and try again.

{
    "error": "could not process your sfox processor token: This account already has a bank account linked to it that is active"
}

sFOX p-token not included in a request with a Dwolla p-token.

{
    "error": "At least one sfox processor token is required if a dwolla processor token is given"
}

Last updated