API Schema

  • Updated on Sep 25, 2025
  • Published on Jan 10, 2022
  • 11 minute(s) read
  • Jason Enneking
  • Draft Writer
  • Mathew Deyo
 Prev Next

This article contains detailed information on each request and response body.

ApplicationRequest

Field Type Description Required Format
clientId String Optional id to track this application.
location String ID that UGA provides you, representing your physical location. ✔ Maximum 9 characters
program String ID that UGA provides you, representing your program set up. ✔ Maximum 5 characters
status Status Set the status to DRAFT to allow edits, PROCESS to run decisioning, or PREQUAL to run prequalification. ✔
contract Contract Contract level details.
applicant Contact The individual applying for credit. ✔
coApplicant Contact Additional individual on the credit application (if there is one).
fingerprint Fingerprint Consumer tracking information collected during the origination process.

Status

Enum Description
DRAFT Save the application without processing it, allows eidts
PREQUAL Prequalifies the application with consumer with only Name, Address, Email, and Phone Number
PROCESS Process the application

Contract

Field Type Description Required Format
cashPrice Currency Cash price of the product or service that the applicant is financing
downPayment Currency Down payment amount on the product or service 12345.12
description String Description of product or service being financed
estimatedDeliveryDate Date Delivery date of the product or service being financed

Contact

Field Type Description Required to PROCESS Required to PREQUAL Format
firstName String Contact's first name ✔ ✔ Maximum 40 characters
middleInitial String Contact's middle initial Maximum 1 character
lastName String Contact's last name ✔ ✔ Maximum 80 characters
suffix String Contact's Generational Suffix null, "", "SR", "JR", "I", "II", "III", "IV", "V", "VI", "VII", "VIII", "IX"
email String Contact's email address ✔ ✔ Email
ssn String Contact's social security number ✔ Either 4 digits or full SSN based on your program configuration
dob Date Date of birth ✔ YYYY-MM-DD (ISO 8601)
primaryNumber String Contact's primary number ✔ ✔ +1########## (E.164)
primaryNumberType PhoneType Type of phone number ✔ ✔
secondaryNumber String Contact's secondary number +1########## (E.164)
secondaryNumberType PhoneType Type of phone number
annualIncome Currency Contact's annual income ✔ Maximum of 240000.00. Value may have up to 2 fractional digits
residenceMonthlyExpense Currency Monthly expense towards place of residence
residenceType Enum Contact's residence type RENT | OWN
employmentType Enum Contact's type of employment EMPLOYED | HOMEMAKER | RETIRED | SELF_EMPLOYED | SOCIAL_SECURITY_DISABILITY | UNEMPLOYED
address Address Contact's address ✔ ✔

Address

Field Type Description Required Format
line1 String The first line of the contact’s address. House number and street address ✔ Maximum 255 characters
line2 String The second line of the contact’s address Maximum 255 characters
city String City the contact resides in ✔ Maximum 255 characters
state Enum State the contact resides in ✔ Must be a valid 2 digit State code
zip String Contact's zip code ✔ #####-#### (Pattern of ^[0-9]{5}(?:-[0-9]{4})?$)

Fingerprint

Field Type Description Required Format
profile String
ipAddress String Pattern of ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
deviceId String
deviceName String
coordinates Coordinates Latitude and longitude of the contact's location

Coordinates

Field Type Description Required Format
latitude Double The latitudinal coordinates of the contact's location
longitude Double The longitudinal coordinates of the contact's location

ContractChargeRequest

Dynamic Validation

Fields are dynamically validated based on your program configuration. When updating a charge, all request fields are optional.

Field Type Description Required Format
cashPrice Currency Cash price of the product or service that the applicant is financing 12345.12
downPayment Currency Down payment amount on the product or service 12345.12
description String Description of product or service being financed Maximum 255 characters
deliveryDate Date Delivery date of the product or service being financed YYYY-MM-DD (ISO 8601)
offer String ID of the selected offer from OfferDto#id

LinkResponse

Field Type Description
id String ID of the application
edit Link Link for editing the application
self Link Link to retrieve the application

Link

Field Type Description
href String URL
method String HTTP method

StandardResponse

Extends LinkResponse

Field Type Description
status ApplicationStatus Status of the application
pendingReason PendingReason Why the application is in a PENDING status
creditLine Currency The application's credit line
interestRate Percentage Interest rate for the application
pricingTier String Pricing Tier for the application
applyUrl String URL to view the application in the Apply Interface
uportal360Url String URL to view the application in uPortal360

DraftResponse

Extends LinkResponse

