Sign in
plaid

Get RTP eligibility information of a transfer

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.

post/transfer/capabilities/get

Request body

client_idstring

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.

secretstring

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.

access_tokenstring required

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

account_idstring required

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

payment_profile_tokenstring

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

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes