action plaid_payment_initiation_recipient_create {
  label: "Create payment recipient"
  description: "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) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK.\n\nIt is recommended to use `bacs` in the UK and `iban` in EU.\n\nThe endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.\n"
  provider: plaid
  method: POST
  path: "/payment_initiation/recipient/create"
  encoding: json
  input: {
    type: "object"
    description: "PaymentInitiationRecipientCreateRequest defines the request schema for `/payment_initiation/recipient/create`"
    required: ["name"]
    properties: {
      address: {
        type: "object"
        description: "The optional address of the payment recipient."
        required: ["city", "country", "postal_code", "street"]
        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"
      }
      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."
      }
      iban: {
        type: "string"
        description: "The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required."
      }
      name: {
        type: "string"
        description: "The name of the recipient. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions."
      }
      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: "PaymentInitiationRecipientCreateResponse defines the response schema for `/payment_initation/recipient/create`"
    required: ["recipient_id", "request_id"]
    properties: {
      recipient_id: {
        type: "string"
        description: "A unique ID identifying 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."
      }
    }
  }
}