action velopayments_list_payees_v4 {
  label: "List Payees"
  description: "Get a paginated response listing the payees for a payor."
  provider: velopayments
  method: GET
  path: "/v4/payees"
  encoding: json
  input: {
    type: "object"
    properties: {
      disabled: {
        type: "boolean"
      }
      displayName: {
        type: "string"
      }
      email: {
        type: "string"
        format: "email"
      }
      ofacStatus: {
        type: "string"
        description: "OFAC status. One of the following values: PENDING, PASSED, FAILED"
      }
      onboardedStatus: {
        type: "string"
        description: "Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED"
      }
      page: {
        type: "integer"
        format: "int32"
      }
      pageSize: {
        type: "integer"
        format: "int32"
      }
      payeeCountry: {
        type: "string"
      }
      payeeType: {
        type: "string"
        description: "Type of Payee. One of the following values: Individual, Company"
      }
      payorId: {
        type: "string"
        format: "uuid"
      }
      remoteId: {
        type: "string"
      }
      sort: {
        type: "string"
      }
      watchlistStatus: {
        type: "string"
        description: "Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED"
      }
    }
    required: ["payorId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "List Payees Response Object"
    properties: {
      content: {
        type: "array"
        items: {
          type: "object"
          properties: {
            company: {
              type: "object"
              properties: {
                name: {
                  type: "string"
                }
                operatingName: {
                  type: "string"
                }
              }
            }
            country: {
              type: "string"
              description: "Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            created: {
              type: "string"
              format: "date-time"
            }
            disabled: {
              type: "boolean"
            }
            disabledComment: {
              type: "string"
            }
            disabledUpdatedTimestamp: {
              type: "string"
              format: "date-time"
            }
            displayName: {
              type: "string"
            }
            email: {
              type: "string"
              format: "email"
            }
            individual: {
              type: "object"
              properties: {
                name: {
                  type: "object"
                  properties: {
                    firstName: {
                      type: "string"
                    }
                    lastName: {
                      type: "string"
                    }
                    otherNames: {
                      type: "string"
                    }
                    title: {
                      type: "string"
                    }
                  }
                }
              }
            }
            language: {
              type: "string"
              description: "An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR>\nSee the /v1/supportedLanguages endpoint to list the available codes for an environment.\n"
            }
            onboardedStatus: {
              type: "string"
              description: "Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED"
            }
            payeeId: {
              type: "string"
              format: "uuid"
            }
            payeeType: {
              type: "string"
              description: "Type of Payee. One of the following values: Individual, Company"
            }
            payorRefs: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  invitationStatus: {
                    type: "string"
                  }
                  invitationStatusTimestamp: {
                    type: "string"
                    format: "date-time"
                    description: "The timestamp when the invitation status is updated"
                  }
                  payableIssues: {
                    type: "array"
                    description: "Indicates any conditions which prevent the payee from being payable for this payor"
                    items: {
                      type: "object"
                      description: "payable issues for the payee and payor combination"
                      required: ["code", "message"]
                      properties: {
                        code: {
                          type: "string"
                        }
                        message: {
                          type: "string"
                        }
                      }
                    }
                  }
                  payableStatus: {
                    type: "boolean"
                    description: "Indicates if the payee is payable for this payor"
                  }
                  paymentChannelId: {
                    type: "string"
                    format: "uuid"
                  }
                  payorId: {
                    type: "string"
                    format: "uuid"
                  }
                  remoteId: {
                    type: "string"
                  }
                }
              }
            }
            watchlistOverrideComment: {
              type: "string"
            }
            watchlistStatus: {
              type: "string"
              description: "Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED"
            }
            watchlistStatusUpdatedTimestamp: {
              type: "string"
              format: "date_time"
            }
          }
        }
      }
      links: {
        type: "array"
        items: {
          properties: {
            href: {
              type: "string"
            }
            rel: {
              type: "string"
            }
          }
        }
      }
      page: {
        properties: {
          numberOfElements: {
            type: "integer"
          }
          page: {
            type: "integer"
          }
          pageSize: {
            type: "integer"
          }
          totalElements: {
            type: "integer"
          }
          totalPages: {
            type: "integer"
          }
        }
      }
      summary: {
        properties: {
          totalInvitedCount: {
            type: "integer"
          }
          totalOnboardedCount: {
            type: "integer"
          }
          totalPayeesCount: {
            type: "integer"
          }
          totalRegisteredCount: {
            type: "integer"
          }
          totalWatchlistFailedCount: {
            type: "integer"
          }
        }
      }
    }
  }
}