Authorization adjustment

Authorization adjustment lets you modify the amount of a held (uncaptured) authorization before settling. Common use cases:

• Hotel check-in pre-auth: hold $200 at check-in, adjust to the actual stay cost at checkout
• Fuel pumps: pre-auth a fixed amount, adjust down to the actual fuel dispensed
• Restaurant tabs: hold an amount when the tab is opened, adjust up when the customer adds more items

PrerequisitesAskCopy

• captureMethod: "manual" on the initial payment create call (adjustment requires a manual-capture authorization)
• Enterprise adjustment feature enabled on your account
• Adjustment window: Visa and Mastercard allow up to 7 days from the original authorization; American Express allows 30 days (subject to your acquirer agreement)

Create an adjustable authorizationAskCopy

const terminalPayment = await vinr.terminal.payments.create({
  terminalId: 'term_01HZ5QXYZ',
  amount: 20000,     // $200.00 pre-auth hold
  currency: 'USD',
  reference: 'room_412_checkin',
  captureMethod: 'manual',
  authorizationAdjustment: {
    enabled: true,
  },
});

// terminalPayment.status → 'authorized'
// terminalPayment.captureMethod → 'manual'

Adjust the authorizationAskCopy

At any point before capture, call adjustAuthorization to change the held amount:

// Day 3 — customer adds room service and minibar charges
await vinr.terminal.payments.adjustAuthorization(terminalPayment.id, {
  amount: 34700,  // $347.00 adjusted hold
  reason: 'Additional charges added to room folio',
});

You can adjust up or down. Adjusting up sends a new authorization request to the issuer. Adjusting down reduces the hold without a new authorization (the issuer releases the excess hold automatically).

Adjustment limits:

Adjustments beyond scheme limits require a new authorization rather than an adjustment.

Capture at the adjusted amountAskCopy

When ready to settle, call capture. The capture amount must be ≤ the adjusted authorized amount:

await vinr.terminal.payments.capture(terminalPayment.id, {
  amount: 34700,  // capture the full adjusted amount
});

Webhook eventsAskCopy

if (event.type === 'terminal_payment.authorization_adjusted') {
  const tp = event.data.object;
  console.log(tp.amount);           // new adjusted amount
  console.log(tp.originalAmount);   // original hold
  console.log(tp.adjustedAt);       // timestamp
}