prePayment

prePayment

application/json

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

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

object

{}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...