POST /transfer/capabilities/get

Use the /transfer/capabilities/get endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by /transfer/migrate_account. To simulate RTP eligibility in Sandbox, log in using the username user_good and password pass_good and use the first two checking and savings accounts in the "First Platypus Bank" institution (ending in 0000 or 1111), which will return true. Any other account will return false.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
client_id String No

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

account_id String Yes

The Plaid account_id corresponding to the end-user account that will be debited or credited.

payment_profile_token String No

A payment profile token associated with the Payment Profile data that is being requested.

access_token String Yes

The Plaid access_token for the account that will be debited or credited.

secret String No

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.