offers

Mutation

Get offers

Mutation Signature

mutation {
  offers(input: OffersInput!): OffersResponse!
}

Example Request

GraphQL

mutation Offers($input: OffersInput!) {
  offers(input: $input) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "input": {
    "firstPaymentDate": "2025/02/15",
    "uwResultId": "uw-xyz789",
    "revision": 2,
    "depositFrequency": "M",
    "depositIntervals": "15",
    "paymentTerm": "48",
    "includeSentryFee": true
  }
}

Apollo Studio

Open in Apollo Studio Explorer →

Click the link above to open this mutation in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.

Example Response

{
  "data": {
    "offers": {
      "data": [
        {
          "compTemplateId": 1001,
          "frequency": "M",
          "frequencyInterval": "15",
          "firstPaymentDate": "2025/02/15",
          "paymentTerm": "48",
          "maxPaymentTerm": "60",
          "enrolledDebt": "13500.00",
          "enrollmentPlanId": "plan-standard-48",
          "enrollmentPlanName": "Standard 48-Month Plan",
          "serviceFee": 3375,
          "estimatedSettlementFee": 6750,
          "totals": {
            "fee1": "3375.00",
            "fee2": "0.00",
            "fee3": "0.00",
            "fee4": "0.00",
            "fee5": "0.00",
            "fee6": "0.00",
            "fee7": "0.00",
            "savings": "3375.00",
            "totalPayment": "16875.00"
          },
          "payments": [
            {
              "paymentNumber": "1",
              "paymentDate": "2025/02/15",
              "totalPayment": "351.56",
              "fee1": "70.31",
              "fee2": "0.00",
              "fee3": "0.00",
              "fee4": "0.00",
              "fee5": "0.00",
              "fee6": "0.00",
              "fee7": "0.00",
              "savings": "70.31"
            },
            {
              "paymentNumber": "2",
              "paymentDate": "2025/03/15",
              "totalPayment": "351.56",
              "fee1": "70.31",
              "fee2": "0.00",
              "fee3": "0.00",
              "fee4": "0.00",
              "fee5": "0.00",
              "fee6": "0.00",
              "fee7": "0.00",
              "savings": "70.31"
            }
          ],
          "forthRequestParameters": {
            "epFee1Amount": true,
            "epFee2Monthly": false,
            "epFee3Amount": false,
            "epFee3Monthly": false,
            "epFee4Monthly": false,
            "epFee4Amount": false,
            "epFee5Monthly": false,
            "epFee5Amount": false,
            "firstPaymentDate": "2025/02/15",
            "recurringStartDate": "2025/03/15",
            "epFrequency": "M",
            "epFreqInterval": "15",
            "debt": "13500.00",
            "enrollmentPlan": "plan-standard-48",
            "programMonths": "48",
            "maxPaymentTerm": "60",
            "estSettlement": "6750.00"
          }
        }
      ],
      "errors": [
        {
          "message": "INVALID_FIRST_PAYMENT_DATE"
        },
        {
          "message": "UNDERWRITING_APPLICATION_ERROR"
        },
        {
          "message": "UNDERWRITING_APPLICATION_FAILED_PREQUALIFICATION"
        },
        {
          "message": "ZERO_DEBT_SELECTED"
        },
        {
          "message": "NO_ENROLLMENT_PLAN_AVAILABLE_FOR_STATE"
        },
        {
          "message": "FORTH_INTERMITTENT_ERROR"
        },
        {
          "message": "ERROR_CALCULATING_DEPOSIT_FREQUENCY"
        },
        {
          "message": "ERROR_CALCULATING_DEPOSIT_INTERVALS"
        },
        {
          "message": "ERROR_CALCULATING_MAX_PAYMENT_TERM"
        },
        {
          "message": "MAX_TERM_CALCULATION_ERROR"
        },
        {
          "message": "INTERNAL_SERVER_ERROR"
        }
      ]
    }
  }
}

Arguments

Argument	Type	Description
input	OffersInput!	Input for getting offers depositFrequency values can be BW’ for ‘biWeekly’, ‘SM’ for ‘semiMonthly’, and ‘M’ for ‘monthly’ - Default is ‘M’ depositIntervals values can be If depositFrequency is biWe…

