Deposit + balance-due split API

Splits an order total into an upfront deposit (percent or fixed) and the remaining balance, with optional due-day offsets and a non-refundable flag for cancellation math. Answers 'What deposit and balance for a 25% deposit?', 'What is refundable if cancelled?'.

Price$0.01per request

MethodPOST

Route/v1/commerce/deposit-balance

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

commercedepositbalance-duebookinginvoicedown-paymentsplitpayment

API URLhttps://x402.hexl.dev/v1/commerce/deposit-balance

Integration docs

Example request

{
  "total": 500,
  "depositPct": 25,
  "depositDueDay": 0,
  "balanceDueDay": 30
}

Example response

{
  "total": 500,
  "deposit": 125,
  "depositPctOfTotal": 25,
  "balanceDue": 375,
  "depositDueDay": 0,
  "balanceDueDay": 30,
  "depositNonRefundable": false,
  "refundIfCancelledAfterDeposit": 125,
  "interpretation": "Deposit $125 (25%) due day 0; balance $375 due day 30."
}

Input schema

{
  "type": "object",
  "required": [
    "total"
  ],
  "properties": {
    "total": {
      "type": "number",
      "examples": [
        500
      ]
    },
    "depositPct": {
      "type": "number",
      "examples": [
        25
      ]
    },
    "depositDueDay": {
      "type": "integer",
      "examples": [
        0
      ]
    },
    "balanceDueDay": {
      "type": "integer",
      "examples": [
        30
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}