createFinanceOffer
createFinanceOffer
application/json
Request Body required
dealerUUID string
dealerOrderUUID string
customerUUID string
departmentUUID string
paymentAttemptUuid string
invoiceId int64
userConfirmationUrl string
userCancelUrl string
orderId string
total int32
financeFromText boolean
dealerName string
payTypes string
orderNumber string
orderType string
customerFirstName string
customerLastName string
line1 string
stateCode string
zip string
city string
stateDescription string
countryCode string
country string
email string
phone string
model string
make string
vin string
year string
signatureData string
signatureType string
ipAddress string
dealerId int64
dealerOrderId int64
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Example (from schema)
Schema
error object
warnings object[]
id int64
dealerUUID string
dealerOrderUUID string
customerUUID string
lenderId int64
url string
guid string
foAmount number
lenderLoanID string
status string
callbackId string
financeOfferAttributes object[]
financeEvents object[]
{
"error": {
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
},
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
],
"id": 0,
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"lenderId": 0,
"url": "string",
"guid": "string",
"foAmount": 0,
"lenderLoanID": "string",
"status": "string",
"callbackId": "string",
"financeOfferAttributes": [
{
"id": 0,
"financeOfferId": 0,
"option": "string",
"value": "string"
}
],
"financeEvents": [
{
"id": 0,
"version": 0,
"eventCode": "string",
"timeStamp": "2025-04-07T07:51:27.696Z",
"eventParam": "string",
"isVisible": true,
"eventText": "string"
}
]
}
Bad Request
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"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[]
warnings object[]
{
"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[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
POST /kpayment/v1/finance/financeOffer
Request
Request
curl / cURL
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
python / requests
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
go / native
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
nodejs / axios
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
ruby / Net::HTTP
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
csharp / RestSharp
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
php / cURL
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
java / OkHttp
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'
powershell / RestMethod
curl -L -X POST '/payment/kpayment/v1/finance/financeOffer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerUUID": "string",
"dealerOrderUUID": "string",
"customerUUID": "string",
"departmentUUID": "string",
"paymentAttemptUuid": "string",
"invoiceId": 0,
"userConfirmationUrl": "string",
"userCancelUrl": "string",
"orderId": "string",
"total": 0,
"financeFromText": true,
"dealerName": "string",
"payTypes": "string",
"orderNumber": "string",
"orderType": "string",
"customerFirstName": "string",
"customerLastName": "string",
"line1": "string",
"stateCode": "string",
"zip": "string",
"city": "string",
"stateDescription": "string",
"countryCode": "string",
"country": "string",
"email": "string",
"phone": "string",
"model": "string",
"make": "string",
"vin": "string",
"year": "string",
"signatureData": "string",
"signatureType": "string",
"ipAddress": "string",
"dealerId": 0,
"dealerOrderId": 0
}'