paymentInitiationRecipientCreate
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). For a standing order (recurring) payment, the recipient must be in the UK.
The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same recipient_id.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
PaymentInitiationRecipientCreateRequest defines the request schema for /payment_initiation/recipient/create
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.
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.
The name of the recipient
1 <= lengthThe International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.
15 <= length <= 34The optional address of the payment recipient. This object is not currently required to make payments from UK institutions and should not be populated, though may be necessary for future European expansion.
Response Body
application/json
curl -X POST "https://example.com/payment_initiation/recipient/create" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "recipient_id": "recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6", "request_id": "4zlKapIkTm8p5KM"}paymentInitiationPaymentReverse POST
Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
paymentInitiationRecipientList POST
The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.