Create Payment Session

{
  "header": {
    "merchantId": "Aera Merchant ID",
    "idempotency-key": "UUID v7 provided by merchant to uniquely identify the request"
  },
  "body": {
    "merchantInfo": {
      "ui": {  
        "mode": "enum EMBED, optional only if you want to embed Aera´s hosted checkout form in your checkout",
        "origin": "merchant URL"
      },
      "successRedirectUrl": "Redirect URL on successful payment",
      "cancelRedirectUrl": "Redirect URL on payment cancel",
      "errorRedirectUrl": "Redirect URL on payment error",
      "webhookUrl": "Absolute or relative URL (validated against configured domain)"
    },
    "transactionData": {
      "merchantReference": "Merchant provided reference to the payment (e.g. order number)",
      "immediateCapture": "Optional, true if immediate capture requested, default false",
      "forceAuthentication": "Optional, true if explicit authentication is requested",
      "splitShipment": "Optional, true if shipment potentially can be split into multiple shipments",
			"storePaymentInstrument": "Optional, true if storing the payment instrument is mandated",
      "amountDetails": {
        "amount": "Gross amount in minor units",
        "currency": "ISO 4217 alphabetic code (e.g.NOK), must be the same as the merchant currency"
      }
    },
    "paymentInstrumentsProfileData": {
      "merchantShopperId": "Conditional: Merchant provided end-user ID (e.g. loyalty number, phone number)",
      "pspShopperId": "Conditional: UUID assigned by PSP, either merchantShopperId or pspShopperId required",
      "paymentInstrumentReference": "Optional: Reference to a pre selected payment instrument",
      "allowStoredInstrumentsOnly": "Optional: Only present stored payment instruments as payment option - Default false"
    },
    "paymentMethodInfo": {
      "paymentMethodWhitelist": [
        "Optional: List of payment methods allowed for this transaction"
      ],
      "paymentMethodDetails": [
        {
          "CARD": {
            "cardSchemeWhitelist": [
              "Optional: List of allowed card schemes in case you want to limit the list"
            ]
          }
        },
        {
          "INVOICE": {
            "invoiceItems": [
              {
                "itemId": "invoiceItems: Applicable for Walley B2C and B2B invoice payments. itemId: The Product ID of the item",
                "description": "Product description",
                "quantity": 1,
                "quantityUnit": "Optional: Default pc",
                "itemPrice": "Unit price incl. VAT",
                "taxPercentage": "VAT percentage",
                "itemPriceExclTax": "Optional: Unit price excl. VAT",
                "taxAmount": "Optional: Tax amount",
                "itemUrl": "Optional: Product URL",
                "imageUrl": "Optional: Product image URL"
              }
            ],
            "B2C": {},
            "B2B": {
              "buyer": "Buyer information",
              "costCenter": "Optional cost center reference"
            }
          }
        },
        {
          "MERCHANTWALLET": [ 
            {
              "walletId": "MERCHANTWALLET object: Applicable to merchant specific wallet based on Aera´s white label wallet. walletId: Unique ID provided by Wallet Service Provider",
              "dpaId": "Optional: If omitted, all DPAs for given wspId are available",
              "claimedUserIds": [
                {
                  "cuid": "Claimed User ID",
                  "cuidType": "LOYALTY | SDKID | DYNAMIC_SDKID | MOBILE"
                }
              ]
            }
          ]
        },
        {
          "VIPPS": {
            "mobileNo": "VIPPS object: Optional. mobileNo: Optional Conditional Only when pushing payment request directly to user's mobile for confirmation. Vipps only allows it for limited use cases where redirection is not feasible. For example, when it is not possible to show the landing page, when the payment is initiated on a device that the user does not own or control. This includes: Not on the users phone, Not on the users computer, On a device that has no user-facing display where the landing page can be shown, such as physical points of sale (POS) solutions, vending machines, etc."
          }
        }
      ]
    }
  }
}

{
  "responseInfo": {
    "responseCode": "000",
    "responseText": "Approved"
  },
  "sessionInfo": {
    "pspReference": "018f7a2e-8f5c-7a9b-b123-123456789abc",
    "createdAt": "2026-03-01T10:15:30Z",
    "expiredAt": "2026-03-01T10:30:30Z",
    "checkoutUrl": "https://checkout.aera.com/session/abc123"
  }
}