Get payment request
Get payment request
Path Parameters
guid string required
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
paymentRequest object
id int64
version int64
amount number
timeStamp date-time
source string
sourceInfo string
status string
ttl int64
paymentType string
guid string
refundStatus string
paymentRequestAttributes object[]
id int64
name string
value string
invoice object
id int64
version int64
guid string
invoiceStatus string
amount number
invoiceDate date-time
description string
refundedAmount number
paidDate date-time
signatureFileName string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
transactions object[]
id int64
transactionType object
id int64
shortCode string
description string
deposit int64
fee int64
description string
transDate date-time
transAmount number
accountBalance number
transRefNum string
details string
category string
source string
isReconciled boolean
isSettled boolean
reconciledDate date-time
settledDate date-time
deviceId int64
paymentGatewayTransId string
isVoided boolean
paymentProvider string
reminderDate date-time
reminderMileage int64
fileName string
dealerOrder object
id int64
orderNumber string
orderType string
amount number
orderDate date-time
description string
orderStatus string
invoiceURL string
readyROData string
mileageText string
departmentType string
labourOpTypes string
dmsdescription string
uuid string
updated_dt date-time
created_dt date-time
payTypes string
laborTypes string
tagOrHat string
vehicle object
id int64
version int64
brand object
id int64
version int64
brandName string
isValid boolean
vin string
hasObddevice boolean
licensePlate string
boughtDate date-time
soldDate date-time
addedDate date-time
model string
year string
trim string
engine string
body string
latestMileage string
transmission string
name string
make string
mileage string
isPrimary boolean
lastServiceDate date-time
licenseStateCode string
licenseStateDescription string
vehicleKey string
status string
parent int64
color string
uuid string
isValid boolean
signatureRequestID int64
paidAmount number
deliveryAmount number
customerSignatureUrl string
paid boolean
paidOnline boolean
paymentRequestSent boolean
dealer object
id int64
name string
contractName string
number string
comments string
isValid boolean
phoneNumber string
emailID string
website string
mapUrl string
pickupOffered boolean
dropoffOffered boolean
shuttleOffered boolean
couponOffered boolean
loanerOffered boolean
serviceDeptHoursText string
partsDeptHoursText string
salesDeptHoursText string
fiDeptHoursText string
inNetwork boolean
latitude float
longitude float
altitude float
isSystemDealer boolean
nickName string
uuid string
invoiceAttributes object[]
option string
value string
customer object
id int64 deprecated
firstName string
middleName string
lastName string
gender string
company string
nickName string
customerKey string
imageUrl string
guid string
isValid boolean
status string
optedOut boolean
isIndexed boolean
preferredLocale string
availability int32
phone string
email string
phoneCommunicationId int64
emailCommunicationId int64
salesTax number
maxSurcharge number
maxSurchargePercent number
isDualPricing boolean
isSurcharge boolean
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
],
"paymentRequest": {
"id": 0,
"version": 0,
"amount": 0,
"timeStamp": "2024-11-04T10:14:17.181Z",
"source": "string",
"sourceInfo": "string",
"status": "string",
"ttl": 0,
"paymentType": "string",
"guid": "string",
"refundStatus": "string",
"paymentRequestAttributes": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"invoice": {
"id": 0,
"version": 0,
"guid": "string",
"invoiceStatus": "string",
"amount": 0,
"invoiceDate": "2024-11-04T10:14:17.181Z",
"description": "string",
"refundedAmount": 0,
"paidDate": "2024-11-04T10:14:17.181Z",
"signatureFileName": "string",
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
},
"transactions": [
{
"id": 0,
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"description": "string",
"transDate": "2024-11-04T10:14:17.181Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2024-11-04T10:14:17.181Z",
"settledDate": "2024-11-04T10:14:17.181Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"paymentProvider": "string"
}
],
"reminderDate": "2024-11-04T10:14:17.181Z",
"reminderMileage": 0,
"fileName": "string",
"dealerOrder": {
"id": 0,
"orderNumber": "string",
"orderType": "string",
"amount": 0,
"orderDate": "2024-11-04T10:14:17.181Z",
"description": "string",
"orderStatus": "string",
"invoiceURL": "string",
"readyROData": "string",
"mileageText": "string",
"departmentType": "string",
"labourOpTypes": "string",
"dmsdescription": "string",
"uuid": "string",
"updated_dt": "2024-11-04T10:14:17.181Z",
"created_dt": "2024-11-04T10:14:17.181Z",
"payTypes": "string",
"laborTypes": "string",
"tagOrHat": "string",
"vehicle": {
"id": 0,
"version": 0,
"brand": {
"id": 0,
"version": 0,
"brandName": "string",
"isValid": true
},
"vin": "string",
"hasObddevice": true,
"licensePlate": "string",
"boughtDate": "2024-11-04T10:14:17.181Z",
"soldDate": "2024-11-04T10:14:17.181Z",
"addedDate": "2024-11-04T10:14:17.181Z",
"model": "string",
"year": "string",
"trim": "string",
"engine": "string",
"body": "string",
"latestMileage": "string",
"transmission": "string",
"name": "string",
"make": "string",
"mileage": "string",
"isPrimary": true,
"lastServiceDate": "2024-11-04T10:14:17.181Z",
"licenseStateCode": "string",
"licenseStateDescription": "string",
"vehicleKey": "string",
"status": "string",
"parent": 0,
"color": "string",
"uuid": "string",
"isValid": true
},
"signatureRequestID": 0,
"paidAmount": 0,
"deliveryAmount": 0,
"customerSignatureUrl": "string",
"paid": true,
"paidOnline": true,
"paymentRequestSent": true
},
"dealer": {
"id": 0,
"name": "string",
"contractName": "string",
"number": "string",
"comments": "string",
"isValid": true,
"phoneNumber": "string",
"emailID": "string",
"website": "string",
"mapUrl": "string",
"pickupOffered": true,
"dropoffOffered": true,
"shuttleOffered": true,
"couponOffered": true,
"loanerOffered": true,
"serviceDeptHoursText": "string",
"partsDeptHoursText": "string",
"salesDeptHoursText": "string",
"fiDeptHoursText": "string",
"inNetwork": true,
"latitude": 0,
"longitude": 0,
"altitude": 0,
"isSystemDealer": true,
"nickName": "string",
"uuid": "string"
},
"invoiceAttributes": [
{
"option": "string",
"value": "string"
}
],
"customer": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"company": "string",
"nickName": "string",
"customerKey": "string",
"imageUrl": "string",
"guid": "string",
"isValid": true,
"status": "string",
"optedOut": true,
"isIndexed": true,
"preferredLocale": "string",
"availability": 0,
"phone": "string",
"email": "string",
"phoneCommunicationId": 0,
"emailCommunicationId": 0
}
},
"salesTax": 0,
"maxSurcharge": 0,
"maxSurchargePercent": 0,
"isDualPricing": true,
"isSurcharge": true
}
}
Bad Request
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
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
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
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
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
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...