Create a plaidLinkToken
, which is used to initialize the Plaid Link process. The Plaid Link token is ephemeral and expires after 4 hours.
Once the user completes the Plaid Link process and authorizes access to their bank account, the Plaid JavaScript SDK will return a temporary plaidPublicToken
, which may then be exchanged for a non-expiring plaidAccessToken
using POST /plaid/item/public_token/exchange.
See: https://plaid.com/docs/link/
Parameters
required
|
name
|
format
|
description
|
---|---|---|---|
* | clientUserId |
Alphanumeric and dashes Max Length 64 |
A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the |
* | terminalId |
Valid Terminal Id |
Used to display the terminal DBA name on the Plaid Link modal, letting users know who is requesting access to their account data. If a terminal DBA name is not available, the terminal legal name will be used instead. Must be an ACH terminal. |
Example Request
curl -X POST https://api.payjunction.com/plaid/link/token/create \
-u "YOUR_USER:YOUR_PASSWORD" \
-H "Accept: application/json" \
-H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY" \
-d "clientUserId=unique-user-id-1" \
-d "terminalId=10000"
Example Response
{
"plaidLinkToken" : "link-sandbox-1f5c0cbd-1fa8-490f-ab61-1d4e57fb4ec1"
}