action velopayments_get_payout_summary_v3 {
  label: "Get Payout Summary"
  description: "Get payout summary - returns the current state of the payout."
  provider: velopayments
  method: GET
  path: "/v3/payouts/{payoutId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      payoutId: {
        type: "string"
        format: "uuid"
      }
    }
    required: ["payoutId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["acceptedPayments", "accounts", "fxSummaries", "paymentsWithdrawn", "rejectedPayments"]
    properties: {
      acceptedPayments: {
        type: "array"
        items: {
          type: "object"
          required: ["amount", "currencyType", "payorPaymentId", "railsId", "remoteId", "sourceAccountName"]
          properties: {
            amount: {
              type: "integer"
              description: "The amount of the payment in minor units"
            }
            currencyType: {
              type: "string"
              description: "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            paymentMemo: {
              type: "string"
              description: "<p>Any value here will override the memo value in the parent payout</p>\n<p>This should be the reference field on the statement seen by the payee (but not via ACH)</p>\n"
            }
            paymentMetadata: {
              type: "string"
              description: "<p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p>\n<p>The structure of the data will be dictated by the requirements of the payment rails</p>\n"
            }
            payorPaymentId: {
              type: "string"
              description: "A reference identifier for the payor for the given payee payment"
            }
            railsId: {
              type: "string"
              description: "Indicates the 3rd party system involved in making this payment"
            }
            remoteId: {
              type: "string"
              description: "Your identifier for the payee"
            }
            remoteSystemId: {
              type: "string"
              description: "<p>The identifier for the remote payments system if not Velo</p>\n"
            }
            sourceAccountName: {
              type: "string"
              description: "The identifier of the source account to debit the payment from"
            }
          }
        }
      }
      accounts: {
        type: "array"
        items: {
          type: "object"
          required: ["currency", "sourceAccountId", "sourceAccountName", "totalPayoutCost"]
          properties: {
            currency: {
              type: "string"
              description: "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            sourceAccountId: {
              type: "string"
              format: "uuid"
              description: "The id of the payout"
            }
            sourceAccountName: {
              type: "string"
              description: "The name of the source account as referencec in the payout"
            }
            totalPayoutCost: {
              type: "integer"
              description: "The total amount (in mnor units) that will be debited from the source account for the payout"
            }
          }
        }
      }
      fxSummaries: {
        type: "array"
        items: {
          type: "object"
          required: ["creationTime", "fundingStatus", "paymentCurrency", "quoteId", "rate", "sourceCurrency", "status", "totalPaymentAmount", "totalSourceAmount"]
          properties: {
            creationTime: {
              type: "string"
              format: "date-time"
              description: "Timestamp of when the quote was created"
            }
            expiryTime: {
              type: "string"
              format: "date-time"
              description: "The timestamp for when the quote will expire"
            }
            fundingStatus: {
              type: "string"
              description: "Current status of the funding associated with this quote. One of the following values: UNFUNDED, INSTRUCTED, FUNDED"
            }
            invertedRate: {
              type: "number"
              format: "float"
              description: "The inverse conversion rate (from paymnent currency to source currency)"
            }
            paymentCurrency: {
              type: "string"
              description: "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            quoteId: {
              type: "string"
              format: "uuid"
              description: "The id of the created quote"
            }
            rate: {
              type: "number"
              format: "float"
              description: "The conversion rate (from the source currency to the payment currency)"
            }
            sourceCurrency: {
              type: "string"
              description: "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            status: {
              type: "string"
              description: "Current status of the fx quote. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED, REJECTED"
            }
            totalPaymentAmount: {
              type: "integer"
              description: "The amount (in minor units) that the payee will receive"
            }
            totalSourceAmount: {
              type: "integer"
              description: "The amount (in minor units) that will be paid from the source account"
            }
          }
        }
      }
      paymentsAccepted: {
        type: "integer"
        description: "The number of payments that were accepted in the payout"
      }
      paymentsRejected: {
        type: "integer"
        description: "The number of payments that were rejected in the payout"
      }
      paymentsSubmitted: {
        type: "integer"
        description: "The number of payments that were submitted in the payout"
      }
      paymentsWithdrawn: {
        type: "integer"
        description: "The number of payments that were withdrawn in the payout"
      }
      payoutId: {
        type: "string"
        format: "uuid"
        description: "The id of the payout"
      }
      rejectedPayments: {
        type: "array"
        items: {
          type: "object"
          required: ["amount", "currencyType", "payorPaymentId", "reason", "remoteId", "sourceAccountName"]
          properties: {
            amount: {
              type: "integer"
              description: "The amount of the payment in minor units"
            }
            currencyType: {
              type: "string"
              description: "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
            }
            lineNumber: {
              type: "integer"
              description: "If the payment was submitted in a csv payout then this will be the line number of the payment in the file"
            }
            message: {
              type: "string"
              description: "A more general rejection message than the reason property"
            }
            paymentMetadata: {
              type: "string"
              description: "<p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p>\n<p>The structure of the data will be dictated by the requirements of the payment rails</p>\n"
            }
            payorPaymentId: {
              type: "string"
              description: "A reference identifier for the payor for the given payee payment"
            }
            reason: {
              type: "string"
              description: "The reason for the payment being rejected"
            }
            reasonCode: {
              type: "string"
              description: "The reason code as determined by Velo"
            }
            remoteId: {
              type: "string"
              description: "The remoteId supplied by the payor that identifies the payee"
            }
            remoteSystemId: {
              type: "string"
              description: "<p>The identifier for the remote payments system if not Velo</p>\n"
            }
            sourceAccountName: {
              type: "string"
              description: "The identifier of the source account to debit the payment from"
            }
          }
        }
      }
      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: "The current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED"
          }
          scheduledAt: {
            type: "string"
            format: "date-time"
          }
          scheduledByPrincipalId: {
            type: "string"
            description: "ID of the user or application that scheduled the payout"
          }
          scheduledFor: {
            type: "string"
            format: "date-time"
          }
        }
      }
      status: {
        type: "string"
        description: "The status of the payout (one of SUBMITTED, ACCEPTED, REJECTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, WITHDRAWN)"
      }
    }
  }
}