Capture a Partial Amount

Capture less than the authorized amount when the final total changes after checkout, or capture multiple increments as an order ships. Commerce Payments Protocol tracks the remaining reservation onchain without a custom checkout contract.

Demo

The demo above is mock only. If you want to see onchain demos on Vibenet, head to Base chain demos.

Capture the Final Amount

Call the same capture function for every increment. The sum of successful captures cannot exceed PaymentAuthorized.amount, and each capture independently validates its fee bounds.

TypeScript

export async function capturePartialPayment(
  payment: StoredProtocolPayment,
  actualAmount: string,
) {
  const amount = parseUnits(actualAmount, 6);
  const [, capturableAmount] = await publicClient.readContract({
    address: AUTH_CAPTURE_ESCROW,
    abi: authCaptureEscrowAbi,
    functionName: "paymentState",
    args: [payment.paymentInfoHash],
  });
  if (amount > capturableAmount) throw new Error("Capture exceeds authorized amount");
  const simulation = await publicClient.simulateContract({
    account,
    address: AUTH_CAPTURE_ESCROW,
    abi: authCaptureEscrowAbi,
    functionName: "capture",
    args: [payment.paymentInfo, amount, 0n, zeroAddress],
  });
  const hash = await walletClient.writeContract(simulation.request);
  return publicClient.waitForTransactionReceipt({ hash, confirmations: 2 });
}

For a 100 USDC authorization, a 64 USDC capture leaves 36 USDC capturable and makes 64 USDC refundable. You can capture another increment or void the remainder.

After every capture, reconcile PaymentCaptured.amount with the new capturableAmount and refundableAmount before another worker advances the order.

Fee bounds are evaluated per capture and use integer division. With low-decimal tokens, fragmenting one settlement into many small captures can reduce the aggregate minimum fee. Enforce a minimum capture size offchain when that matters.

Capture an Authorization

Review the capture deadline, fee, and state transition.

Void an Authorization

Return the unneeded remainder to the payer.

Overview

Integrate DeFi

Tokenize Assets

Issue Stablecoins

Accept Payments

Demo

Capture the Final Amount

See Also

Capture an Authorization

Void an Authorization

​Demo

​Capture the Final Amount

​See Also

Capture an Authorization

Void an Authorization

Demo

Capture the Final Amount

See Also