Skip to content
API Documentation

Introduction

The Offer Generation API generates viable payment plans using debts from the Lead Eligibility API. This is Phase 3 of the DebtCore API workflow, occurring after eligibility checks.

The service is built around GraphQL - all calls are simply POST requests to the service endpoint.

Prerequisites

Before calling the Offer Generation API, you must have:

  1. A completed Lead Eligibility API application
  2. The uwResultId and revision from the Lead Eligibility API

How It Works

Plan Comparison

Use getOffers (the offers mutation) to calculate various payment options based on:

  • Deposit Frequency - How often payments are made (e.g., Monthly)
  • Deposit Intervals - Payment schedule intervals
  • Payment Term - Length of the program in months

Treat this as a calculator to generate multiple payment plans for the customer to compare.

Offer Commitment

Once the customer selects a payment plan, use createOffer to commit the selection. This saves the payment plan and generates an offerId.

API Operations

OperationDescription
offersCalculate payment plan options (calculator mode)
createOfferSave the selected plan and generate an offerId
getOfferGet a saved offer using the offerId

Key Features

  • Flexible payment term and frequency configuration
  • Service fee and settlement fee calculations
  • Detailed payment schedule generation
  • Sentry fee support (optional)

Response Data

The service returns comprehensive offer details including:

  • Payment schedules with individual payment breakdowns
  • Fee structures (fee1-7 components)
  • Total savings calculations

Next Steps