---
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 lists 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.
  - `count` integer, nullable — The maximum number of recipients to return. If `count` is not specified, a maximum of 100 recipients will be returned, beginning with the recipient at the cursor (if specified).
  - `cursor` string — A value representing the latest recipient to be included in the response. Set this from `next_cursor` received from the previous `/payment_initiation/recipient/list` request. If provided, the response will only contain that recipient and recipients created before it. If omitted, the response will contain recipients starting from the most recent, and in descending order by the `created_at` time.

## 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.
  - `next_cursor` string — The value that, when used as the optional `cursor` parameter to `/payment_initiation/recipient/list`, will return the corresponding recipient as its first recipient.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)