action velopayments_submit_payout_v3 {
  label: "Submit Payout"
  description: "<p>Create a new payout and return a location header with a link to the payout</p>\n<p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p>\n<p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p>\n<p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p>\n"
  provider: velopayments
  method: POST
  path: "/v3/payouts"
  encoding: json
  input: {
    type: "object"
    required: ["payments"]
    properties: {
      payments: {
        type: "array"
        items: {
          type: "object"
          description: "Instruction for creating a payment"
          required: ["amount", "currency", "remoteId", "sourceAccountName"]
          properties: {
            amount: {
              type: "integer"
              format: "int64"
              description: "<p>Amount to send to Payee</p>\n<p>The maximum payment amount is dependent on the currency</p>\n"
            }
            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."
            }
            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"
            }
            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<p>Should only be used after consultation with Velo Payments</p>\n"
            }
            sourceAccountName: {
              type: "string"
              description: "Must match a valid source account name belonging to the payor"
            }
            transmissionType: {
              type: "string"
              description: "Optionally choose a specific transmission method for the payment"
              enum: ["SAME_DAY_ACH", "WIRE", "ACH", "LOCAL", "SWIFT"]
            }
          }
        }
      }
      payoutFromPayorId: {
        type: "string"
        format: "uuid"
        description: "<p>The id of the payor whose source account(s) will be debited</p>\n<p>payoutFromPayorId and payoutToPayorId must be both supplied or both omitted</p>\n"
      }
      payoutMemo: {
        type: "string"
        description: "<p>Text applied to all payment memos unless specified explicitly on a payment</p>\n<p>This should be the reference field on the statement seen by the payee (but not via ACH)</p>\n"
      }
      payoutToPayorId: {
        type: "string"
        format: "uuid"
        description: "<p>The id of the payor whose payees will be paid</p>\n<p>payoutFromPayorId and payoutToPayorId must be both supplied or both omitted</p>\n"
      }
    }
  }
  output: {
    type: "object"
    additionalProperties: true
  }
}