Input Types

OffersInput

Input for getting offers depositFrequency values can be BW’ for ‘biWeekly’, ‘SM’ for ‘semiMonthly’, and ‘M’ for ‘monthly’ - Default is ‘M’

depositIntervals values can be If depositFrequency is biWeekly valid options are ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’, ‘Sunday’ - Default is ‘Monday’. Example ‘Monday’ If depositFrequency is ‘semiMonthly’ then 2 values need to be passed where valid options are the 1-30. Example ‘2,23’ If depositFrequency is ‘monthly’ valid options are the 1-30. Example ‘1’

firstPaymentDate in yyyy/mm/dd format (required)

uwResultId is the Application ID from underwriting (required)

Required Fields:

Field	Type	Description
firstPaymentDate	String!	firstPaymentDate in yyyy/mm/dd format
uwResultId	String!	uwResultId is the Application ID from underwriting

Optional Fields:

Field	Type	Description
revision	Int	uwResultId is the Application ID from underwriting
depositFrequency	String	depositFrequency values can be BW’ for ‘biWeekly’, ‘SM’ for ‘semiMonthly’, and ‘M’ for ‘monthly’ - Default is ‘BW’
depositIntervals	String	depositIntervals values can be If depositFrequency is biWeekly valid options are ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’, ‘Sunday’ - Default is ‘Monday’. Example ‘Monday’…
paymentTerm	String	maxPaymentTerm is the maximum number of months to make the plan
includeSentryFee	Boolean	sentry fee opt-out by setting to false

Response Type

Returns: OffersResponse!

OffersResponse

Field	Type	Description
data	[OfferResult]	TBD
errors	[OffersResponseError]	TBD

OfferResult

Field	Type	Description
compTemplateId	Int	TBD
frequency	String!	TBD
frequencyInterval	String!	TBD
firstPaymentDate	String!	TBD
paymentTerm	String!	TBD
maxPaymentTerm	String!	TBD
enrolledDebt	String!	TBD
enrollmentPlanId	String!	TBD
enrollmentPlanName	String!	TBD
serviceFee	Int	TBD
estimatedSettlementFee	Int!	TBD
totals	OfferTotals!	TBD
payments	[OfferPayment]!	TBD
forthRequestParameters	ForthRequestParameters!	TBD

OfferTotals

Field	Type	Description
fee1	String	TBD
fee2	String	TBD
fee3	String	TBD
fee4	String	TBD
fee5	String	TBD
fee6	String	TBD
fee7	String	TBD
savings	String	TBD
totalPayment	String	TBD

OfferPayment

Field	Type	Description
fee1	String	TBD
fee2	String	TBD
fee3	String	TBD
fee4	String	TBD
fee5	String	TBD
fee6	String	TBD
fee7	String	TBD
paymentDate	String	TBD
paymentNumber	String	TBD
savings	String	TBD
totalPayment	String	TBD

ForthRequestParameters

Field	Type	Description
epFee1Amount	Boolean!	TBD
epFee2Monthly	Boolean!	TBD
epFee3Amount	Boolean!	TBD
epFee3Monthly	Boolean!	TBD
epFee4Monthly	Boolean!	TBD
epFee4Amount	Boolean!	TBD
epFee5Monthly	Boolean!	TBD
epFee5Amount	Boolean!	TBD
firstPaymentDate	String!	TBD
recurringStartDate	String!	TBD
epFrequency	String!	TBD
epFreqInterval	String!	TBD
debt	String!	TBD
enrollmentPlan	String!	TBD
programMonths	String!	TBD
maxPaymentTerm	String!	TBD
estSettlement	String!	TBD

OffersResponseError

Field	Type	Description
message	[String]	TBD

Error Types

The response may include the following error types:

OffersResponseError

Field	Type	Description
message	[String]	TBD

Manual Error Documentation

Add service-specific error codes and their resolutions below.

Common Errors

Error Code	Description	Resolution
VALIDATION_ERROR	Input validation failed	Check required fields and formats
UNAUTHORIZED	Invalid or expired token	Re-authenticate and retry
NOT_FOUND	Resource not found	Verify the ID or reference

Related

• Back to Offer Generation