action velopayments_get_payouts_for_payor_v4 {
  label: "Get Payouts for Payor"
  description: "Get List of payouts for payor\n"
  provider: velopayments
  method: GET
  path: "/v4/paymentaudit/payouts"
  encoding: json
  input: {
    type: "object"
    properties: {
      fromPayorName: {
        type: "string"
      }
      page: {
        type: "integer"
        format: "int32"
      }
      pageSize: {
        type: "integer"
        format: "int32"
      }
      payorId: {
        type: "string"
        format: "uuid"
      }
      payoutMemo: {
        type: "string"
      }
      scheduleStatus: {
        type: "string"
        enum: ["ANY", "SCHEDULED", "EXECUTED", "FAILED"]
      }
      scheduledForDateFrom: {
        type: "string"
        format: "date"
      }
      scheduledForDateTo: {
        type: "string"
        format: "date"
      }
      sort: {
        type: "string"
      }
      status: {
        type: "string"
        enum: ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "WITHDRAWN"]
      }
      submittedDateFrom: {
        type: "string"
        format: "date"
      }
      submittedDateTo: {
        type: "string"
        format: "date"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "List Payouts Response"
    properties: {
      content: {
        type: "array"
        items: {
          type: "object"
          required: ["payorName", "payoutType", "status", "submittedDateTime"]
          properties: {
            dateTime: {
              type: "string"
              format: "date-time"
            }
            fxSummaries: {
              type: "array"
              items: {
                type: "object"
                required: ["creationDateTime", "fundingStatus", "invertedRate", "quoteId", "rate", "status", "totalCost", "totalPaymentAmount"]
                properties: {
                  creationDateTime: {
                    type: "string"
                    format: "date-time"
                  }
                  fundingStatus: {
                    type: "string"
                    description: "Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED"
                  }
                  invertedRate: {
                    type: "number"
                    format: "double"
                  }
                  paymentCurrency: {
                    type: "string"
                    description: "ISO-4217 3 character currency code"
                  }
                  quoteId: {
                    type: "string"
                    format: "uuid"
                  }
                  rate: {
                    type: "number"
                    format: "double"
                  }
                  sourceCurrency: {
                    type: "string"
                    description: "ISO-4217 3 character currency code"
                  }
                  status: {
                    type: "string"
                    description: "Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED"
                  }
                  totalCost: {
                    type: "integer"
                  }
                  totalPaymentAmount: {
                    type: "integer"
                  }
                }
              }
            }
            instructedDateTime: {
              type: "string"
            }
            payorId: {
              type: "string"
              format: "uuid"
            }
            payorName: {
              type: "string"
            }
            payoutId: {
              type: "string"
              format: "uuid"
            }
            payoutMemo: {
              type: "string"
            }
            payoutType: {
              type: "string"
              description: "The type of payout. One of the following values: STANDARD, AS, ON_BEHALF_OF"
            }
            schedule: {
              type: "object"
              description: "Details relating to a payout that was executed via a schedule or is still waiting to be executed"
              required: ["notificationsEnabled", "scheduleStatus", "scheduledAt", "scheduledByPrincipalId", "scheduledFor"]
              properties: {
                notificationsEnabled: {
                  type: "boolean"
                }
                scheduleStatus: {
                  type: "string"
                  description: "Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED"
                }
                scheduledAt: {
                  type: "string"
                  format: "date-time"
                }
                scheduledBy: {
                  type: "string"
                  description: "Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application."
                }
                scheduledByPrincipalId: {
                  type: "string"
                  description: "ID of the user or application that scheduled the payout"
                }
                scheduledFor: {
                  type: "string"
                  format: "date-time"
                }
              }
            }
            sourceAccountSummary: {
              type: "array"
              items: {
                type: "object"
                required: ["sourceAccountId", "totalCost"]
                properties: {
                  currency: {
                    type: "string"
                    description: "ISO-4217 3 character currency code"
                  }
                  sourceAccountId: {
                    type: "string"
                    format: "uuid"
                  }
                  totalCost: {
                    type: "integer"
                    format: "int64"
                  }
                }
              }
            }
            status: {
              type: "string"
              description: "Current status of the Payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN"
            }
            submittedDateTime: {
              type: "string"
            }
            totalIncompletePayments: {
              type: "integer"
            }
            totalPayments: {
              type: "integer"
            }
            totalReturnedPayments: {
              type: "integer"
            }
            totalWithdrawnPayments: {
              type: "integer"
            }
            withdrawnDateTime: {
              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"
          }
        }
      }
    }
  }
}