Get RTP eligibility information of a transfer

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.

Request Body

Required

Defines the request schema for /transfer/capabilities/get

Parameters

client_id
string
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.
secret
string
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_token
required, string
The Plaid access_token for the account that will be debited or credited.
account_id
required, string
The Plaid account_id corresponding to the end-user account that will be debited or credited.
payment_profile_token
string
A payment profile token associated with the Payment Profile data that is being requested.

Response

Defines the response schema for /transfer/capabilities/get

Response Properties

institution_supported_networks
required, object
Contains the RTP and RfP network and types supported by the linked Item’s institution.
rtp
required, object
Contains the supported service types in RTP
credit
boolean
When true, the linked Item’s institution supports RTP credit transfer.
rfp
required, object
Contains the supported service types in RfP
debit
boolean
When true, the linked Item’s institution supports RfP debit transfer.
max_amount
string
The maximum amount (decimal string with two digits of precision e.g. “10.00”) for originating RfP transfers with the given institution.
iso_currency_code
string
The currency of the max_amount, e.g. “USD”.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.