POST /payment_initiation/recipient/list

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

Servers

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
count Integer No

The maximum number of recipients to return. If count is not specified, a maximum of 100 recipients will be returned, beginning with the recipient at the cursor (if specified).

Default value: 100

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.

cursor String No

A value representing the latest recipient to be included in the response. Set this from next_cursor received from the previous /payment_initiation/recipient/list request. If provided, the response will only contain that recipient and recipients created before it. If omitted, the response will contain recipients starting from the most recent, and in descending order by the created_at time.

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.