Plaid credentials

Retrieve a list of Plaid credentials

Request
Security:
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of Plaid credentials was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/credential-hashes/plaid
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/credential-hashes/plaid?filter=string&limit=1000&offset=0&sort=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a Plaid credential

Create a Plaid credential.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Plaid credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
websiteId
string <= 50 characters

The website assigned to this Plaid account. If not set, credentials will be used for any website.

clientId
required
string

The Plaid client ID.

secretToken
required
string <password>

The Plaid secret token.

useStripe
boolean
Default: false

Whether the Stripe integration is enabled for Plaid account. This setting will enable creating Stripe bank account tokens.

Responses
201

Plaid credential was created.

303

An existent Plaid credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/plaid
Request samples
application/json
{
  • "status": "active",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "clientId": "5efc712byyf502zz11f9bexx",
  • "secretToken": "d184cfdgdb4597dfsa9365f59356b",
  • "useStripe": true,
  • "_links": [
    ]
}

Retrieve a Plaid credential

Retrieve a Plaid credential with specified token identifier string.

Request
Security:
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Plaid credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/plaid/{hash}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/credential-hashes/plaid/:hash \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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": [
    ]
}

Update a Plaid credential

Update a Plaid credential with specified token identifier string.

Request
Security:
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Plaid credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

Plaid credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was 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": [
    ]
}