Payment Initiation

paymentInitiationRecipientList

POST
/payment_initiation/recipient/list

The /payment_initiation/recipient/list endpoint list the payment recipients that 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

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

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.

Response Body

application/json

curl -X POST "https://example.com/payment_initiation/recipient/list" \  -H "Content-Type: application/json" \  -d '{}'
{  "recipients": [    {      "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"}