Update an authorisation

Keep a reservation valid for longer, or change the reserved amount.

🚧

Early release

Online payments is in early development (MVP). This section may change.

Use Update payment on an authorised payment to:

  • Extend the reservation period (how long the authorisation stays valid), and or
  • Change the remaining authorised amount, up or down

Update works for payment methods that support reservation management, such as cards and some alternative payment methods, for example Vipps and merchant wallets. What works depends on the acquirer, the payment method and the payment's state.

When to update

  • The payment is authorised.
  • You need the authorisation to stay valid longer, for example because shipping is delayed.
  • You need to reserve more or less than today.

If the payment is already captured or fully cancelled, you can't update it.

Extend the reservation period

Send the request without a body.

POST /v1/{pspReference}/update

Whether the extension is approved depends on the payment method, the card scheme rules, the acquirer's setup and the payment's state. If it is approved, the scheme and acquirer decide the new period.

Change the authorised amount

Send amountDetails with the new total remaining authorised amount. It can be higher or lower than today.

Example update request
{
  "amountDetails": { "amount": 15000, "currency": "NOK" },
  "reference": "Delayed shipment, updated total"
}
FieldDescription
amountDetailsThe new total remaining authorised amount, in minor units. Leave out to only extend the reservation.
referenceYour own text, for example the reason. Optional.

Good to know

  • You can update only while the payment is authorised.
  • Extensions aren't guaranteed and can be declined.
  • A higher amount can trigger extra risk checks or authentication.
  • Some payment methods don't support higher amounts.
  • Some payment methods don't support updates after the first partial capture.
  • Every update needs a new idempotency-key.

Did this page help you?