Skip to main content

prePayment​


ApiScope: payment.prepayment
API Scope Level: ServiceSubscriberScope
Request Body required
    dealerUuid string
    customerUuid string
    orderNumber string
    invoiceGUID string
    customerID int64 deprecated
    paymentUserID int64 deprecated
    currentPaymentUser object
    id int64
    dealerAssociateUUID string
    userUUID string
    dealerDepartmentUUID string
    originalPaymentUserId int64 deprecated
    originalPaymentUser object
    id int64
    dealerAssociateUUID string
    userUUID string
    dealerDepartmentUUID string
    dealerID int64 deprecated
    desc string
    amount number
    dealerOrderAmount number
    dealerOrderUuid string
    reminderDate string
    reminderMileage int64
    orderType string
    isMobilePayment boolean
    fetchDuplicateTransactionWindow boolean
    fetchEnforceCvvDso boolean
    fetchEnforceZipDso boolean
    skin string
    locale string
    cardDigits string
    ignorePaymentAttemptValidation boolean
    isThirdPartyVendor boolean
    paymentProvider string
    transactionTypeShortCode string
    signatureType string deprecated
    signatureData string deprecated
    ipAddress string deprecated
    transactionDetailsList object
    transactionDetails object[]
  • Array [
    • id int64
    transactionId int64
    transactionIncompleteId int64
    type string
    amount number
    description string
  • ]
    • feeRequest object
    fetchSurcharge boolean
    fetchApplicationFee boolean
    dealerId int64
    tenderType string

    Possible values: [CREDIT, DEBIT, CASH, ACH]

    cardType string

    Possible values: [VISA, MAST, DISC, AMEX, DINER, JCB]

    transactionDepartment string

    Possible values: [SERVICE, PARTS, SALES, BODYSHOP, LOANER, FINANCE, MANAGEMENT]

    paymentType string

    Possible values: [ONLINE, MANUAL, RETAIL]

    dealerUuid string
    attributes object
    property name* string
Responses

OK

Schema

    object

POST /kpayment/v1/prepayment

Request

Base URL
/payment
Body required
{

  "dealerUuid": "string",

  "customerUuid": "string",

  "orderNumber": "string",

  "invoiceGUID": "string",

  "currentPaymentUser": {

    "id": 0,

    "dealerAssociateUUID": "string",

    "userUUID": "string",

    "dealerDepartmentUUID": "string"

  },

  "originalPaymentUser": {

    "id": 0,

    "dealerAssociateUUID": "string",

    "userUUID": "string",

    "dealerDepartmentUUID": "string"

  },

  "desc": "string",

  "amount": 0,

  "dealerOrderAmount": 0,

  "dealerOrderUuid": "string",

  "reminderDate": "string",

  "reminderMileage": 0,

  "orderType": "string",

  "isMobilePayment": true,

  "fetchDuplicateTransactionWindow": true,

  "fetchEnforceCvvDso": true,

  "fetchEnforceZipDso": true,

  "skin": "string",

  "locale": "string",

  "cardDigits": "string",

  "ignorePaymentAttemptValidation": true,

  "isThirdPartyVendor": true,

  "paymentProvider": "string",

  "transactionTypeShortCode": "string",

  "transactionDetailsList": {

    "transactionDetails": [

      {

        "id": 0,

        "transactionId": 0,

        "transactionIncompleteId": 0,

        "type": "string",

        "amount": 0,

        "description": "string"

      }

    ]

  },

  "feeRequest": {

    "fetchSurcharge": true,

    "fetchApplicationFee": true,

    "dealerId": 0,

    "tenderType": "CREDIT",

    "cardType": "VISA",

    "transactionDepartment": "SERVICE",

    "paymentType": "ONLINE",

    "dealerUuid": "string"

  },

  "attributes": {}

}
curl / cURL
curl -L -X POST '/payment/kpayment/v1/prepayment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuid": "string",
  "customerUuid": "string",
  "orderNumber": "string",
  "invoiceGUID": "string",
  "currentPaymentUser": {
    "id": 0,
    "dealerAssociateUUID": "string",
    "userUUID": "string",
    "dealerDepartmentUUID": "string"
  },
  "originalPaymentUser": {
    "id": 0,
    "dealerAssociateUUID": "string",
    "userUUID": "string",
    "dealerDepartmentUUID": "string"
  },
  "desc": "string",
  "amount": 0,
  "dealerOrderAmount": 0,
  "dealerOrderUuid": "string",
  "reminderDate": "string",
  "reminderMileage": 0,
  "orderType": "string",
  "isMobilePayment": true,
  "fetchDuplicateTransactionWindow": true,
  "fetchEnforceCvvDso": true,
  "fetchEnforceZipDso": true,
  "skin": "string",
  "locale": "string",
  "cardDigits": "string",
  "ignorePaymentAttemptValidation": true,
  "isThirdPartyVendor": true,
  "paymentProvider": "string",
  "transactionTypeShortCode": "string",
  "transactionDetailsList": {
    "transactionDetails": [
      {
        "id": 0,
        "transactionId": 0,
        "transactionIncompleteId": 0,
        "type": "string",
        "amount": 0,
        "description": "string"
      }
    ]
  },
  "feeRequest": {
    "fetchSurcharge": true,
    "fetchApplicationFee": true,
    "dealerId": 0,
    "tenderType": "CREDIT",
    "cardType": "VISA",
    "transactionDepartment": "SERVICE",
    "paymentType": "ONLINE",
    "dealerUuid": "string"
  },
  "attributes": {}
}'