API Reference
Start typing to search…

Increment Types for Offer Grid

This enumeration determines how offer values are rounded and spaced when generating funding options. It is represented by the field regularIncrementTypeForOfferGrid in the YL.Web.Api.ThirdParty.PreApproval.Models.PreApprovalRequestModel.

ValueDescription
LoanAmountKeeps the funded amounts consistent and evenly spaced (e.g., £1,000 → £1,100 → £1,200), while allowing the sweep percentages to vary slightly (e.g., 10%, 10.2%, 10.3%).
SweepKeeps the sweep percentages consistent and evenly spaced (e.g., 10%, 10.5%, 11%), while allowing the funded amounts to vary (e.g., £1,000 → £1,070 → £1,150)

Example A - regularIncrementTypeForOfferGrid = LoanAmount

{
  "merchantIsEligibleForPreApproval": true,
  "loanType": "CashAdvance",
  "preApprovedOffersModel": {
    "thirdPartyCustomerId": "ACME-123",
    "preApprovalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "interval": 100,
    "regularIncrementTypeForOfferGrid": "LoanAmount",
    "offers": [
      {
        "offerId": "11111111-1111-1111-1111-111111111111",
        "fundedAmount": 1000,
        "originalAmount": 1150,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 10.0,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      },
      {
        "offerId": "22222222-2222-2222-2222-222222222222",
        "fundedAmount": 1100,
        "originalAmount": 1265,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 10.2,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      },
      {
        "offerId": "33333333-3333-3333-3333-333333333333",
        "fundedAmount": 1200,
        "originalAmount": 1380,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 10.3,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      }
    ]
  }
}

Example B - regularIncrementTypeForOfferGrid = Sweep

{
  "merchantIsEligibleForPreApproval": true,
  "loanType": "CashAdvance",
  "preApprovedOffersModel": {
    "thirdPartyCustomerId": "ACME-123",
    "preApprovalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "interval": 0.5,
    "regularIncrementTypeForOfferGrid": "Sweep",
    "offers": [
      {
        "offerId": "44444444-4444-4444-4444-444444444444",
        "fundedAmount": 1000,
        "originalAmount": 1150,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 10.0,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      },
      {
        "offerId": "55555555-5555-5555-5555-555555555555",
        "fundedAmount": 1070,
        "originalAmount": 1231,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 10.5,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      },
      {
        "offerId": "66666666-6666-6666-6666-666666666666",
        "fundedAmount": 1150,
        "originalAmount": 1323,
        "currencyISOCode": "GBP",
        "factorRate": 1.15,
        "sweep": 11.0,
        "daysUntilRepayment": 120,
        "daysUntilMaturity": 180,
        "expirationDate": "2025-12-10T00:00:00Z"
      }
    ]
  }
}