---
title: "List payment recipients"
method: POST
path: "/payment_initiation/recipient/list"
tags: ["plaid"]
---

# List payment recipients

`POST /payment_initiation/recipient/list`

The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.

## Request body

- PaymentInitiationRecipientListRequest — PaymentInitiationRecipientListRequest defines the request schema for `/payment_initiation/recipient/list`
  - `client_id` string — 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.
  - `secret` string — 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.

## Response `200`

OK

- PaymentInitiationRecipientListResponse — PaymentInitiationRecipientListResponse defines the response schema for `/payment_initiation/recipient/list`
  - `recipients` PaymentInitiationRecipient[], required — An array of payment recipients created for Payment Initiation
    - `recipient_id` string, required — The ID of the recipient.
    - `name` string, required — The name of the recipient.
    - `address` PaymentInitiationAddress, nullable — The optional address of the payment recipient's bank account. Required by most institutions outside of the UK.
      - `street` string[], required — An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
      - `city` string, required — The city where the recipient is located. Maximum of 35 characters.
      - `postal_code` string, required — The postal code where the recipient is located. Maximum of 16 characters.
      - `country` string, required — The ISO 3166-1 alpha-2 country code where the recipient is located.
    - `iban` string, nullable — The International Bank Account Number (IBAN) for the recipient.
    - `bacs` RecipientBACSNullable, nullable — The account number and sort code of the recipient's account.
      - `account` string — The account number of the account. Maximum of 10 characters.
      - `sort_code` string — The 6-character sort code of the account.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Changes

- **2024-02-21** `5de70cc1e6ca` — 3 warning
  - removed the request property `count`
  - removed the request property `cursor`
  - removed the optional property `next_cursor` from the response with the `200` status

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/payment_initiation/recipient/list/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/plaid/apis/the-plaid-api/revisions/a5b45bccb4e8?raw)