Integration Endpoints

account/set-plaid-credentials

This endpoint is used to configure the optional integration with a Plaid account. For more information please visit our integration section.

post/account/set-plaid-credentials

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/set-plaid-credentials
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

PlaidClientIDstring required

The unique client ID from Plaid

PlaidSecretKeystring required

The unique secret key from Plaid

PlaidUrlstring required

The URL defines the Plaid environment. For example https://sandbox.plaid.com for sandbox, https://development.plaid.com for development, and https://production.plaid.com for production.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

PlaidClientIDstring required

Your updated plaid client ID

PlaidSecretKeystring required

Your updated plaid secret key

PlaidUrlstring required

Your updated plaid URL

Example response

{
  "Success": true,
  "PlaidClientID": "{PlaidClientID}",
  "PlaidSecretKey": "{PlaidSecretKey}",
  "PlaidUrl": "{PlaidUrl}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.