action velopayments_get_payee_by_id_v4 {
  label: "Get Payee by Id"
  description: "Get Payee by Id"
  provider: velopayments
  method: GET
  path: "/v4/payees/{payeeId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      payeeId: {
        type: "string"
        format: "uuid"
      }
      sensitive: {
        type: "boolean"
      }
    }
    required: ["payeeId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      acceptTermsAndConditionsTimestamp: {
        type: "string"
        format: "date-time"
        description: "The timestamp when the payee last accepted T&Cs"
      }
      address: {
        type: "object"
        required: ["city", "country", "line1"]
        properties: {
          city: {
            type: "string"
          }
          country: {
            type: "string"
          }
          countyOrProvince: {
            type: "string"
          }
          line1: {
            type: "string"
          }
          line2: {
            type: "string"
          }
          line3: {
            type: "string"
          }
          line4: {
            type: "string"
          }
          zipOrPostcode: {
            type: "string"
          }
        }
      }
      cellphoneNumber: {
        type: "string"
      }
      challenge: {
        type: "object"
        description: "<p>Used to override the default challenge presented to the payee when they onboard</p>\n<p>Not used after the payee has onboarded</p>\n"
        required: ["description", "value"]
        properties: {
          description: {
            type: "string"
          }
          value: {
            type: "string"
            description: "The value that the user will be asked to verify when they onboard"
          }
        }
      }
      company: {
        type: "object"
        required: ["name"]
        properties: {
          name: {
            type: "string"
          }
          operatingName: {
            type: "string"
          }
          taxId: {
            type: "string"
            description: "Company Tax Id must be between 6 and 30 characters long"
          }
        }
      }
      country: {
        type: "string"
      }
      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"
      }
      enhancedKycCompleted: {
        type: "boolean"
      }
      gracePeriodEndDate: {
        type: "string"
        format: "date"
      }
      individual: {
        type: "object"
        required: ["dateOfBirth", "name"]
        properties: {
          dateOfBirth: {
            type: "string"
            description: "If not authorized to view, value will be masked. Example: - XXXX-XX-XX"
          }
          name: {
            required: ["firstName", "lastName"]
            properties: {
              firstName: {
                type: "string"
              }
              lastName: {
                type: "string"
              }
              otherNames: {
                type: "string"
              }
              title: {
                type: "string"
              }
            }
          }
          nationalIdentification: {
            type: "string"
            description: "If not authorized to view, value will be masked. Example: XXXXX1234"
          }
        }
      }
      kycCompletedTimestamp: {
        type: "string"
        format: "date_time"
      }
      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"
      }
      marketingOptInDecision: {
        type: "boolean"
      }
      marketingOptInTimestamp: {
        type: "string"
        format: "date_time"
      }
      onboardedStatus: {
        type: "string"
        description: "Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED"
      }
      pausePayment: {
        type: "boolean"
      }
      pausePaymentTimestamp: {
        type: "string"
        format: "date_time"
      }
      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"
      }
      watchlistOverrideExpiresAtTimestamp: {
        type: "string"
        format: "date-time"
      }
      watchlistStatus: {
        type: "string"
        description: "Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED"
      }
      watchlistStatusUpdatedTimestamp: {
        type: "string"
        format: "date_time"
      }
    }
  }
}