transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
<= 1048576 characters
Example:EVR
Get fees calculated by the transaction
Get fees calculated by the transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/fees
Query Parameters
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 1048576 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Response
application/json
Response
application/json
OK
<= 100000 items
namestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Sample Name
valuenumber(decimal)
>= -1000000000000000<= 1000000000000000
Example:100
feeTypestring
Allowed values:StateFeeStateTaxVendorFeeOtherUseTaxPaidTaxExemptionTaxPaidPenaltyReciprocityCredit
<= 1048576 characters
Example:StateFee
ratenumber(decimal)
>= -1000000000000000<= 1000000000000000
Example:100
detailsarray[object]
<= 100000 items
Show Child Parameters
get/transaction/{transactionId}/fees
Authentication
Path Parameters
Query Parameters
Headers
application/json
Utils
Utils operations
Get transaction ID by Reference Number provided on Create
Get transaction ID by Reference Number provided on Create
get
https://api-test.vitu.com/national-public-api/v2/transactionId/{refNumber}
Path Parameters
refNumberstring(uuid)required
refNumber parameter
<= 1048576 characters
Response
application/json
Response
application/json
OK
integer(int64)
>= -9007199254740991<= 9007199254740991
get/transactionId/{refNumber}
Authentication
Path Parameters
application/json
Customer
Customer operations
Get customer info from state for EVR requests
Requests state information for EVR requests
post
https://api-test.vitu.com/national-public-api/v2/customer/lookup
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Body
application/json
Body
application/json
CustomerLookupDTO
locationIdinteger(int64)required
Id that represents dealer location in vitu. Provided by vitu, required
>= -9007199254740991<= 9007199254740991
Example:1
statestringrequired
Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWY
<= 1048576 characters
Example:VA
searchBystringrequired
Allowed values:DriverLicenseNumberSsnNameBusinessLienholder
<= 1048576 characters
Example:DriverLicenseNumber
driverLicenseNumberstring
Indicates Customer’s driver license number.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:D1234567
firstNamestring
Indicates Customer’s first name.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:John
lastNamestring
Indicates Customer’s last name.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Doe
dateOfBirthstring(date)
Indicates Customer’s date of birth.
<= 1048576 characters
Example:2024-03-15
ssnstring | null
Customer’s Social Security Number.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:123-45-6789
feinstring | null
Indicates the assigned FEIN; typically required of a business or other organization.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:12-3456789
businessNamestring
Indicates business name.
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Acme Auto Sales LLC
stateTransactionIdstring
State transaction identifier. Could be required, depending on state
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:1234567
Response
application/json
Response
application/json
OK
CustomerLookupResponseDTO
customersarray[object]
<= 100000 items
Show Child Parameters
post/customer/lookup
Authentication
Headers
Body
{
"locationId": 1,
"state": "VA",
"searchBy": "DriverLicenseNumber"
}
application/json