plaid

Create payment consent

Changed on

The /payment_initiation/consent/create endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with UNAUTHORISED status by default and must be authorised by the user before payments can be initiated.

Consents can be limited in time and scope, and have constraints that describe limitations for payments.

post/payment_initiation/consent/create

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/payment_initiation/consent/create
  • 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.

recipient_idstring required

The ID of the recipient the payment consent is for. The created consent can be used to transfer funds to this recipient only.

user_idstring

The user_id of the end user the payment consent is for, as returned by /user/create. The user must have a name and either an email address or a phone number. Payments created from this consent inherit this user_id. Required for new integrations.

referencestring required

A reference for the payment consent. This must be a string of at most 18 characters containing only letters, numbers, and spaces.

scopesPaymentInitiationConsentScope[]

An array of payment consent scopes.

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.

Response

OK

consent_idstring required

A unique ID identifying the payment consent.

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.

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

  • e536704a333fRevision changes
    • info

      added the new optional request property