logo

Create a Plaid credential

Creates a Plaid credential.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Plaid credential resource.

clientId
required
string

ID of the Plaid client.

secretToken
required
string <password>

Plaid secret token.

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.

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 if a Stripe integration is enabled for the Plaid account. This setting enables the creation of Stripe bank account tokens.

Responses
201

Plaid credential created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
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 if a Stripe integration is enabled for the Plaid account. This setting enables the creation of Stripe bank account tokens.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
303

Existing Plaid credential retrieved.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

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