Payment Initiation

paymentInitiationRecipientGet

POST
/payment_initiation/recipient/get

Get details about a payment recipient you have previously created.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

PaymentInitiationRecipientGetRequest defines the request schema for /payment_initiation/recipient/get

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.

recipient_id*string

The ID of the recipient

Length1 <= length

Response Body

application/json

curl -X POST "https://example.com/payment_initiation/recipient/get" \  -H "Content-Type: application/json" \  -d '{    "recipient_id": "string"  }'
{  "recipient_id": "recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6",  "name": "Wonder Wallet",  "iban": "GB29NWBK60161331926819",  "address": {    "street": [      "96 Guild Street",      "9th Floor"    ],    "city": "London",    "postal_code": "SE14 8JW",    "country": "GB"  },  "request_id": "4zlKapIkTm8p5KM"}

paymentInitiationRecipientList POST

The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.

paymentInitiationPaymentCreate POST

After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.