Create payment recipient

POST /payment_initiation/recipient/create

Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country supported by Plaid. For a standing order (recurring) payment, the recipient must be in the UK.

It is recommended to use bacs in the UK and iban in EU.

The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same recipient_id.

Request Body

Required

PaymentInitiationRecipientCreateRequest defines the request schema for /payment_initiation/recipient/create

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.
name
required, string
The name of the recipient. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions.
iban
string
The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.
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.
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.

Response

PaymentInitiationRecipientCreateResponse defines the response schema for /payment_initation/recipient/create

Response Properties

recipient_id
required, string
A unique ID identifying the recipient
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.