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

Required

PaymentInitiationRecipientListRequest defines the request schema for /payment_initiation/recipient/list

Parameters

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
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

PaymentInitiationRecipientListResponse defines the response schema for /payment_initiation/recipient/list

Response Properties

recipients
required, array[object]
An array of payment recipients created for Payment Initiation
recipient_id
required, string
The ID of the recipient.
name
required, string
The name of the recipient.
address
object
The optional address of the payment recipient’s bank account. Required by most institutions outside of the UK.
street
required, array[string]
An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
city
required, string
The city where the recipient is located. Maximum of 35 characters.
postal_code
required, string
The postal code where the recipient is located. Maximum of 16 characters.
country
required, string
The ISO 3166-1 alpha-2 country code where the recipient is located.
iban
string
The International Bank Account Number (IBAN) for the recipient.
bacs
object
An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
request_id
required, string
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.