Field Type Description
applyUrl String URL to view the application in the Apply Interface
status ApplicationStatus Status of the application

SuccessResponse

Field Type Description
applyUrl String URL to view the application in the Apply Interface
uPortal360Url String URL to view the application in uPortal360
account Account The contract's account
contract Contract Newly created contract

Account

Field Type Description
id String ID of the account

Contract

Field Type Description
id String ID of the contract
decision Decision The credit decision of the contract
creditLine Currency The credit line of the contract
interestRate Percentage Interest rate for the contract

Decision

Enum
PURCHASING
SERVICING

DeclinedResponse

Extends LinkResponse

Field Type Description
status ApplicationStatus Status of the application

CreditApplicationResponse

Field Type
application Application

Application

Field Type Description
id String ID of the application
accountNumber String Credit application's account number
status String Status of the application
pendingReason PendingReason Why the application is in a PENDING status
program String Echoed program specified in the ApplicationRequest
location String Echoed location specified in the ApplicationRequest
clientId String Echoed clientId specified in the ApplicationRequest
contract Contract
applicant Contact
coApplicant Contact
creditLine Currency Amount of credit avaliable for the credit application
interestRate Percentage Interest rate of the offer
pricingTier String Pricing Tier of the offer
preQualAttempted Boolean Indicates if PreQual was attempted for the credit application

Contract

Field Type Description
cashPrice Currency Cash price of the product or service that the applicant is purchasing
downPayment Currency Down payment amount on the product or service
description String Description of product or service being purchased
email String The applicant's email
id String ID of the contract
status String Status of the contract
subStatus String Sub Status of the contract
credit CreditDto Information about the contract's credit line

Contact

Field Type Description
firstName String Consumer's first name
middleInitial String Consumer's middle initial
lastName String Consumer's last name
suffix String Consumer's generational suffix
email String Consumer's email address
dob Date Consumer's date of birth
ssnLast4 String Last 4 digits of the consumer's SSN
primaryNumber String Primary phone number
primaryNumberType PhoneType Type of primary phone
secondaryNumber String Secondary phone number
secondaryNumberType PhoneType Type of secondary number
annualIncome Currency Consumer's annual income
residenceMonthlyExpense Currency Monthly expense towards place of residence
residenceType Enum (RENT | OWN) Contact's residence type
address Address Consumer's address

Address

Field Type
line1 String
line2 String
city String
state String
zip String

ApplicationStatus

Enum Description
APPROVED The application has been approved for credit
CREDIT_FREEZE The applicant’s credit report is frozen
DRAFT The application has not yet been processed and may still be edited.
DECLINED The application has been declined
ERROR An error occurred while processing the application. Try again or reach out to the UGA team for more information
MANUAL_REVIEW The application must undergo a manual review by the UGA team before processing may resume
NO_HIT The applicant’s information was not found during the credit check. PATCH the application with updated information to try again
PENDING Action must be taken before processing may resume. See the CreditApplicationResponse#pendingReason or StandardResponse#pendingReason field for context
PREQUAL The applicant’s information meets the requirements for PreQual; however, this does not guarantee approval, and the final decision may differ
SECOND_NO_HIT The applicant’s information was not found during the credit check twice
UNQUALIFIED Based on the applicant’s provided information, they do not meet the requirements for PreQual; however, the final decision may still differ

PendingReason

Enum Description
CREDIT_REVIEW The application must undergo a credit review.
IDENTITY_VERIFICATION The applicant must go through the KYC questions.
MERCHANT_DISCOUNT_ACCEPTANCE The client must accept the purchasing discount and confirm the charge amount in uPortal360
UNRESOLVED_DATA_MISMATCH The application information could not be validated, the applicant must upload their id cards.

PhoneType

Enum
HOME
MOBILE
WORK
OTHER

CreditDto

Field Type Description
used Currency The amount of the credit line that has been applied towards financing
limit Currency The credit limit for this contract
remaining Currency The available credit that may be applied towards financing
type String Type of the line of credit. Closedor Open

BalanceDto

Field Type Description
principal Currency The principal amount financed for the contract
interest Currency The interest remaining on the contract
fees Currency The fees remaining on the contract
total Currency The total remaining on the contract

OffersResponse

Field Type Description
applicationId String ID of the application
requestedFinancedAmount Currency The net amount to be financed
credit CreditDto Information about the contract's credit line
offers OfferDto[] Available offers for the application and amount financed. Will return empty array if no offers are available.
message String If no offers are available, a message is returned.
isEditable boolean Denotes if the charge could be edited.

