Update a Plaid credential

Updates a Plaid credential with a specified token ID.

SecuritySecretApiKey or JWT
Request
path Parameters
hash
required
string

ID of the token.

Request Body schema: application/json

Plaid credential resource.

status
required
string

Status of the credential.

Value: "deactivated"
Responses
200

Plaid credential updated.

Response Schema: application/json
clientId
required
string

ID of the Plaid client.

secretToken
required
string <password>

Plaid secret token.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

websiteId
string <= 50 characters

ID of the website that is assigned to the Plaid account. If this value is not set, credentials are for all websites.

useStripe
boolean
Default: false

Specifies whether a Stripe integration is enabled for the Plaid account. This setting enables the creation of Stripe bank account tokens.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

patch/credential-hashes/plaid/{hash}
Request samples
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "clientId": "5efc712byyf502zz11f9bexx",
  • "secretToken": "d184cfdgdb4597dfsa9365f59356b",
  • "useStripe": true,
  • "_links": [
    ]
}