Authorize Recurring Payment

🚧

Early release: preliminary docs and specs

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

This endpoint initiates an authorization without shopper interaction for merchant initiated transactions (MIT). It requires a recurringReference from a prior Create Recurring Payment Session. No payment page is rendered as the shopper normally is not present.

The endpoint starts an online transaction that:

  • Registers the payment with Aera
  • Defines the transaction amount and configuration
  • All subsequent operations — such as capture, cancel, refund, update, and status retrieval — reference the pspReference generated by this request.

Important note: It is the responsibility of the merchant to only initiate payments which are agreed with the shopper in the terms and conditions. When the payment is merchant-initiated (MIT), the shopper may request a chargeback and the merchant would be liable in a dispute situation.


Request Structure

{
  "header": {
    "merchantId": "Aera Merchant ID",
    "idempotency-key": "UUID v7 provided by merchant to uniquely identify the request"
  },
  "body": {    
    "transactionData": {
      "merchantReference": "Merchant provided reference to the payment (e.g. order number)",
      "recurringReference": "Mandatory: Reference to the initial standing instruction for a recurring  payment",
      "immediateCapture": "Optional, true if immediate capture requested, default false",
      "splitShipment": "Optional, true if shipment potentially can be split into multiple shipments",
      "amountDetails": {
        "amount": "Gross amount in minor units",
        "currency": "ISO 4217 alphabetic code (e.g.NOK), must be the same as the merchant currency"        }
    }
  }
}

Response Structure

The response contains session metadata and checkout information.

{
  "responseInfo": {
    "responseCode": "000",
    "responseText": "Approved"
  },
  "sessionInfo": {
    "pspReference": "018f7a2e-8f5c-7a9b-b123-123456789abc",
    "createdAt": "2026-03-01T10:15:30Z",
    "expiredAt": "2026-03-01T10:30:30Z",
  }
}

Field reference: Authorize Recurring Payment

HTTP Headers

🔒

Keep your x-api-key and Authorization token secret. Store them in environment variables or a secrets manager — never hard-code credentials in source files, client-side code, public repositories, or browser requests. Rotate compromised keys immediately through the Aera dashboard.

FieldTypeRequiredDefaultDescription
x-api-keystringYes–API key assigned by Aera.
merchant-idstringYes–Merchant ID assigned by Aera.
idempotency-keystring (UUID v7)Yes–Unique key identifying this request. Safe retries must reuse the same key.
AuthorizationstringYes–Bearer <access token>
AcceptstringYesapplication/vnd.payments.v1+jsonAPI versioned accept header.
Content-TypestringYesapplication/vnd.payments.v1+jsonAPI versioned content type.

Request body

transactionData object

FieldTypeRequiredDefaultDescription
merchantReferencestringYes–Merchant reference (for example, order number).
recurringReferencestringYes-The reference from the initial standing instruction for the recurring payments.
immediateCapturebooleanNofalseIf true, authorizes and captures immediately. If false, authorizes first and requires capture later (if applicable).
splitShipmentbooleanNofalseSet totrueif shipment potentially can be split into multiple shipments.
amountDetailsobjectYes–Amount object (minor units).
transactionData.amountDetails
FieldTypeRequiredDefaultDescription
amountintegerYes–Gross amount in minor units (for example, 19900 = NOK 199.00).
currencystring (ISO 4217)Yes–Currency code (for example, NOK), must be the same as the merchant currency.


Field reference: response

High-level processing result information.

FieldTypeRequiredDescription
responseCodestring (3 digits)YesResponse code from a predefined list.
responseTextstringYesHuman-readable description of the response code.

sessionInfo

Authorize Payment metadata.

FieldTypeRequiredDescription
pspReferencestring (UUID v7)YesUnique session identifier generated by Aera. Use this reference for all subsequent operations (capture, cancel, refund, status).
createdAtstring (ISO 8601)YesTimestamp when the session was created (UTC).
expiredAtstring (ISO 8601)YesTimestamp when the session expires (UTC).



What’s Next

Did this page help you?