Add Payment Initiation to your app

In this guide, we'll start from scratch and walk through how to use Payment Initiation to make a payment. The steps are a bit different from setting up to use most Plaid products. For a high level overview of the process before diving in to the code, see Intro to Payment Initiation.

If you don't already have one, you'll need to create a Plaid developer account. After creating your account, you can find your API keys under the Team Settings menu on the Plaid developer dashboard.

You'll need to request access to Payment Initiation before using it in any Plaid development environment, including Sandbox. To get access to Payment Initiation, submit a product access request Support ticket.

You can use our official libraries to connect to the Plaid API from your application:

1# Install via npm
2npm install --save plaid

Before beginning the payment initiation process, you will need to know how much money is being sent and the name and account information of the recipient. With this information in hand, you can then call /payment_initiation/recipient/create to create a payment recipient and receive a recipient_id.

1// Using BACS, without IBAN or address
2const request: PaymentInitiationRecipientCreateRequest = {
3  name: 'John Doe',
4  bacs: {
5    account: '26207729',
6    sort_code: '560029',
7  },
8};
9try {
10  const response = await plaidClient.paymentInitiationRecipientCreate(request);
11  const recipientID = response.data.recipient_id;
12} catch (error) {
13  // handle error
14}

Now that you have the recipient_id, you can provide it and the payment amount to /payment_initiation/payment/create, which will return a payment_id.

1const request: PaymentInitiationPaymentCreateRequest = {
2  recipient_id: recipientID,
3  reference: 'TestPayment',
4  amount: {
5    currency: 'GBP',
6    value: 100.0,
7  },
8};
9try {
10  const response = await plaidClient.paymentInitiationPaymentCreate(request);
11  const paymentID = response.data.payment_id;
12  const status = response.data.status;
13} catch (error) {
14  // handle error
15}

Plaid Link is a drop-in module that provides a secure, elegant authentication flow for each institution that Plaid supports. Link makes it secure and easy for users to connect their bank accounts to Plaid. Note that these instructions cover Link on the web. For instructions on using Link within mobile apps, see the Link documentation. If you want to customize Link's look and feel, you can do so from the Dashboard.

Before initializing Link, you will need to create a new link_token on the server side of your application. A link_token is a short-lived, one-time use token that is used to authenticate your app with Link. You can create one using the /link/token/create endpoint. Then, on the client side of your application, you'll need to initialize Link with the link_token that you just created. This will bring up the Payment Initiation flow in Link that will allow your end user to confirm the payment.

When calling /link/token/create for use with Payment Initiation, you will provide the payment_id in order to create a token that will initialize Link for the Payment Initiation flow, and you will specify payment_initiation as the product. While it is normally possible to initialize Link with multiple products, payment_initiation cannot be specified along with any other products and must be the only product in Link's product array if it is being used. If your user already has an Item, you can optionally provide its access_token to /link/token/create in order to force that Item to be used as the funding source of the payment.

In the code samples below, you will need to replace PLAID_CLIENT_ID and PLAID_SECRET with your own keys, which you can obtain from the Dashboard.

1// Using Express
2const express = require('express');
3const app = express();
4app.use(express.json());
5
6const { Configuration, PlaidApi, PlaidEnvironments } = require('plaid');
7
8const configuration = new Configuration({
9  basePath: PlaidEnvironments[process.env.PLAID_ENV],
10  baseOptions: {
11    headers: {
12      'PLAID-CLIENT-ID': process.env.PLAID_CLIENT_ID,
13      'PLAID-SECRET': process.env.PLAID_SECRET,
14      'Plaid-Version': '2020-09-14',
15    },
16  },
17});
18
19const client = new PlaidApi(configuration);
20
21app.post('/api/create_link_token', async function (request, response) {
22  const configs = {
23    user: {
24      // This should correspond to a unique id for the current user.
25      client_user_id: 'user-id',
26    },
27    client_name: 'Plaid Test App',
28    products: [Products.PaymentInitiation],
29    language: 'en',
30    webhook: 'https://webhook.sample.com',
31    country_codes: [CountryCode.Gb],
32    payment_initiation: {
33      payment_id: paymentID,
34    },
35  };
36  try {
37    const createTokenResponse = await client.linkTokenCreate(configs);
38    response.json(createTokenResponse.data);
39  } catch (error) {
40    // handle error
41  }
42});

1<head>
2  <title>Connect a bank</title>
3  <script src="https://cdn.plaid.com/link/v2/stable/link-initialize.js"></script>
4</head>

1const linkHandler = Plaid.create({
2  token: (await $.post('/create_link_token')).link_token,
3  onSuccess: (public_token, metadata) => {
4    // Send the public_token to your app server.
5    $.post('/exchange_public_token', {
6      public_token: public_token,
7    });
8  },
9  onExit: (err, metadata) => {
10    // Optionally capture when your user exited the Link flow.
11    // Storing this information can be helpful for support.
12  },
13  onEvent: (eventName, metadata) => {
14    // Optionally capture Link flow events, streamed through
15    // this callback as your users connect an Item to Plaid.
16  },
17});
18
19linkHandler.open();

Because Link has access to all of the details of the payment at the time of initialization, it will display a screen with the payment details already populated. All your end user has to do is log in to their financial institution through a Link-initiated OAuth flow, select a funding account, and confirm the payment details.

Once the payment is confirmed, you can track its status with the /payment_initiation/payment/get endpoint. A status of PAYMENT_STATUS_INITIATED means that the payment was successfully completed. Plaid will also fire the PAYMENT_STATUS_UPDATE webhook to alert you when there are any changes to the status of an initiated payment. Payments will generally complete immediately if the recipient account is in the UK, or in one business day if it is elsewhere in Europe.

1const request: PaymentInitiationPaymentGetRequest = {
2  payment_id: paymentID,
3};
4try {
5  const response = await plaidClient.paymentInitiationPaymentGet(request);
6  const paymentID = response.data.payment_id;
7  const paymentToken = response.data.payment_token;
8  const reference = response.data.reference;
9  const amount = response.data.amount;
10  const status = response.data.status;
11  const lastStatusUpdate = response.data.last_status_update;
12  const paymentTokenExpirationTime =
13    response.data.payment_token_expiration_time;
14  const recipientID = response.data.recipient_id;
15} catch (error) {
16  // handle error
17}