action velopayments_get_payment_details_v4 {
  label: "Get Payment"
  description: "Get the payment with the given id. This contains the payment history.\n"
  provider: velopayments
  method: GET
  path: "/v4/paymentaudit/payments/{paymentId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      paymentId: {
        type: "string"
        format: "uuid"
      }
      sensitive: {
        type: "boolean"
      }
    }
    required: ["paymentId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["events", "fundingStatus", "payeeId", "paymentAmount", "paymentId", "payorId", "quoteId", "railsId", "sourceAccountId", "status", "submittedDateTime"]
    properties: {
      accountName: {
        type: "string"
      }
      accountNumber: {
        type: "string"
        description: "The account number for the account which will receive the payment."
      }
      autoWithdrawnReasonCode: {
        type: "string"
        description: "Populated with rejection reason code if the payment was withdrawn automatically at instruct time"
      }
      countryCode: {
        type: "string"
        description: "The country code of the payment channel."
      }
      events: {
        type: "array"
        items: {
          type: "object"
          required: ["eventDateTime", "eventId", "eventType"]
          properties: {
            accountName: {
              type: "string"
            }
            accountNumber: {
              type: "string"
              description: "The account number attached to the event."
            }
            eventDateTime: {
              type: "string"
              format: "date-time"
              description: "The date/time at which the event occurred."
            }
            eventId: {
              type: "string"
              format: "uuid"
              description: "The id of the event."
            }
            eventType: {
              type: "string"
              description: "One of the following values: PAYOUT_SUBMITTED, PAYOUT_COMPLETED, PAYOUT_INSTRUCTED_V3, BANK_PAYMENT_REQUESTED, SOURCE_AMOUNT_CONFIRMED, PAYMENT_SUBMITTED, PAYMENT_SUBMITTED_ACCEPTED, PAYMENT_SUBMITTED_REJECTED, PAYMENT_CONFIRMED, PAYMENT_AWAITING_FUNDS, PAYMENT_FUNDED, PAYMENT_UNFUNDED, PAYMENT_FAILED, PAYMENT_TRACKING_DETAILS_UPDATED, ACH_SUBMITTED_TO_ODFI, PAYMENT_ACCEPTED_BY_RAILS, ACH_RETURN_RECEIVED, RETURN_PAYMENT_FUNDING_REQUESTED, PAYOUT_BATCH_EXECUTED, PAYOUT_BATCH_QUOTE_EXPIRED, PAYOUT_BATCH_FUNDED, PAYOUT_BATCH_FUNDS_RETURN_REQUEST, PAYOUT_BATCH_FUNDS_RETURNED, PAYOUT_FUNDS_REQUEST, PAYOUT_FUNDS_GRANTED, PAYOUT_FUNDS_DENIED, PAYOUT_BATCH_QUOTED, PAYOUT_QUOTED, ACH_PAYMENT_RETURN_CANCELLED, RETURN_PAYMENT_CANCELLATION_REQUESTED, PAYOUT_WITHDRAWN, ORCHESTRATED_PAYMENT_BATCH_REQUESTED, ORCHESTRATED_PAYMENT_BATCH_CONFIRMED, ORCHESTRATED_PAYMENT_REQUESTED"
            }
            iban: {
              type: "string"
            }
            paymentAmount: {
              type: "integer"
              format: "int64"
              description: "The destination amount exposed by the event."
            }
            paymentCurrency: {
              type: "string"
              description: "ISO-4217 3 character currency code"
            }
            principal: {
              type: "string"
            }
            routingNumber: {
              type: "string"
              description: "The routing number attached to the event."
            }
            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."
            }
            scheduledFor: {
              type: "string"
              format: "date-time"
            }
            sourceAmount: {
              type: "integer"
              format: "int64"
              description: "The source amount exposed by the event."
            }
            sourceCurrency: {
              type: "string"
              description: "ISO-4217 3 character currency code"
            }
          }
        }
      }
      filenameReference: {
        type: "string"
        description: "ACH file payment was submitted in, if applicable"
      }
      fundingStatus: {
        type: "string"
        description: "Current funding status of the payment. One of the following values: FUNDED, INSTRUCTED, UNFUNDED"
      }
      iban: {
        type: "string"
        description: "The iban for the payment."
      }
      individualIdentificationNumber: {
        type: "string"
        description: "Individual Identification Number assigned to the payment in the ACH file, if applicable"
      }
      invertedRate: {
        type: "number"
        format: "double"
        description: "The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed"
      }
      isPaymentCcyBaseCcy: {
        type: "boolean"
      }
      payeeAddressCountryCode: {
        type: "string"
        description: "The country code of the payee's address."
      }
      payeeId: {
        type: "string"
        format: "uuid"
        description: "The id of the paymeee"
      }
      paymentAmount: {
        type: "integer"
        description: "The amount which the payee will receive"
      }
      paymentChannelId: {
        type: "string"
      }
      paymentChannelName: {
        type: "string"
      }
      paymentCurrency: {
        type: "string"
        description: "ISO-4217 3 character currency code"
      }
      paymentId: {
        type: "string"
        format: "uuid"
        description: "The id of the payment"
      }
      paymentMemo: {
        type: "string"
        description: "The payment memo set by the payor"
      }
      paymentMetadata: {
        type: "string"
        description: "Metadata for the payment"
      }
      paymentScheme: {
        type: "string"
      }
      paymentTrackingReference: {
        type: "string"
      }
      payorId: {
        type: "string"
        format: "uuid"
        description: "The id of the payor"
      }
      payorName: {
        type: "string"
        description: "The name of the payor"
      }
      payorPaymentId: {
        type: "string"
      }
      payout: {
        properties: {
          payoutFrom: {
            type: "object"
            description: "Details of payor and principal participating in a payout."
            required: ["dbaName", "payorId", "payorName", "principal", "principalId"]
            properties: {
              dbaName: {
                type: "string"
                description: "The alternate name of the payor."
              }
              payorId: {
                type: "string"
                format: "uuid"
                description: "The id of the payor."
              }
              payorName: {
                type: "string"
                description: "The name of the payor."
              }
              principal: {
                type: "string"
                description: "Email address if principal is a user or ID if application."
              }
              principalId: {
                type: "string"
                format: "uuid"
                description: "The id of the principal."
              }
            }
          }
          payoutId: {
            type: "string"
            format: "uuid"
          }
          payoutTo: {
            type: "object"
            additionalProperties: true
          }
        }
      }
      postInstructFxInfo: {
        type: "object"
        description: "FX details relating to a payout that was executed or is still waiting to be executed"
        required: ["fxMode", "fxStatus", "fxStatusUpdatedAt"]
        properties: {
          fxMode: {
            type: "string"
            description: "The mode by which the FX rate is to be determined (MANUAL or AUTO)"
          }
          fxStatus: {
            type: "string"
            description: "The state to which the Post-Instruct FX process has reached (INITIATED or COMPLETED)"
          }
          fxStatusUpdatedAt: {
            type: "string"
            format: "date-time"
            description: "The date-time at which the most recent fxStatus was determined."
          }
          fxTransactionReference: {
            type: "string"
            description: "The reference assigned to the FX funding that will fulfil this payment."
          }
        }
      }
      quoteId: {
        type: "string"
        format: "uuid"
        description: "The quote Id used for the FX"
      }
      railsBatchId: {
        type: "string"
      }
      railsId: {
        type: "string"
        description: "The rails ID. Default value is RAILS ID UNAVAILABLE when not populated."
      }
      railsPaymentId: {
        type: "string"
      }
      rate: {
        type: "number"
        format: "double"
        description: "The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed"
      }
      rejectionReason: {
        type: "string"
      }
      remoteId: {
        type: "string"
        description: "The remote id by which the payor refers to the payee. Only populated once payment is confirmed"
      }
      remoteSystemId: {
        type: "string"
        description: "The velo id of the remote system orchestrating the payment. Not populated for normal Velo payments."
      }
      remoteSystemPaymentId: {
        type: "string"
        description: "The id of the payment in the remote system. Not populated for normal Velo payments."
      }
      returnCost: {
        type: "integer"
        description: "The return cost if a returned payment."
      }
      returnReason: {
        type: "string"
      }
      routingNumber: {
        type: "string"
        description: "The routing number for the payment."
      }
      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"
          }
        }
      }
      sourceAccountId: {
        type: "string"
        format: "uuid"
        description: "The id of the source account from which the payment was taken"
      }
      sourceAccountName: {
        type: "string"
        description: "The name of the source account from which the payment was taken"
      }
      sourceAmount: {
        type: "integer"
        description: "The source amount for the payment (amount debited to make the payment)"
      }
      sourceCurrency: {
        type: "string"
        description: "ISO-4217 3 character currency code"
      }
      status: {
        type: "string"
        description: "Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, RETURNED, WITHDRAWN"
      }
      submittedDateTime: {
        type: "string"
        format: "date-time"
      }
      traceNumber: {
        type: "string"
        description: "Trace Number assigned to the payment in the ACH file, if applicable"
      }
      transmissionType: {
        type: "string"
        description: "The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE, GACHO"
      }
      withdrawable: {
        type: "boolean"
      }
      withdrawnReason: {
        type: "string"
      }
    }
  }
}