link_account_msg
Key | Type | Description | Recquired |
---|---|---|---|
header | object | This object is required in every call. The information it includes is used to verify the signature. | true |
message | string | This tag specifies the JSON schema object to validate against. For this call, use link_account_msg . | false |
plaid_token | string | This is the public token returned in the onSuccess function of a Plaid Link session, or a processor token if using your own Plaid integration. If you are a customer using direct account-linking, this is not a required field | true |
account_name | string | This is the name given to the linked account. If omitted, it is "default". | false |
selected_account_id | string | If one account is selected through Plaid Link, the ID found in the selected accounts array can be passed in here. If this is omitted, the endpoint will choose the first checking account it finds at the end-user's bank. | false |
account_number | string | For direct account-linking customers only; not required if using a Plaid public token instead. This field is for specifying an end-user's US bank account number. | true |
routing_number | string | For direct account-linking customers only; not required if using a Plaid public token instead. This field is for specifying an end-user's US bank routing number. | true |
account_type | string | For direct account-linking customers only; not required if using a Plaid public token instead. This field is for specifying an end-user's US bank account type. For this call, the only acceptable value for this field is "CHECKING" (may change in future versions). | false |
plaid_token_type | string | Must match either "legacy", "link" or "processor". Default value if not sent in request is “legacy” | false |
Used By Endpoints:
- /link_account
Note - We recently renamed the field auth_handle
to app_handle
. For backward compatibility, auth_handle
is still valid but has been removed from our documentation.
{
"header": {
"created": 1234567890,
"app_handle": "handle.silamoney.eth",
"user_handle":"user.silamoney.eth",
"version": "0.2",
"crypto": "ETH",
"reference": "<your unique id>"
},
"message": "link_account_msg",
"plaid_token": "public_token_wH473vr",
"account_name": "Chase Checking Account"
}
Updated almost 4 years ago