Update Payment

Use this endpoint to update an existing authorization.

Update allows you to:

  • Extend the reservation period (authorization validity), and/or
  • Adjust the remaining authorized amount

Update is supported for payment methods that allow reservation management (for example, Card and selected alternative payment methods such as Vipps or Merchant Wallet). Availability and behavior depend on the configured acquirer, card scheme, and payment state.

Update behavior is aligned with product guidelines and the capabilities of the underlying acquirer and scheme.


When to Use Update

Use Update when:

  • A payment is in an authorized state
  • You need to extend the authorization validity period
  • You need to increase or decrease the remaining reserved amount

If the payment has already been captured or fully cancelled, update is not possible.


Endpoint

POST /v1/{pspReference}/update
  • {pspReference} is the unique identifier returned when the payment session was created.
  • The idempotency-key header is mandatory.

Extend Reservation Period

To request an extension of the authorization validity period, send the request without a body.

Example

POST /v1/{pspReference}/update

If no body is provided, the system will request an extension of the reservation period.

Approval depends on:

  • Payment method
  • Card scheme rules
  • Acquirer configuration
  • Current payment state

If approved, the new reservation duration is determined by the scheme and acquirer.


Update Authorized Amount

To update the total remaining authorized amount, include an amountDetails object in the request body.

The new total remaining reserved amount may be higher or lower than the current remaining reservation amount.

Example

{
  "amountDetails": {
    "amount": 15000,
    "currency": "NOK"
  },
  "reference": "Delayed shipment – updated total"
}

Field Reference

Path Parameter

FieldTypeRequiredDescription
pspReferencestring (UUID v7)YesUnique payment identifier returned during session creation.

Request Headers

FieldTypeRequiredDescription
x-api-keystringYesAPI key assigned by Aera.
merchant-idstringYesMerchant ID assigned by Aera.
idempotency-keystring (UUID v7)YesUnique identifier for this update request. Required for safe retries.
AuthorizationstringYesBearer <access token>
AcceptstringYesapplication/vnd.payments.v1+json
Content-TypestringYesapplication/vnd.payments.v1+json
🔒

Never hardcode sensitive credentials such as your x-api-key or Authorization token in source code. Store them in environment variables or a secrets manager.


Request Body

FieldTypeRequiredDescription
amountDetailsobjectNoRequired when updating the authorized amount. If omitted, only a reservation extension is requested.
referencestringNoOptional free-text reference for reconciliation or audit purposes (e.g., reason for update).

amountDetails

FieldTypeRequiredDescription
amountintegerYes (when updating amount)New total remaining authorized amount in minor units.
currencystring (ISO 4217)Yes (when updating amount)Currency code (for example, NOK).

Update Response

A successful update returns confirmation of the operation and updated payment status.

{
  "responseInfo": {
    "responseCode": "000",
    "responseText": "Update successful"
  },
  "operationInfo": {
    "type": "UPDATE",
    "status": "SUCCESS",
    "updatedAmount": {
      "amount": 15000,
      "currency": "NOK"
    }
  }
}

Important Notes

  • Update is only possible while the payment is in an authorized state.
  • Extension approval depends on scheme and acquirer rules.
  • Increasing the authorized amount may trigger additional risk checks or authentication.
  • Some payment methods may not support amount increases.
  • Update requests must include a valid idempotency-key.
  • Authorization extensions are not guaranteed and may be declined.

What’s Next

Did this page help you?