action velopayments_get_payments_for_payout_v3 {
  label: "Retrieve payments for a payout"
  description: "Retrieve payments for a payout"
  provider: velopayments
  method: GET
  path: "/v3/payouts/{payoutId}/payments"
  encoding: json
  input: {
    type: "object"
    properties: {
      page: {
        type: "integer"
        format: "int32"
      }
      pageSize: {
        type: "integer"
        format: "int32"
      }
      paymentMemo: {
        type: "string"
      }
      payorPaymentId: {
        type: "string"
      }
      payoutId: {
        type: "string"
        format: "uuid"
      }
      remoteId: {
        type: "string"
      }
      sourceAccountName: {
        type: "string"
      }
      status: {
        type: "string"
        enum: ["ACCEPTED", "REJECTED", "WITHDRAWN", "WITHDRAWABLE"]
      }
      transmissionType: {
        type: "string"
        enum: ["ACH", "SAME_DAY_ACH", "WIRE"]
      }
    }
    required: ["payoutId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "List Payees Response Object"
    properties: {
      content: {
        type: "array"
        items: {
          type: "object"
          required: ["paymentId"]
          properties: {
            amount: {
              type: "integer"
              description: "The amount of the payment in minor units"
            }
            autoWithdrawnReasonCode: {
              type: "string"
              description: "Populated only if the payment was automatically withdrawn during instruction for being invalid"
            }
            currency: {
              type: "string"
              description: "The currency that the payment was made in"
            }
            payee: {
              type: "object"
              description: "Payee data associated with a payment. Either individual or company must be populated"
              required: ["payeeId"]
              properties: {
                company: {
                  type: "object"
                  required: ["companyName"]
                  properties: {
                    companyName: {
                      type: "string"
                    }
                  }
                }
                individual: {
                  type: "object"
                  required: ["name"]
                  properties: {
                    name: {
                      type: "object"
                      required: ["firstName", "lastName"]
                      properties: {
                        firstName: {
                          type: "string"
                        }
                        lastName: {
                          type: "string"
                        }
                      }
                    }
                  }
                }
                payeeId: {
                  type: "string"
                  format: "uuid"
                }
              }
            }
            paymentId: {
              type: "string"
              format: "uuid"
              description: "The id of the payment"
            }
            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: "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"
            }
            status: {
              type: "string"
              description: "Current status of payment. One of the following values: SUBMITTED, ACCEPTED, REJECTED, WITHDRAWN, RETURNED, AWAITING_FUNDS, FUNDED, UNFUNDED, CANCELLED, BANK_PAYMENT_REQUESTED"
            }
            transmissionType: {
              type: "string"
              description: "The transmission method of the payment. One of the following values: ACH, SAME_DAY_ACH, WIRE, LOCAL, SWIFT"
            }
            withdrawable: {
              type: "boolean"
              description: "Can this paynent be withdrawn"
            }
          }
        }
      }
      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"
          }
        }
      }
    }
  }
}