Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB
plaid

Get payment profile

Use /payment_profile/get endpoint to get the status of a given Payment Profile.

post/payment_profile/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.

payment_profile_tokenstring required

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

Response

OK

updated_atstring date-time required

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time the given Payment Profile was updated at

created_atstring date-time required

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the time the given Payment Profile was created at

deleted_atstring date-time nullable required

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the time the given Payment Profile was deleted at. Always null if the Payment Profile has not been deleted

status'PENDING' | 'READY' | 'REMOVED' required

The status of the given Payment Profile.

READY: This Payment Profile is ready to be used to create transfers using /transfer/authorization/create and /transfer/create.

PENDING: This Payment Profile is not ready to be used. You'll need to call /link/token/create and provide the payment_profile_token in the transfer.payment_profile_token field to initiate the account linking experience.

REMOVED: This Payment Profile has been removed.

request_idstring required

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