MENU
      Login
          Login
          Contents x
          /v23.1/PaymentTypes
          • 05 Jun 2024
          • 2 Minutes to read
          • Contributors
          • Print
          • Dark
          • PDF
          Contents

          /v23.1/PaymentTypes

          • Updated on 05 Jun 2024
          • 2 Minutes to read
          • Contributors
          • Print
          • Dark
          • PDF
          Article summary

          Post
          /v23.1/PaymentTypes
          Security
          HTTP
          Type Bearer

          Please enter a valid token

          Body parameters
          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          Responses
          200

          Success

          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          object
          itemId
          integer (int32)
          createdByUserId
          integer (int32)
          createdDateTime
          string (date-time)
          lastModifiedByUserId
          integer (int32)
          lastModifiedDateTime
          string (date-time)
          organizationId
          integer (int32)
          companyId
          integer (int32)
          customerId
          integer (int32)
          saleTypeId
          integer (int32)
          currencyId
          integer (int32)
          ledgerId
          integer (int32)
          giftCardTypeId
          integer (int32)
          shortDescription
          string
          description
          string
          minimumAmount
          number (double)
          maximumAmount
          number (double)
          paymentType
          string
          Valid values[ "NotSpecified", "Cash", "EFT", "Chip", "Cheque", "Voucher", "CreditCard", "ManualEftSwipe", "CashGuard", "GiftCard", "CashproCM18", "PreApprovedEFT", "NoCustomerEft", "Invoice" ]
          shortKey
          string
          eftDeviceNumber
          integer (int32)
          maximumEftOverPayment
          number (double)
          copyReceipts
          integer (int32)
          allowanceValue
          number (double)
          allowancePercentage
          number (double)
          allowanceProductId
          integer (int32)
          eftIssuerCodes
          string
          isChangeAllowed
          boolean
          Default"False"
          isOpenCashDrawer
          boolean
          Default"False"
          isCancelled
          boolean
          Default"False"
          isRoundAmount
          boolean
          Default"False"
          isAutoCalculateChange
          boolean
          Default"False"
          isCompressLedger
          boolean
          Default"False"
          signatureRequired
          boolean
          Default"False"
          confirmPaymentType
          boolean
          Default"False"
          tag
          string
          followupNumber
          integer (int32)
          400

          Bad Request

          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          401

          Unauthorized

          object
          type
          string
          message
          string
          stackTrace
          string
          object
          type
          string
          message
          string
          stackTrace
          string
          object
          type
          string
          message
          string
          stackTrace
          string
          403

          Forbidden

          object
          type
          string
          message
          string
          stackTrace
          string
          object
          type
          string
          message
          string
          stackTrace
          string
          object
          type
          string
          message
          string
          stackTrace
          string
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout