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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`name`	String	Yes	The name of the recipient. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions.
`client_id`	String	No	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.
`iban`	String	No	The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.
`secret`	String	No	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.
`address`	Object	No	The optional address of the payment recipient's bank account. Required by most institutions outside of the UK.
`address.postal_code`	String	Yes	The postal code where the recipient is located. Maximum of 16 characters.
`address.country`	String	Yes	The ISO 3166-1 alpha-2 country code where the recipient is located.
`address.street[]`	Array	Yes	An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
`address.city`	String	Yes	The city where the recipient is located. Maximum of 35 characters.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.