OfferDto

Field Type Description
apr Percentage Interest rate of the offer
downPayment Currency Down payment required by the offer
estimatedPayment Currency Estimated monthly payment
financeCharge Currency Financed amount charge
id String ID of the offer
interestRate Percentage Interest rate of the offer
maxAmountFinanced Currency Amount financed must be less than or equal to this to select this offer
minAmountFinanced Currency Amount financed must be greater than or equal to this to select this offer
minPaymentFactor Percentage Minimum percentage of the balance to be payed each month
minPaymentFixed Currency Minimum monthly payment amount of the offer
promo PromoDto Promotional information
term Integer Length of the offer
totalOfPayments Currency Total monthly payments amount
totalSalePrice Currency Total monthly payments amount plus down payment

PromoDto

Field Type Description
term Integer Length of the promotional period
verbiage String Details of the promotional offer
paymentToPayoff Currency Minimum monthly payment to payoff balance within promotional period
apr Percentage Interest rate within the promotional period

AcceptResponse

Field Type Description
applyUrl String URL to view the application in the Apply Interface
uportal360Url String URL to view the application in uPortal360
account Account The contract's account
contract Contract Newly created contract

ContractChargeResponse

Field Type Description
id String ID of the charge
signatureUrl String URL for consumer to sign agreements
date Date Date of the charge
status String Status of the charge
term Integer Length of the offer
cashPrice Currency Cash price of the product or service that the applicant is financing
downPayment Currency Down payment amount on the product or service
amount Currency Amount of the charge
balance Currency Remaining balance of the charge
description String Description of product or service that the applicant is financing
deliveryDate Date Delivery date of the product or service being financed
offer OfferDto Selected offer
availableOffers OfferDto[] List of available offers
self Link Link to retrieve the charge
edit Link Link to edit the charge

Account

Field Type Description
id String ID of the account
self Link URL to retrieve the account

Contract

Field Type Description
id String ID of the contract
decision APPROVED (Future API versions may have more values) The decision for the contract
self Link URL to retrieve the contract
credit CreditDto Information about the contract's credit line

ContractsResponse

Field Type Description
id String ID of the contract
applicant Contact The individual applying for credit.
status String The status of the contract
substatus String The sub status of the contract
noteDate String The date of the contract
firstPaymentDate String The first payment date of the contract
delinquentDays Integer The number of delinquent days on the contract
minimumAddChargeAmount Integer The minimum amount required for adding a new charge
addChargeEligible boolean if the contract is eligible for adding a new charge
credit CreditDto Information about the contract's credit line
balance BalanceDto Information about the contract's balance
creditAppAccountNumber String The credit application's account number that is assigned to the contract
relatedCases Array List of cases associated with the contract
maxAllowableReturns Currency Maximum amount a return could be created for a charge by deducting prior adjustments.
merchantCode String Merchant code of the offer.

ContractChargeListResponse

Field Type Description
credit CreditDto Information about the contract's credit line
charges ContractChargeResponse[] List of charges for the contract

CreateClientRequest

Field Type Description
contractId String ID of the contract the case will link too
caseType CaseType The type of case to be created
reason Reason The Reason for the request
description String The text description of the case to be created

CaseType

String
Client Request

Reason

String
Change Consumer Contact Info
Change Next Payment Date
Contract Adjustment
Due Date Change
Cancel Contract
Report Client Payment
Other

CaseDataResponse

Field Type Description
caseId String Id of the Case
status String Case Status
assignTo String Department working the Case
reason String Reason for the Case
contractId String Related Contract Id
subject String Case Subject
description String Description of the Case
origin String Where the Case originated from
createdDate LocalDateTime Date Time the Case was created
closedDate LocalDateTime Date Time the Case was closed
holdDate LocalDateTime Date Time the Case was put on hold status
daysOpen BigDecimal Number of days the Case has been open
caseComments List<CaseComment> Related Case Comments

CaseComment

Field Type Description
commentNotes String Description of comment
createdDate LocalDateTime Date Time the comment was created

ContractReturnRequest

Field Type Description
chargeId String Charge slip Id (Optional) * Required for Revolvers i.e. Open line of credit
amount BigDecimal The Amount to be returned
reason String The reason of the return. Maximum 255 characters (Optional)
caseId String (Optional)* The case number the return is associated with

ContractReturnResponse

Field Type Description
id String Id of the transaction
chargeId String Chargeslip Id or Contract Id
reason String Return reason
date String Date of return
amount BigDecimal Amount of the return
status String Status of the return transaction
self Link Link to retrieve the return transaction