action plaid_payment_initiation_recipient_list {
  label: "List payment recipients"
  description: "The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created."
  provider: plaid
  method: POST
  path: "/payment_initiation/recipient/list"
  encoding: json
  input: {
    type: "object"
    description: "PaymentInitiationRecipientListRequest defines the request schema for `/payment_initiation/recipient/list`"
    properties: {
      client_id: {
        type: "string"
        description: "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: {
        type: "string"
        description: "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."
      }
    }
  }
  output: {
    type: "object"
    description: "PaymentInitiationRecipientListResponse defines the response schema for `/payment_initiation/recipient/list`"
    required: ["recipients", "request_id"]
    properties: {
      recipients: {
        type: "array"
        description: "An array of payment recipients created for Payment Initiation"
        items: {
          type: "object"
          description: "PaymentInitiationRecipient defines a payment initiation recipient"
          required: ["recipient_id", "name"]
          properties: {
            address: {
              type: "object"
              description: "The optional address of the payment recipient."
              required: ["street", "city", "postal_code", "country"]
              properties: {
                city: {
                  type: "string"
                  description: "The city where the recipient is located. Maximum of 35 characters."
                }
                country: {
                  type: "string"
                  description: "The ISO 3166-1 alpha-2 country code where the recipient is located."
                }
                postal_code: {
                  type: "string"
                  description: "The postal code where the recipient is located. Maximum of 16 characters."
                }
                street: {
                  type: "array"
                  description: "An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters."
                  items: {
                    type: "string"
                  }
                }
              }
            }
            bacs: {
              description: "An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required."
              type: "object"
            }
            iban: {
              type: "string"
              description: "The International Bank Account Number (IBAN) for the recipient."
            }
            name: {
              type: "string"
              description: "The name of the recipient."
            }
            recipient_id: {
              type: "string"
              description: "The ID of the recipient."
            }
          }
        }
      }
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
    }
  }
}