plaid

Get payment consent

Changed on

The /payment_initiation/consent/get endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.

post/payment_initiation/consent/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/payment_initiation/consent/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

consent_idstring required

The consent_id returned from /payment_initiation/consent/create.

Response

OK

consent_idstring required

The consent ID.

status'UNAUTHORISED' | 'AUTHORISED' | 'REVOKED' | 'REJECTED' | 'EXPIRED' required

The status of the payment consent.

UNAUTHORISED: Consent created, but requires user authorisation.

REJECTED: Consent authorisation was rejected by the bank.

AUTHORISED: Consent is active and ready to be used.

REVOKED: Consent has been revoked and can no longer be used.

EXPIRED: Consent is no longer valid.

created_atstring date-time required

Consent creation timestamp, in ISO 8601 format.

recipient_idstring required

The ID of the recipient the payment consent is for.

referencestring required

A reference for the payment consent.

scopesPaymentInitiationConsentScope[]

Deprecated, use the 'type' field instead.

type'SWEEPING' | 'COMMERCIAL'

Payment consent type. Defines possible use case for payments made with the given consent.

SWEEPING: Allows moving money between accounts owned by the same user.

COMMERCIAL: Allows initiating payments from the user's account to third parties.

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

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 94406d9a4d27Revision changes
    • info

      response property allOf[PaymentInitiationConsent]/scopes/items/ deprecated