Capture an Authorization

Capture an authorization when the order is ready to settle. The operator transfers all or part of the escrowed amount to the receiver and fee receiver without collecting from the payer again.

Demo

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

Check and Capture

Read paymentState(paymentInfoHash) before capture. The amount must be nonzero, no greater than capturableAmount, and submitted strictly before authorizationExpiry. The operator supplies an absolute feeAmount in raw token units. The protocol validates it against the per-capture minFeeBps and maxFeeBps stored in PaymentInfo.

TypeScript

export async function captureAuthorization(
  payment: StoredProtocolPayment,
  amount = payment.paymentInfo.maxAmount,
) {
  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);
  const receipt = await publicClient.waitForTransactionReceipt({ hash, confirmations: 2 });
  if (receipt.status !== "success") throw new Error("Payment capture reverted");
  return receipt;
}

Capture decreases capturableAmount and increases refundableAmount by the same gross amount. The receiver gets the gross amount minus fees.

Verify PaymentCaptured(paymentInfoHash, amount, feeAmount, feeReceiver) and the expected receiver transfers before marking the fulfillment increment settled.

At authorizationExpiry, capture is no longer available and the payer can reclaim the remaining balance. Use chain time rather than an application server clock when enforcing the deadline.

Capture a Partial Amount

Settle split shipments or a reduced final total.

Refund a Payment

Return previously captured value to the payer.

Overview

Integrate DeFi

Tokenize Assets

Issue Stablecoins

Accept Payments

Demo

Check and Capture

See Also

Capture a Partial Amount

Refund a Payment

​Demo

​Check and Capture

​See Also

Capture a Partial Amount

Refund a Payment

Demo

Check and Capture

See Also