provider plaid POST /payment_initiation/consent/create
@utdk/plaid /payment_initiation/consent/create
Create payment consent
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.

Try it

Authentication
Configure credentials for The Plaid API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

paymentinitiationconsentcreate
POST/payment_initiation/consent/create
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.

Input

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.

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.

required

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

required

A reference for the payment consent. This must be an alphanumeric string with at most 18 characters and must not contain any special characters.

An array of payment consent scopes.

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.

required

Limitations that will be applied to payments initiated using the payment consent.

(Deprecated) Additional payment consent options. Please use `payer_details` to specify the account.

An object representing the payment consent payer details. Payer `name` and account `numbers` are required to lock the account to which the consent can be created.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.paymentinitiationconsentcreate()